Skip to content
Inputs & Forms

InputCurrency

client35.5 kB
@stellaria/nebula-webInputCurrencyProps

Preview

Props

21
PropTypeDefault

className

string

currency

required
string

defaultValue

numberNumber.NaN

description

ReactNode

disabled

booleanfalse

error

string | boolean

errorDisplay

ErrorDisplay"tooltip"

field

NebulaField<number>

label

ReactNode

locale

string

max

number

min

number

name

string

onChange

((value: number) => void)

placeholder

string

precision

number

required

booleanfalse

rootClassName

string

size

Size"md"

surface

FieldSurface"outline"

value

number

Slot props

6

Each one spreads over an inner element, so you can restyle a region without forking the component.

PropTypeDefault

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">

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.

Style props · 127