Fieldset API

API documentation for Fieldset component

Fieldset#

Props#

Defines valid properties in Fieldset component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: FieldsetInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: FieldsetInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<FieldsetPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: FieldsetInstance) => ReactNode)	null	The children to render.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of Fieldset component.

name	type	default	description
root	FieldsetPassThroughType<HTMLAttributes<HTMLFieldSetElement>>	null	Used to pass attributes to the root's DOM element.
legend	FieldsetPassThroughType<HTMLAttributes<HTMLLegendElement>>	null	Used to pass attributes to the legend's DOM element.
content	FieldsetPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the content's DOM element.

Types#

Instance

Instance of Fieldset component.

values
ComponentInstance<FieldsetProps, FieldsetState, FieldsetExposes>

FieldsetLegend#

Props#

Defines valid properties in FieldsetLegend component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: FieldsetLegendInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: FieldsetLegendInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<FieldsetLegendPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: FieldsetLegendInstance) => ReactNode)	null	The children to render.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Exposes#

Defines the methods and properties exposed by FieldsetLegend component.

name	type	default	description
fieldset	FieldsetInstance	null	The Fieldset component instance.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of FieldsetLegend component.

name	type	default	description
root	FieldsetLegendPassThroughType<HTMLAttributes<HTMLLegendElement>>	null	Used to pass attributes to the root's DOM element.

Types#

Instance

Instance of FieldsetLegend component.

values
ComponentInstance<FieldsetLegendProps, FieldsetLegendState, FieldsetLegendExposes>

FieldsetContent#

Props#

Defines valid properties in FieldsetContent component.

name	type	default	description
ref	Ref<unknown>	null	The reference to the component instance.
pIf	boolean	true	Whether the component should be rendered.
style	CSSProperties \| ((instance?: FieldsetContentInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: FieldsetContentInstance) => string)	null	The class name to apply to the component.
as	string \| number \| bigint \| boolean \| ComponentClass<any, any> \| FunctionComponent<any> \| ReactElement<unknown, string \| JSXElementConstructor<any>> \| Iterable<ReactNode, any, any> \| ReactPortal \| Promise<AwaitedReactNode>	null	The component type to render.
asChild	boolean	false	Whether the component should be rendered as a child component.
pt	SafeRecord<FieldsetContentPassThrough>	null	The pass-through props to pass to the component
ptOptions	PassThroughOptions	null	The pass-through options to pass to the component
unstyled	boolean	null	Whether the component should be rendered without classes.
dt	unknown	null	The design token to use for the component.
styles	StylesOptions<ComponentInstance>	null	The styles to use for the component.
children	ReactNode \| ((instance: FieldsetContentInstance) => ReactNode)	null	The children to render.
[key: string]	any	null
pt-{optionName}-*	-	null	Pass through attributes for customizing component. For more info, see Pass Through tab.

Exposes#

Defines the methods and properties exposed by FieldsetContent component.

name	type	default	description
fieldset	FieldsetInstance	null	The Switch component instance.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of FieldsetContent component.

name	type	default	description
root	FieldsetContentPassThroughType<HTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.

Types#

Instance

Instance of FieldsetContent component.

values
ComponentInstance<FieldsetContentProps, FieldsetContentState, FieldsetContentExposes>

useFieldset#

Types#

Instance

Instance of useFieldset headless.

values
HeadlessInstance<useFieldsetProps, useFieldsetState, useFieldsetExposes>

On this page

Fieldset
Props
Interfaces
Types
FieldsetLegend
Props
Exposes
Interfaces
Types
FieldsetContent
Props
Exposes
Interfaces
Types
useFieldset
Types