Ui3nButton

Button component with various styles and capabilities.

Props

Name	Type	Default	Description
id	string | undefined	—	Root element id
type	"primary" | "icon" | "secondary" | "tertiary" | "outline" | "custom" | undefined	"primary"	Button type
size	"regular" | "small" | "large" | undefined	"regular"	Button size
square	boolean | undefined	—	The unrounded button
block	boolean | undefined	—	Whether to stretch the button to the full width of the parent block
textColor	string | undefined	—	Button text color
color	string | undefined	—	Button background color
elevation	boolean | undefined	—	Add a raised effect to the button
icon	string | undefined	—	The icon displayed on the button
iconSize	string | number | undefined	—	Button icon size
iconColor	string | undefined	—	Button icon color
iconPosition	"right" | "left" | undefined	"right"	Button icon position
disabled	boolean | undefined	false	Put component in disabled mode
name	string | undefined	—	No description provided
placeholder	string | undefined	—	No description provided
value	string | number | readonly string[] | undefined	—	No description provided
onCopy	((payload: ClipboardEvent) => void) | undefined	—	No description provided
onCut	((payload: ClipboardEvent) => void) | undefined	—	No description provided
onPaste	((payload: ClipboardEvent) => void) | undefined	—	No description provided
onCompositionend	((payload: CompositionEvent) => void) | undefined	—	No description provided
onCompositionstart	((payload: CompositionEvent) => void) | undefined	—	No description provided
onCompositionupdate	((payload: CompositionEvent) => void) | undefined	—	No description provided
onDrag	((payload: DragEvent) => void) | undefined	—	No description provided
onDragend	((payload: DragEvent) => void) | undefined	—	No description provided
onDragenter	((payload: DragEvent) => void) | undefined	—	No description provided
onDragexit	((payload: DragEvent) => void) | undefined	—	No description provided
onDragleave	((payload: DragEvent) => void) | undefined	—	No description provided
onDragover	((payload: DragEvent) => void) | undefined	—	No description provided
onDragstart	((payload: DragEvent) => void) | undefined	—	No description provided
onDrop	((payload: DragEvent) => void) | undefined	—	No description provided
onFocusin	((payload: FocusEvent) => void) | undefined	—	No description provided
onFocusout	((payload: FocusEvent) => void) | undefined	—	No description provided
onChange	((payload: Event) => void) | undefined	—	No description provided
onBeforeinput	((payload: InputEvent) => void) | undefined	—	No description provided
onFormdata	((payload: FormDataEvent) => void) | undefined	—	No description provided
onInput	((payload: InputEvent) => void) | undefined	—	No description provided
onReset	((payload: Event) => void) | undefined	—	No description provided
onSubmit	((payload: SubmitEvent) => void) | undefined	—	No description provided
onInvalid	((payload: Event) => void) | undefined	—	No description provided
onFullscreenchange	((payload: Event) => void) | undefined	—	No description provided
onFullscreenerror	((payload: Event) => void) | undefined	—	No description provided
onLoad	((payload: Event) => void) | undefined	—	No description provided
onError	((payload: Event) => void) | undefined	—	No description provided
onKeydown	((payload: KeyboardEvent) => void) | undefined	—	No description provided
onKeypress	((payload: KeyboardEvent) => void) | undefined	—	No description provided
onKeyup	((payload: KeyboardEvent) => void) | undefined	—	No description provided
onDblclick	((payload: MouseEvent) => void) | undefined	—	No description provided
onMousedown	((payload: MouseEvent) => void) | undefined	—	No description provided
onMouseenter	((payload: MouseEvent) => void) | undefined	—	No description provided
onMouseleave	((payload: MouseEvent) => void) | undefined	—	No description provided
onMousemove	((payload: MouseEvent) => void) | undefined	—	No description provided
onMouseout	((payload: MouseEvent) => void) | undefined	—	No description provided
onMouseover	((payload: MouseEvent) => void) | undefined	—	No description provided
onMouseup	((payload: MouseEvent) => void) | undefined	—	No description provided
onAbort	((payload: UIEvent) => void) | undefined	—	No description provided
onCanplay	((payload: Event) => void) | undefined	—	No description provided
onCanplaythrough	((payload: Event) => void) | undefined	—	No description provided
onDurationchange	((payload: Event) => void) | undefined	—	No description provided
onEmptied	((payload: Event) => void) | undefined	—	No description provided
onEncrypted	((payload: MediaEncryptedEvent) => void) | undefined	—	No description provided
onEnded	((payload: Event) => void) | undefined	—	No description provided
onLoadeddata	((payload: Event) => void) | undefined	—	No description provided
onLoadedmetadata	((payload: Event) => void) | undefined	—	No description provided
onLoadstart	((payload: Event) => void) | undefined	—	No description provided
onPause	((payload: Event) => void) | undefined	—	No description provided
onPlay	((payload: Event) => void) | undefined	—	No description provided
onPlaying	((payload: Event) => void) | undefined	—	No description provided
onProgress	((payload: ProgressEvent<EventTarget>) => void) | undefined	—	No description provided
onRatechange	((payload: Event) => void) | undefined	—	No description provided
onSeeked	((payload: Event) => void) | undefined	—	No description provided
onSeeking	((payload: Event) => void) | undefined	—	No description provided
onStalled	((payload: Event) => void) | undefined	—	No description provided
onSuspend	((payload: Event) => void) | undefined	—	No description provided
onTimeupdate	((payload: Event) => void) | undefined	—	No description provided
onVolumechange	((payload: Event) => void) | undefined	—	No description provided
onWaiting	((payload: Event) => void) | undefined	—	No description provided
onSelect	((payload: Event) => void) | undefined	—	No description provided
onScroll	((payload: Event) => void) | undefined	—	No description provided
onScrollend	((payload: Event) => void) | undefined	—	No description provided
onTouchcancel	((payload: TouchEvent) => void) | undefined	—	No description provided
onTouchend	((payload: TouchEvent) => void) | undefined	—	No description provided
onTouchmove	((payload: TouchEvent) => void) | undefined	—	No description provided
onTouchstart	((payload: TouchEvent) => void) | undefined	—	No description provided
onAuxclick	((payload: PointerEvent) => void) | undefined	—	No description provided
onContextmenu	((payload: PointerEvent) => void) | undefined	—	No description provided
onGotpointercapture	((payload: PointerEvent) => void) | undefined	—	No description provided
onLostpointercapture	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointerdown	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointermove	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointerup	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointercancel	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointerenter	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointerleave	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointerover	((payload: PointerEvent) => void) | undefined	—	No description provided
onPointerout	((payload: PointerEvent) => void) | undefined	—	No description provided
onBeforetoggle	((payload: ToggleEvent) => void) | undefined	—	No description provided
onToggle	((payload: ToggleEvent) => void) | undefined	—	No description provided
onWheel	((payload: WheelEvent) => void) | undefined	—	No description provided
onAnimationcancel	((payload: AnimationEvent) => void) | undefined	—	No description provided
onAnimationstart	((payload: AnimationEvent) => void) | undefined	—	No description provided
onAnimationend	((payload: AnimationEvent) => void) | undefined	—	No description provided
onAnimationiteration	((payload: AnimationEvent) => void) | undefined	—	No description provided
onSecuritypolicyviolation	((payload: SecurityPolicyViolationEvent) => void) | undefined	—	No description provided
onTransitioncancel	((payload: TransitionEvent) => void) | undefined	—	No description provided
onTransitionend	((payload: TransitionEvent) => void) | undefined	—	No description provided
onTransitionrun	((payload: TransitionEvent) => void) | undefined	—	No description provided
onTransitionstart	((payload: TransitionEvent) => void) | undefined	—	No description provided
autofocus	Booleanish | undefined	—	No description provided
form	string | undefined	—	No description provided
formaction	string | undefined	—	No description provided
formenctype	string | undefined	—	No description provided
formmethod	string | undefined	—	No description provided
formnovalidate	Booleanish | undefined	—	No description provided
formtarget	string | undefined	—	No description provided
data-ui3n	string | undefined	—	No description provided
innerHTML	string | undefined	—	No description provided
accesskey	string | undefined	—	No description provided
contenteditable	Booleanish | "inherit" | "plaintext-only" | undefined	—	No description provided
contextmenu	string | undefined	—	No description provided
dir	string | undefined	—	No description provided
draggable	Booleanish | undefined	—	No description provided
enterkeyhint	"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefined	—	No description provided
enterKeyHint	"done" | "enter" | "go" | "next" | "previous" | "search" | "send" | undefined	—	No description provided
hidden	"" | "hidden" | Booleanish | "until-found" | undefined	—	No description provided
inert	Booleanish | undefined	—	No description provided
lang	string | undefined	—	No description provided
spellcheck	Booleanish | undefined	—	No description provided
tabindex	Numberish | undefined	—	No description provided
title	string | undefined	—	No description provided
translate	"yes" | "no" | undefined	—	No description provided
radiogroup	string | undefined	—	No description provided
role	string | undefined	—	No description provided
about	string | undefined	—	No description provided
datatype	string | undefined	—	No description provided
inlist	any	—	No description provided
prefix	string | undefined	—	No description provided
property	string | undefined	—	No description provided
resource	string | undefined	—	No description provided
typeof	string | undefined	—	No description provided
vocab	string | undefined	—	No description provided
autocapitalize	string | undefined	—	No description provided
autocorrect	string | undefined	—	No description provided
autosave	string | undefined	—	No description provided
itemprop	string | undefined	—	No description provided
itemscope	Booleanish | undefined	—	No description provided
itemtype	string | undefined	—	No description provided
itemid	string | undefined	—	No description provided
itemref	string | undefined	—	No description provided
results	Numberish | undefined	—	No description provided
security	string | undefined	—	No description provided
unselectable	"on" | "off" | undefined	—	No description provided
inputmode	"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined	—	Hints at the type of data that might be entered by the user while editing the element or its contents
is	string | undefined	—	Specify that a standard HTML element should behave like a defined custom built-in element
exportparts	string | undefined	—	No description provided
part	string | undefined	—	No description provided
aria-activedescendant	string | undefined	—	Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic	Booleanish | undefined	—	Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete	"none" | "inline" | "list" | "both" | undefined	—	Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-busy	Booleanish | undefined	—	Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
aria-checked	Booleanish | "mixed" | undefined	—	Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcount	Numberish | undefined	—	Defines the total number of columns in a table, grid, or treegrid.
aria-colindex	Numberish | undefined	—	Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colspan	Numberish | undefined	—	Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controls	string | undefined	—	Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-current	Booleanish | "page" | "step" | "location" | "date" | "time" | undefined	—	Indicates the element that represents the current item within a container or set of related elements.
aria-describedby	string | undefined	—	Identifies the element (or elements) that describes the object.
aria-details	string | undefined	—	Identifies the element that provides a detailed, extended description for the object.
aria-disabled	Booleanish | undefined	—	Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect	"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined	—	Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessage	string | undefined	—	Identifies the element that provides an error message for the object.
aria-expanded	Booleanish | undefined	—	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto	string | undefined	—	Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbed	Booleanish | undefined	—	Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopup	Booleanish | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined	—	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden	Booleanish | undefined	—	Indicates whether the element is exposed to an accessibility API.
aria-invalid	Booleanish | "grammar" | "spelling" | undefined	—	Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcuts	string | undefined	—	Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-label	string | undefined	—	Defines a string value that labels the current element.
aria-labelledby	string | undefined	—	Identifies the element (or elements) that labels the current element.
aria-level	Numberish | undefined	—	Defines the hierarchical level of an element within a structure.
aria-live	"off" | "assertive" | "polite" | undefined	—	Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modal	Booleanish | undefined	—	Indicates whether an element is modal when displayed.
aria-multiline	Booleanish | undefined	—	Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable	Booleanish | undefined	—	Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation	"horizontal" | "vertical" | undefined	—	Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-owns	string | undefined	—	Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholder	string | undefined	—	Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinset	Numberish | undefined	—	Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressed	Booleanish | "mixed" | undefined	—	Indicates the current "pressed" state of toggle buttons.
aria-readonly	Booleanish | undefined	—	Indicates that the element is not editable, but is otherwise operable.
aria-relevant	"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined	—	Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-required	Booleanish | undefined	—	Indicates that user input is required on the element before a form may be submitted.
aria-roledescription	string | undefined	—	Defines a human-readable, author-localized description for the role of an element.
aria-rowcount	Numberish | undefined	—	Defines the total number of rows in a table, grid, or treegrid.
aria-rowindex	Numberish | undefined	—	Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowspan	Numberish | undefined	—	Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selected	Booleanish | undefined	—	Indicates the current "selected" state of various widgets.
aria-setsize	Numberish | undefined	—	Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort	"none" | "ascending" | "descending" | "other" | undefined	—	Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax	Numberish | undefined	—	Defines the maximum allowed value for a range widget.
aria-valuemin	Numberish | undefined	—	Defines the minimum allowed value for a range widget.
aria-valuenow	Numberish | undefined	—	Defines the current value for a range widget.
aria-valuetext	string | undefined	—	Defines the human readable text alternative of aria-valuenow for a range widget.

