Skip to content

Type Alias: RNumberFieldProps

ts
type RNumberFieldProps = ExtractPublicPropTypes<
  ReturnType<typeof makeRNumberFieldProps>
>;

Public props interface for RNumberField components.

Provides type-safe access to all available props, including VNumberInput properties, custom formatting options, and resourceful field capabilities.

Key Props:

  • modelValue: The current number value(s)
  • multiple: Enable array input mode with chips
  • format: Numeral.js format string (e.g., "0,0.00", "$0,0")
  • min/max: Numeric range validation
  • step: Increment/decrement step size
  • controlVariant: Control button layout style
  • renderMode: Display mode ("edit" | "read")

Example

typescript
const props: RNumberFieldProps = {
  modelValue: 123.45,
  format: "$0,0.00",
  min: 0,
  max: 1000000,
  controlVariant: "split",
};