Iridium CMSIridium CMS

num

The num property is used to define a numeric value.

If a step is provided, a slider will be used for the admin input and the numeric value will be rounded to the nearest multiple of the step.


import { atom, num } from '@iridiumcms/core';

export const sample = atom('sample', {
  myNum: num(),
});

Configuration

The num field takes an optional configuration object with the following properties:

  • minnumber
    The maximum value of the field. Defaults to 1.
  • maxnumber
    The minimum value of the field. Defaults to 0.
  • stepnumber
    The step size of the slider. Defaults to undefined.
  • defaultValuestring
    The default value of the field. Defaults to undefined.
  • displayNamestring
    The display name of the field. Defaults to the name of the property.
  • requiredboolean
    Whether the field is required. Defaults to false.
  • searchableboolean
    Whether the field is searchable. Defaults to false.
  • filterableboolean
    Allows filtering the field. Defaults to false.
  • layoutLAYOUT
    The layout of the field in the admin. Defaults to LAYOUT.full.