IconField API

API documentation for IconField component

IconFieldRoot#

Props#

Defines valid properties in IconFieldRoot component.

nametypedefaultdescription
refRef<unknown>
null
The reference to the component instance.
pIfboolean
true
Whether the component should be rendered.
styleCSSProperties | ((instance?: IconFieldRootInstance) => CSSProperties)
null
The style to apply to the component.
classNamestring | ((instance?: IconFieldRootInstance) => string)
null
The class name to apply to the component.
asstring | 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.
asChildboolean
false
Whether the component should be rendered as a child component.
ptSafeRecord<IconFieldRootPassThrough>
null
The pass-through props to pass to the component
ptOptionsPassThroughOptions
null
The pass-through options to pass to the component
unstyledboolean
null
Whether the component should be rendered without classes.
dtunknown
null
The design token to use for the component.
stylesStylesOptions<ComponentInstance>
null
The styles to use for the component.
childrenReactNode | ((instance: IconFieldRootInstance) => 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#

Defines passthrough(pt) options of IconFieldRoot component.

nametypedefaultdescription
rootIconFieldRootPassThroughType<InputHTMLAttributes<HTMLDivElement>>
null
Used to pass attributes to the root's DOM element.
iconIconFieldRootPassThroughType<HTMLAttributes<HTMLSpanElement>>
null
Used to pass attributes to the icon's DOM element.

Types#

Instance of IconFieldRoot component.

values
ComponentInstance<IconFieldRootProps, IconFieldRootState, IconFieldRootExposes>

InputIcon#

Props#

Exposes#

Interfaces#

Types#