IconField API

API documentation for IconField component

IconField#

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

Defines passthrough(pt) options of IconField component.

name	type	default	description
root	IconFieldPassThroughType<InputHTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the root's DOM element.
icon	IconFieldPassThroughType<InputHTMLAttributes<HTMLDivElement>>	null	Used to pass attributes to the icon's DOM element.

Instance of IconField component.

values
ComponentInstance<IconFieldProps, IconFieldState, IconFieldExposes>

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

Defines the methods and properties exposed by InputIcon component.

name	type	default	description
iconfield	IconFieldInstance	null	Instance of the IconField component.

Defines passthrough(pt) options of InputIcon component.

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

Instance of InputIcon component.

values
ComponentInstance<InputIconProps, InputIconState, InputIconExposes>

On this page