FormsInteractive playground

Field

Label, hint, control and error in one unit.

Preparing the playground…

Text and Markdown example

Field · Example

1<Field><FieldLabel htmlFor="field-name">Name</FieldLabel><Input id="field-name" placeholder="Your name" /><FieldDescription>How your team will see you.</FieldDescription></Field>

Read documentation in Markdown

How to use it

Group fields with FieldGroup or FieldSet. Use FieldDescription for instructions and FieldError for validation messages.

Import

React / Next.js

1import { Field, FieldSet, FieldLegend, FieldGroup, FieldLabel, FieldContent, FieldDescription, FieldError, FieldSeparator } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`orientation`	`"horizontal" \| "vertical" \| "responsive"`	Horizontal or vertical axis.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

Subcomponents and composition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

Field14 properties

Field · TypeScript

1Field: React.ForwardRefExoticComponent<FieldProps & React.RefAttributes<HTMLDivElement>>

FieldSet15 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`disabled`	`boolean`	Disable interaction with the control.
`id`	`string`	Element identifier; associates labels and descriptions.
`name`	`string`	Name used to identify the control in forms.
`onChange`	`ChangeEventHandler<HTMLFieldSetElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLFieldSetElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLFieldSetElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldSet · TypeScript

1FieldSet: React.ForwardRefExoticComponent<FieldSetProps & React.RefAttributes<HTMLFieldSetElement>>

FieldLegend13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLLegendElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLLegendElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLLegendElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldLegend · TypeScript

1FieldLegend: React.ForwardRefExoticComponent<FieldLegendProps & React.RefAttributes<HTMLLegendElement>>

FieldGroup13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldGroup · TypeScript

1FieldGroup: React.ForwardRefExoticComponent<FieldGroupProps & React.RefAttributes<HTMLDivElement>>

FieldLabel14 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`htmlFor`	`string`	id of the control associated with the label.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLLabelElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLLabelElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLLabelElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldLabel · TypeScript

1FieldLabel: React.ForwardRefExoticComponent<FieldLabelProps & React.RefAttributes<HTMLLabelElement>>

FieldContent13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldContent · TypeScript

1FieldContent: React.ForwardRefExoticComponent<FieldContentProps & React.RefAttributes<HTMLDivElement>>

FieldDescription13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLParagraphElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLParagraphElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLParagraphElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldDescription · TypeScript

1FieldDescription: React.ForwardRefExoticComponent<FieldDescriptionProps & React.RefAttributes<HTMLParagraphElement>>

FieldError13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLParagraphElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLParagraphElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLParagraphElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldError · TypeScript

1FieldError: React.ForwardRefExoticComponent<FieldErrorProps & React.RefAttributes<HTMLParagraphElement>>

FieldSeparator13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLDivElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLDivElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLDivElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

FieldSeparator · TypeScript

1FieldSeparator: React.ForwardRefExoticComponent<FieldSeparatorProps & React.RefAttributes<HTMLDivElement>>

API generated from @kivora/nextjs 0.2.0View package