Divider API

API documentation for Divider component

DividerRoot#

Props#

Defines valid properties in Divider 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?: DividerRootInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: DividerRootInstance) => 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<DividerRootPassThrough>	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: DividerRootInstance) => ReactNode)	null	The children to render.
align	"center" \| "top" \| "right" \| "bottom" \| "left"	null	Alignment of the content.
orientation	"horizontal" \| "vertical"	horizontal	Specifies the orientation, valid values are 'horizontal' and 'vertical'.
type	"solid" \| "dashed" \| "dotted"	solid	Border style type.
[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 Divider component.

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

Types#

Instance

Instance of Divider component.

values
ComponentInstance<DividerRootProps, DividerRootState, DividerRootExposes>

DividerContent#

Props#

Defines valid properties in DividerContent 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?: DividerContentInstance) => CSSProperties)	null	The style to apply to the component.
className	string \| ((instance?: DividerContentInstance) => 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<DividerContentPassThrough>	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: DividerContentInstance) => 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 DividerContent component.

name	type	default	description
divider	DividerRootInstance	null	Instance of the Divider component.

Interfaces#

PassThroughOptions

Defines passthrough(pt) options of DividerContent component.

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

Types#

Instance

Instance of DividerContent component.

values
ComponentInstance<DividerContentProps, DividerContentState, DividerContentExposes>

useDivider#

Types#

Instance

Instance of useDivider headless.

values
HeadlessInstance<useDividerProps, useDividerState, useDividerExposes>