Studio

Number

Schema type reference for the Number type.

A number. See the NumberDefinition reference for the full type definition.

A number field used for a popularity rating

Any number. For example: 900, 900.0, 9E+2, or 9.0E+2.

Properties

  • Requiredtype

    Value must be set to number.

  • Requiredname

    The field name. This becomes the key in the document.

  • title

    Human-readable label for the field.

  • hidden

    If set to true, this field is hidden in the studio. You can also supply a callback function to make it a conditional field.

  • readOnly

    If set to true, this field is not editable in the studio. You can also supply a callback function to make it a conditional field.

  • description

    Short description for editors of how the field is to be used.

  • initialValue

    The initial value used when creating new values of this type. Can be a literal value, or a resolver function that returns a literal value or a promise that resolves to one.

  • components

    Lets you provide custom components to override the studio defaults in various contexts. The available keys are diff, field, input, item, and preview.

  • deprecated

    Marks a field or document type as deprecated in the studio interface and displays a user-defined message set through the single required reason property.

    If you deploy a GraphQL API schema, this property is translated into the @deprecated directive.

  • icon

    Supply a custom icon for this field. See the icons documentation for more information.

  • placeholder

    Placeholder text shown in the input when it has no value.

Options

These options apply to number fields. See the NumberOptions reference for the full type definition.

  • list

    A list of predefined values the editor can pick from. The array can hold plain numbers, as in [1, 2], or titled objects, as in [{title: 'One', value: 1}].

  • layout

    Controls how the items defined in the list option are presented. If set to 'radio' the list will render radio buttons. If set to 'dropdown' you'll get a dropdown menu instead. Default is dropdown.

  • direction

    Controls how radio buttons are lined up. Use direction: 'horizontal|vertical' to render radio buttons in a row or a column. Default is vertical. Will only take effect if the layout option is set to radio.

  • sanityCreate

    Configures how Sanity Create interfaces with this field. Set exclude: true to leave the field out of Sanity Create, or purpose to describe what the field holds so that content mapping can use it.

  • canvasApp

    Configures how Canvas interfaces with this field. Takes the same exclude and purpose properties as sanityCreate.

defineField({
  name: 'rating',
  type: 'number',
  options: {
    list: [
      {title: 'Poor', value: 1},
      {title: 'Fair', value: 2},
      {title: 'Good', value: 3},
    ],
    layout: 'radio',
    direction: 'horizontal',
  },
})

Validation

Chain these methods on the rule passed to validation. See the NumberRule reference for the full type definition.

  • required()

    Ensures that this field exists.

  • skip()

    Discards the validation rules set before it in the chain and makes the field optional. Rules chained after it still apply.

  • min(minNumber)

    Minimum value (inclusive).

  • max(maxNumber)

    Maximum value (inclusive).

  • lessThan(limit)

    Value must be less than the given limit.

  • greaterThan(limit)

    Value must be greater than the given limit.

  • integer()

    Value must be an integer (no decimals).

  • precision(limit)

    Specifies the maximum number of decimal places allowed.

  • positive()

    Requires the number to be positive (>= 0).

  • negative()

    Requires the number to be negative (< 0).

  • custom(fn)

    Create a custom validation.

  • error(message)

    Sets a custom error message for the preceding validation rule.

  • warning(message)

    Sets a custom warning message for the preceding validation rule. Warnings do not prevent publishing.

  • info(message)

    Sets a custom info message for the preceding validation rule. Info messages are purely informational and do not prevent publishing.

  • valueOfField(path)

    Gets the value of a sibling field to use in validation. Useful for creating validation rules that depend on the value of another field.

Input

import {defineField, defineType} from 'sanity'

export const movie = defineType({
  name: 'movie',
  type: 'document',
  fields: [
    defineField({
      name: 'popularity',
      title: 'Current popularity',
      type: 'number',
      validation: (rule) => rule.min(0).max(100).precision(1),
    }),
  ],
})

Response

{
  "_type": "movie",
  "popularity": 12.5,
  ...
}

Gotcha

Don't use number to store a phone number. Use string instead, so that leading zeros, country codes, and separators survive.

Was this page helpful?

Previous

Image

Next

Object

Sanity logosanity.ioAll Systems Operational© Sanity 2026
Change site theme