Skip to main content
PROYECTOVIVIANA

StatusLight

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

Import

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

Props

Differs from @proyecto-viviana/solid-spectrum
  • variant adds 'warning', 'success', 'metric'.
Props for StatusLight in @proyecto-viviana/ui
PropTypeDefaultDescription
childrennumber | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement—The content to display as the label.
variant'negative' | 'warning' | 'success' | 'informative' | 'neutral' | 'positive' | 'notice' | 'metric' | 'yellow' | 'chartreuse' | 'celery' | 'seafoam' | 'cyan' | 'indigo' | 'purple' | 'fuchsia' | 'magenta' | 'pink' | 'turquoise' | 'brown' | 'cinnamon' | 'silver''neutral'The variant changes the color of the status light.
size'S' | 'M' | 'L' | 'XL''M'The size of the status light.
role"status"—An accessibility role for the status light. Should be set when the status can change at runtime.
stylesStyleString | (() => StyleString | undefined)—Spectrum-defined generated classes.
UNSAFE_classNamestring | UnsafeClassName—Additional CSS class name. Use only as a last resort.
UNSAFE_styleJSX.CSSProperties—Additional inline styles. Use only as a last resort.
idstring—Not yet documented
slotstring—Not yet documented
refHTMLDivElement | ((el: HTMLDivElement) => void) | { current?: HTMLDivElement | null | undefined; }—Not yet documented
aria-labelstring—Not yet documented
aria-labelledbystring—Not yet documented
aria-describedbystring—Not yet documented
aria-detailsstring—Not yet documented

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