Skip to main content
PROYECTOVIVIANA

ActionButton

The props declared for ActionButton, generated from the types @proyecto-viviana/ui ships.

Import

import { ActionButton } from "@proyecto-viviana/ui";

Props

Props for ActionButton in @proyecto-viviana/ui
PropTypeDefaultDescription
childrennumber | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement—The content to display in the ActionButton.
size'S' | 'M' | 'L' | 'XL' | 'XS''M'The size of the button.
staticColor'white' | 'black' | 'auto'—The static color style to apply. Useful when the ActionButton appears over a color background.
isQuietfalse | true—Whether the button should be displayed with a quiet style.
isPendingfalse | true—Whether the ActionButton is pending. Pending buttons suppress press handlers and show progress.
stylesStyleString—Spectrum-defined generated classes.
UNSAFE_classNamestring—Additional CSS class name. Use only as a last resort.
UNSAFE_styleJSX.CSSProperties—Additional inline styles. Use only as a last resort.
slotstring | 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
idstring | number—The element's unique identifier. solidaria
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the button. solidaria
aria-currentfalse | true | 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'—Indicates the current "pressed" state of toggle buttons. solidaria
aria-describedbystring—The id of the element that describes the button. solidaria
aria-detailsstring—The id of the element that provides detailed, extended description for the button. solidaria
aria-disabledfalse | true | 'true' | 'false'—Indicates that the button is perceivable but disabled. solidaria
aria-expandedfalse | true | 'true' | 'false'—Whether the popup is expanded. solidaria
aria-haspopupfalse | true | 'true' | 'false' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog'—Whether the button has a popup. solidaria
aria-labelstring—The accessible label for the button. solidaria
aria-labelledbystring—The id of the element that labels the button. solidaria
aria-pressedfalse | true | 'true' | 'false' | 'mixed'—Whether the button is in a pressed state (controlled). solidaria
isDisabledboolean | 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
preventFocusOnPressfalse | true—Whether the button should not receive focus on press. solidaria
autoFocusfalse | true—Whether the element should receive focus on render. solidaria
type'button' | 'submit' | 'reset'—The type attribute for button elements. solidaria
formstring—Additional attributes for form buttons. solidaria
formActionstring—Not yet documented solidaria
formEncTypestring—Not yet documented solidaria
formMethodstring—Not yet documented solidaria
formNoValidatefalse | true—Not yet documented solidaria
formTargetstring—Not yet documented solidaria
namestring—The name attribute for form buttons. solidaria
valuestring—The value attribute for form buttons. solidaria
excludeFromTabOrderfalse | true—Whether to exclude the button from the tab order. solidaria

Declared in packages/viviana-ui/src/button/ActionButton.tsx.

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.