Form

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

Import

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

Props

Props for Form in @proyecto-viviana/ui
Prop	Type	Default	Description
`styles`	StyleString	—	Spectrum-defined generated classes.
`UNSAFE_className`	string \| UnsafeClassName	—	Additional CSS class name. Use only as a last resort.
`UNSAFE_style`	JSX.CSSProperties	—	Additional inline styles. Use only as a last resort.
`ref`	((el: HTMLFormElement) => void) \| { current?: HTMLFormElement \| null \| undefined; }	—	Not yet documented
`children`	number \| boolean \| RenderedElement \| ArrayElement \| (string & {}) \| Node \| JSX.ArrayElement \| ((renderProps: FormRenderProps) => JSX.Element)	—	The children of the component. solidaria-components
`validationBehavior`	'aria' \| 'native'	—	Validation behavior mode. solidaria-components
`autoComplete`	false \| 'on' \| 'off'	—	Browser autocomplete behavior. React-style alias for Solid's `autocomplete`. solidaria-components
`validationErrors`	ValidationErrors	—	Server-side validation errors keyed by field name. solidaria-components
`acceptCharset`	string	—	Character encodings accepted by the server. React-style alias for Solid's `accept-charset`. solidaria-components
`autoCapitalize`	false \| 'none' \| 'on' \| 'off' \| 'sentences' \| 'words' \| 'characters'	—	Browser auto-capitalization hint. React-style alias for Solid's `autocapitalize`. solidaria-components
`encType`	false \| 'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'	—	Form encoding type. React-style alias for Solid's `enctype`. solidaria-components
`size`	'S' \| 'M' \| 'L' \| 'XL'	`'M'`	The size of descendant Form elements.
`labelPosition`	'top' \| 'side'	`'top'`	The label's overall position relative to each field.
`labelAlign`	'start' \| 'end'	`'start'`	The label's horizontal alignment relative to each field.
`necessityIndicator`	'label' \| 'icon'	`'icon'`	Whether required fields show an icon or text label.
`isRequired`	false \| true	—	Whether descendant Form elements are required.
`isDisabled`	false \| true	—	Whether descendant Form elements are disabled.
`isEmphasized`	false \| true	—	Whether descendant Form elements are rendered with emphasized styling.

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

FormStyle props

Props for FormStyle in @proyecto-viviana/ui
Prop	Type	Default	Description
`size`	'S' \| 'M' \| 'L' \| 'XL'	`'M'`	The size of descendant Form elements.
`labelPosition`	'top' \| 'side'	`'top'`	The label's overall position relative to each field.
`labelAlign`	'start' \| 'end'	`'start'`	The label's horizontal alignment relative to each field.
`necessityIndicator`	'label' \| 'icon'	`'icon'`	Whether required fields show an icon or text label.
`isRequired`	false \| true	—	Whether descendant Form elements are required.
`isDisabled`	false \| true	—	Whether descendant Form elements are disabled.
`isEmphasized`	false \| true	—	Whether descendant Form elements are rendered with emphasized styling.

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