FloatLabel#
Props#
Defines valid properties in FloatLabel component.
| Prop | Default | Type |
|---|---|---|
ref | — | Ref<unknown> |
| The reference to the component instance. | ||
pIf | true | boolean |
| Whether the component should be rendered. | ||
style | — | CSSProperties | ((instance?: FloatLabelInstance) => CSSProperties) |
| The style to apply to the component. | ||
className | — | string | ((instance?: FloatLabelInstance) => string) |
| 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> |
| The component type to render. | ||
asChild | false | boolean |
| Whether the component should be rendered as a child component. | ||
instance | — | FloatLabelInstance |
| The instance to pass to the component. | ||
pt | — | SafeRecord<FloatLabelPassThrough> |
| The pass-through props to pass to the component. | ||
ptOptions | — | PassThroughOptions |
| The pass-through options to pass to the component. | ||
unstyled | — | boolean |
| Whether the component should be rendered without classes. | ||
dt | — | unknown |
| The design token to use for the component. | ||
styles | — | StylesOptions<ComponentInstance> |
| The styles to use for the component. | ||
render | — | (instance: FloatLabelInstance) => ReactNode |
| The render function to render the component with instance access. | ||
children | — | any |
| The children to render. Accepts `React.ReactNode` for static content or a render function `(instance: I) => React.ReactNode` for instance access. Typed as `any` to avoid JSX type errors when used directly in templates. | ||
variant | over | "on" | "in" | "over" |
| Defines the positioning of the label relative to the input. | ||
[key: string] | — | any |
pt-{optionName}-* | — | - |
| Pass through attributes for customizing component. For more info, see Pass Through tab. | ||
State#
Exposes#
Interfaces#
PassThroughOptions
Defines passthrough(pt) options of FloatLabel component.
| Prop | Type |
|---|---|
root | FloatLabelPassThroughType<HTMLAttributes<HTMLSpanElement>> |
| Used to pass attributes to the root's DOM element. | |
Types#
Instance
Instance of FloatLabel component.
| Values |
|---|
ComponentInstance<FloatLabelProps, FloatLabelState, FloatLabelExposes> |
useFloatLabel#
Props#
State#
Exposes#
Interfaces#
Types#
Instance
Instance of useFloatLabel headless.
| Values |
|---|
HeadlessInstance<useFloatLabelProps, useFloatLabelState, useFloatLabelExposes> |