Skip to main content
PROYECTOVIVIANA

SegmentedControl

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

Import

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

Props

Props for SegmentedControl in @proyecto-viviana/ui
PropTypeDefaultDescription
childrennumber | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement—The content to display in the segmented control.
isJustifiedfalse | true—Whether the items should divide the container width equally.
selectedKeyKey—The id of the currently selected item.
defaultSelectedKeyKey—The id of the initially selected item.
onSelectionChange(id: Key) => void—Handler that is called when the selection changes.
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.
classstring—Backward-compatible class alias. Prefer UNSAFE_className for S2 parity.
slotstring—Slot name when used in a Spectrum context.
refHTMLDivElement | ((el: HTMLDivElement) => void) | { current?: HTMLDivElement | null | undefined; }—Ref for the underlying radiogroup element.
isDisabledfalse | true—Not yet documented solidaria-components
disallowEmptySelectionfalse | true—Not yet documented solidaria-components

Declared in packages/viviana-ui/src/segmentedcontrol/index.tsx.

SegmentedControlItem props

Props for SegmentedControlItem in @proyecto-viviana/ui
PropTypeDefaultDescription
id*Key—The id of the item, matching the value used in SegmentedControl's selectedKey prop.
childrennumber | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement—The content to display in the segmented control item.
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.
classstring—Backward-compatible class alias. Prefer UNSAFE_className for S2 parity.
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
onClick(e: MouseEvent) => void—A native click handler, useful for form submission. Note: `onPress` is preferred for cross-device compatibility. 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
isDisabledboolean | Accessor<boolean>—Whether the button is disabled. solidaria
elementType'button' | 'a' | 'div' | 'input' | 'span'—The HTML element type to use for the button. solidaria
hrefstring—The URL to link to (for anchor elements). solidaria
targetstring—The target for the link (for anchor elements). solidaria
relstring—The rel attribute for the link (for anchor elements). solidaria
allowFocusWhenDisabledfalse | true—Whether to allow focus on the button when it is disabled. This enables showing tooltips on disabled buttons. When true, the button gets `tabIndex=-1` instead of being removed from tab order. 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
toggleKeyKey—Key used when inside ToggleButtonGroup selection state. solidaria-components

Declared in packages/viviana-ui/src/segmentedcontrol/index.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.