The number field represents a number input.

Options

interface NumberConfig extends FieldConfig {
  component: 'number'
  name: string
  label?: string
  description?: string
  step?: string | number
}

This interfaces only shows the keys unique to the number field. Visit the Field Config docs for a complete list of options.

Example: A Sorting Weight

Below is an example of how a number field could be used to edit a weight value used for sorting blog posts.

const BlogPostForm = {
  fields: [
    {
      component: 'number',
      name: 'weight',
      label: 'Weight',
      description: 'Enter a weight for post sorting',
      step: 1,
    },
    // ...
  ],
}