Events

Event Name	Arguments / Value Type	Description
click	value: Event	—
enter	value: HTMLButtonElement	—
init	value: HTMLButtonElement	—
focus	value: Event	—
blur	value: Event	—

Slots

Slot Name	Scope Props (v-slot)	Description
#default	—	Default slot

CSS Variables

Set any of these where you need it — on :root, on a container, or on the element itself through [data-ui3n] — and the component follows. Leave them alone and it uses the defaults below.

Name	Default
--ui3n-button-bg-color	var(--color-bg-button-primary-default)
--ui3n-button-bg-color-disabled	var(--color-bg-button-primary-disabled)
--ui3n-button-bg-color-hover	var(--color-bg-button-primary-hover)
--ui3n-button-bg-color-pressed	var(--color-bg-button-primary-pressed)
--ui3n-button-border-radius	calc(var(--_button-height) / 2)
--ui3n-button-font-size	12px
--ui3n-button-font-size-large	var(--ui3n-button-font-size, 15px)
--ui3n-button-font-size-regular	var(--ui3n-button-font-size, 12px)
--ui3n-button-font-size-small	var(--ui3n-button-font-size, 12px)
--ui3n-button-gap	4px
--ui3n-button-height	32px
--ui3n-button-height-large	var(--ui3n-button-height, 48px)
--ui3n-button-height-regular	var(--ui3n-button-height, 32px)
--ui3n-button-height-small	var(--ui3n-button-height, 24px)
--ui3n-button-icon-size-large	48px
--ui3n-button-icon-size-regular	32px
--ui3n-button-icon-size-small	24px
--ui3n-button-outline-color	transparent
--ui3n-button-outline-color-focused	var(--_button-text-color)
--ui3n-button-outline-color-hover	var(--_button-text-color)
--ui3n-button-outline-color-pressed	var(--_button-text-color)
--ui3n-button-padding	0 16px
--ui3n-button-padding-large	var(--ui3n-button-padding, 0 16px)
--ui3n-button-padding-regular	var(--ui3n-button-padding, 0 16px)
--ui3n-button-padding-small	var(--ui3n-button-padding, 0 8px)
--ui3n-button-padding-when-icon	8px
--ui3n-button-shadow-far-color	var(--shadow-key-2)
--ui3n-button-shadow-inset-color	var(--shadow-key-3)
--ui3n-button-shadow-near-color	var(--shadow-key-1)
--ui3n-button-text-color	var(--color-text-button-primary-default)
--ui3n-button-text-color-disabled	var(--color-text-button-primary-disabled)
--ui3n-button-text-color-focused	var(--color-text-button-primary-default)
--ui3n-button-text-color-hover	var(--color-text-button-primary-hover)
--ui3n-button-text-color-pressed	var(--color-text-button-primary-pressed)

Usage Examples

Simple button

Simple button

Simple button usage

Button types

Button types

Different button types: primary, secondary, tertiary, outline, icon, custom

Button sizes

Button sizes

Regular, small and large button sizes

Buttons with icons

Buttons with icons

Buttons with icons on the left or right side

Button states

Button states

Disabled, block and elevated buttons

Square buttons

Square buttons

Buttons with square corners using the square prop

Icon customization

Icon customization

Custom icon size and color using iconSize and iconColor props

Events

Events

Button events: init, click, enter, focus, blur

Event log (last 5):

No events yet