Skip to content

Type Alias: RUnsignedIntegerFieldProps

ts
type RUnsignedIntegerFieldProps = ExtractPublicPropTypes<
  ReturnType<typeof makeRUnsignedIntegerFieldProps>
>;

Public props interface for RUnsignedIntegerField components.

Provides type-safe access to all available props with unsigned integer constraints. Based on RIntegerField props with automatic min/max normalization for non-negative values.

Key Props:

  • modelValue: The current unsigned integer value(s) - number | number[] | null | undefined
  • multiple: Enable array input mode with chips
  • format: Numeral.js format string (e.g., "0,0", "#,##0")
  • min/max: Unsigned integer range validation (automatically normalized)
  • controlVariant: Control button layout style
  • renderMode: Display mode ("edit" | "read")

Automatic Constraints:

  • precision: Always 0 (no decimals, inherited from RIntegerField)
  • step: Always 1 (whole number increments, inherited from RIntegerField)
  • min: Always ≥ 0 (negative values become 0)
  • max: Undefined if negative (negative values ignored)

Constraint Examples:

typescript
// User input: min: -5, max: -10
// Normalized: min: 0, max: undefined

// User input: min: 10, max: 100
// Preserved: min: 10, max: 100

Example

typescript
const props: RUnsignedIntegerFieldProps = {
  modelValue: 42,
  format: "0,0",
  min: 1,
  max: 999999,
  controlVariant: "split",
};