Button
The props declared for Button, generated from the types @proyecto-viviana/ui ships.
Import
import { Button } from "@proyecto-viviana/ui";Props
Differs from @proyecto-viviana/solid-spectrum
variantadds 'warning', 'success', 'create', 'terminal'; does not have 'premium', 'genai'.
| Prop | Type | Default | Description |
|---|---|---|---|
children | number | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement | — | The content to display in the Button. |
variant | 'primary' | 'secondary' | 'accent' | 'negative' | 'warning' | 'success' | 'create' | 'terminal' | — | The visual style of the Button. |
fillStyle | 'fill' | 'outline' | — | The background style of the Button. |
size | 'S' | 'M' | 'L' | 'XL' | — | The size of the Button. |
isPending | false | true | — | Whether the Button is pending. Pending Buttons suppress press handlers and show progress. |
staticColor | 'white' | 'black' | 'auto' | — | The static color style to apply. Useful when the Button appears over a color background. |
styles | StyleString | — | Spectrum-defined generated classes. |
UNSAFE_className | string | — | Additional CSS class name. Use only as a last resort. |
UNSAFE_style | JSX.CSSProperties | — | Additional inline styles. Use only as a last resort. |
slot | string | false | — | A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components |
ref | ((el: HTMLButtonElement) => void) | { current?: HTMLButtonElement | null | undefined; } | — | Ref for the underlying button element. solidaria-components |
id | string | number | — | The element's unique identifier. solidaria |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the button. solidaria |
aria-current | false | true | 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false' | — | Indicates the current "pressed" state of toggle buttons. solidaria |
aria-describedby | string | — | The id of the element that describes the button. solidaria |
aria-details | string | — | The id of the element that provides detailed, extended description for the button. solidaria |
aria-disabled | false | true | 'true' | 'false' | — | Indicates that the button is perceivable but disabled. solidaria |
aria-expanded | false | true | 'true' | 'false' | — | Whether the popup is expanded. solidaria |
aria-haspopup | false | true | 'true' | 'false' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog' | — | Whether the button has a popup. solidaria |
aria-label | string | — | The accessible label for the button. solidaria |
aria-labelledby | string | — | The id of the element that labels the button. solidaria |
aria-pressed | false | true | 'true' | 'false' | 'mixed' | — | Whether the button is in a pressed state (controlled). solidaria |
isDisabled | boolean | Accessor<boolean> | — | Whether the button is disabled. solidaria |
onPress | (e: PressEvent) => void | — | Handler called when the press is released over the target. solidaria |
onPressStart | (e: PressEvent) => void | — | Handler called when a press interaction starts. solidaria |
onPressEnd | (e: PressEvent) => void | — | Handler called when a press interaction ends. solidaria |
onPressUp | (e: PressEvent) => void | — | Handler called when a press is released over the target. solidaria |
onPressChange | (isPressed: boolean) => void | — | Handler called when the press state changes. solidaria |
preventFocusOnPress | false | true | — | Whether the button should not receive focus on press. solidaria |
autoFocus | false | true | — | Whether the element should receive focus on render. solidaria |
type | 'button' | 'submit' | 'reset' | — | The type attribute for button elements. solidaria |
form | string | — | Additional attributes for form buttons. solidaria |
formAction | string | — | Not yet documented solidaria |
formEncType | string | — | Not yet documented solidaria |
formMethod | string | — | Not yet documented solidaria |
formNoValidate | false | true | — | Not yet documented solidaria |
formTarget | string | — | Not yet documented solidaria |
name | string | — | The name attribute for form buttons. solidaria |
value | string | — | The value attribute for form buttons. solidaria |
excludeFromTabOrder | false | true | — | Whether to exclude the button from the tab order. solidaria |
Declared in packages/viviana-ui/src/button/types.ts.
Props marked solidaria or solidaria-components come from the headless layer underneath and behave the same in both registers. Components that wrap a DOM element also accept that element's standard attributes, which are left out here on purpose — listing them would bury the props that are actually ours.