---
title: Number Field
label: Number
order: 100
desc: Number fields store and validate numeric data. Learn how to use and format Number fields, see examples and Number field options.
keywords: number, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
---

<Banner>
  The Number field stores and validates numeric entry and supports additional numerical validation
  and formatting features.
</Banner>

<LightDarkImage
  srcLight="https://payloadcms.com/images/docs/fields/number.png"
  srcDark="https://payloadcms.com/images/docs/fields/number-dark.png"
  alt="Shows a Number field in the Payload admin panel"
  caption="Admin panel screenshot of a Number field"
/>

### Config

| Option             | Description                                                                                                                                                                 |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
| **`min`**          | Minimum value accepted. Used in the default `validation` function.                                                                                                          |
| **`max`**          | Maximum value accepted. Used in the default `validation` function.                                                                                                          |
| **`hasMany`**      | Makes this field an ordered array of numbers instead of just a single number.                                                                                               |
| **`minRows`**      | Minimum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                |
| **`maxRows`**      | Maximum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                |
| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
| **`required`**     | Require this field to have a value.                                                                                                                                         |
| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |

_\* An asterisk denotes that a property is required._

### Admin config

In addition to the default [field admin config](/docs/fields/overview#admin-config), this field type allows for the following `admin` properties:

**`step`**

Set a value for the number field to increment / decrement using browser controls.

**`placeholder`**

Set this property to define a placeholder string for the field.

**`autoComplete`**

Set this property to a string that will be used for browser autocomplete.

### Example

`collections/ExampleCollection.ts`

```ts
import { CollectionConfig } from 'payload/types'

export const ExampleCollection: CollectionConfig = {
  slug: 'example-collection',
  fields: [
    {
      name: 'age', // required
      type: 'number', // required
      required: true,
      admin: {
        step: 1,
      },
    },
  ],
}
```