PinInput
@stellaria/nebula-webPinInputPropsPreview
Props
23| Prop | Type | Default |
|---|---|---|
autoFocus | boolean | false |
cellLabel | ((index: number, length: number) => string) | — |
className | string | — |
defaultValue | string | "" |
description | ReactNode | — |
disabled | boolean | false |
error | string | boolean | — |
errorDisplay | ErrorDisplay | "tooltip" |
field | NebulaField<string> | — |
label | ReactNode | — |
length | number | 6 |
mask | boolean | false |
name | string | — |
onChange | ((value: string) => void) | — |
onComplete | ((value: string) => void) | — |
placeholder | string | "○" |
readOnly | boolean | false |
required | boolean | false |
rootClassName | string | — |
size | Size | "md" |
surface | FieldSurface | "outline" |
type | PinInputType | "numeric" |
value | string | — |
Slot props
7Each one spreads over an inner element, so you can restyle a region without forking the component.
| Prop | Type | Default |
|---|---|---|
bodyProps Wrapper for the control. | BoxSlotProps | — |
descriptionProps Help text below the label. Only rendered with `description`. | TextSlotProps | — |
errorProps Configures the `FieldError`. With `errorDisplay="tooltip"` it spreads whole; with `"text"` there is no `FieldError` to configure — it is a `Text` with `role="alert"` — and only `className` is honoured. | Omit<FieldErrorProps, "children"> | — |
groupProps The row of boxes. It is the `role="group"` that groups the fields inside the `FormField`. | BoxSlotProps | — |
headerProps The label and description row. Not rendered when the field has neither. | BoxSlotProps | — |
labelProps The field label. It lands on the `<label>`, which already carries the control `htmlFor`. | TextSlotProps | — |
requiredProps The required asterisk, which lives inside the label. Only rendered with `required`. | BoxSlotProps | — |
Also accepts
On top of its own props, this component forwards these groups.