Skip to content

Commit 1780dea

Browse files
Merge pull request #283 from nocodb/docs/cleanup-1006
docs: numeric field types (clean-up)
2 parents 4f291fe + d6e362d commit 1780dea

File tree

20 files changed

+162
-141
lines changed

20 files changed

+162
-141
lines changed

content/docs/fields/field-types/numerical/currency.mdx

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,42 @@
11
---
22
title: 'Currency'
3-
description: 'This article explains how to create & work with a Currency field.'
3+
description: 'This article explains how to create and use a Currency field.'
44
tags: ['Fields', 'Field types', 'Numerical types', 'Currency']
55
keywords: ['Fields', 'Field types', 'Numerical types', 'Currency', 'Create currency field']
66
---
77

8+
The **Currency** field is a numerical field used to store monetary values. It provides additional options to configure the currency locale and symbol for display.
89

9-
`Currency` field type is used to store currency values. It is a numerical field with additional provision to set the currency symbol in display.
10+
<Callout type="warning">Currency formatting is applied only for display. The stored value remains numerical for calculations and formulas.</Callout>
1011

11-
## Create field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Currency` from the dropdown.
15-
4. Configure `Currency Locale` : defaults to `en-US`
16-
5. Configure `Currency Symbol` : defaults to `$`
17-
6. Set default value for the field (Optional).
18-
7. Click on `Save Field` button.
12+
## Create a Currency field
1913

20-
![image](/img/v2/fields/types/currency.png)
14+
1. Click the `+` icon next to the last field in your table.
15+
2. Enter a name for the field.
16+
3. Select **Currency** from the list of field types.
17+
4. Configure **Currency Locale** (defaults to `en-US`).
18+
5. Configure **Currency Symbol** (defaults to `$`).
19+
6. (Optional) Set a default value for the field and add a description.
20+
7. Click **Save field** to add the field to your table.
2121

22-
### Cell display
23-
![image](/img/v2/fields/currency-cell-display.png)
22+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
2423

25-
### Supported locales
26-
https://www.npmjs.com/package/locale-codes#locale-list
2724

28-
<Callout type="note">
29-
NocoDB adheres to ISO639-1 standard for locale codes.
30-
</Callout>
25+
## Cell display
3126

32-
### Supported currencies
27+
The **Currency** field appears as a numeric cell with the configured currency symbol and formatting.
28+
29+
![Cell display](/img/v2/fields/types/numerical/currency-display.png)
30+
31+
## Supported locales
32+
33+
NocoDB supports locale codes based on the [ISO639-1 standard](https://www.npmjs.com/package/locale-codes#locale-list).
34+
35+
<Callout type="info">Ensure the correct locale is selected to apply region-specific number formatting (e.g., **en-US**, **fr-FR**).</Callout>
36+
37+
## Supported currencies
38+
39+
The **Currency** field supports a wide range of ISO 4217 currency codes, including but not limited to:
3340

3441
| | | | | | |
3542
|-----|-----|-----|-----|-----|-----|
@@ -65,10 +72,4 @@ NocoDB adheres to ISO639-1 standard for locale codes.
6572
| XPD | XPF | XPT | XTS | XXX | YER |
6673
| ZAR | ZMK | ZWD | | | |
6774

68-
69-
70-
## Similar numerical fields
71-
Following are the other numerical fields available in NocoDB, with some custom add-on features.
72-
- [Number](/docs/product-docs/fields/field-types/numerical/number)
73-
- [Decimal](/docs/product-docs/fields/field-types/numerical/decimal)
74-
- [Percent](/docs/product-docs/fields/field-types/numerical/percent)
75+
---

content/docs/fields/field-types/numerical/decimal.mdx

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
---
22
title: 'Decimal'
3-
description: 'This article explains how to create & work with a Decimal field.'
3+
description: 'This article explains how to create and use a Decimal field.'
44
tags: ['Fields', 'Field types', 'Numerical types', 'Decimal']
55
keywords: ['Fields', 'Field types', 'Numerical types', 'Decimal', 'Create decimal field']
66
---
77

8+
The **Decimal** field is a numerical field used to store decimal values. It is commonly used for data such as salary, price, or other values requiring fractional precision.
89

9-
`Decimal` field type is used to store decimal values. Use cases include storing `salary`, `price`, etc. NocoDB supports precision of upto 8 digits.
10+
<Callout type="warning">NocoDB supports up to 8 digits of precision.</Callout>
1011

11-
## Create a decimal field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Decimal` from the dropdown.
15-
4. Configure `Precision`- NocoDB supports upto 8 digits of precision.
16-
5. Set default value for the field (Optional).
17-
6. Click on `Save Field` button.
12+
## Create a Decimal field
1813

19-
![image](/img/v2/fields/types/decimal.png)
14+
1. Click the `+` icon next to the last field in your table.
15+
2. Enter a name for the field.
16+
3. Select **Decimal** from the list of field types.
17+
4. Configure the **Precision** setting (up to 8 digits).
18+
5. Toggle **Show thousands separator** to format large numbers with a thousand separator (e.g., 1,000.00 instead of 1000.00).
19+
6. (Optional) Set a default value for the field and add a description.
20+
7. Click **Save field** to add the field to your table.
2021

21-
<Callout type="note">
22-
Default decimal precision is 1 digit
23-
</Callout>
22+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
23+
24+
25+
<Callout type="info">The default precision is set to 1 digit.</Callout>
26+
27+
## Cell display
28+
29+
The **Decimal** field appears as a numeric cell in the table, right-aligned for readability. Values are displayed with the configured number of decimal places. If the **Show thousands separator** option is enabled, large numbers will be formatted with a comma as the thousand separator.
30+
31+
![Number field cell display](/img/v2/fields/types/numerical/decimal-display.png)
32+
33+
---
2434

25-
## Similar numerical fields
26-
Following are the other numerical fields available in NocoDB, with some custom add-on features.
27-
- [Number](/docs/product-docs/fields/field-types/numerical/number)
28-
- [Percent](/docs/product-docs/fields/field-types/numerical/percent)
29-
- [Currency](/docs/product-docs/fields/field-types/numerical/currency)
Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
---
22
title: 'Number'
3-
description: 'This article explains how to create & work with a Number field.'
3+
description: 'This article explains how to create and use a Number field.'
44
tags: ['Fields', 'Field types', 'Numerical types', 'Number']
55
keywords: ['Fields', 'Field types', 'Numerical types', 'Number', 'Create number field']
66
---
77

8+
The **Number** field is a numerical field used to store integer values. It is commonly used for data such as age, salary, price, or quantity.
89

9-
`Number` field type is used to store numerical values. Use cases include storing `age`, `salary`, `price`, `quantity`, etc.
10+
<Callout type="warning">Supported range (JavaScript): -9,007,199,254,740,991 to 9,007,199,254,740,991</Callout>
1011

11-
## Create a number field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Number` from the dropdown.
15-
4. Set default value for the field (Optional).
16-
5. Click on `Save Field` button.
12+
## Create a Number field
1713

18-
![image](/img/v2/fields/types/number.png)
14+
1. Click the `+` icon next to the last field in your table.
15+
2. Enter a name for the field.
16+
3. Select **Number** from the list of field types.
17+
4. (Optional) Toggle **Show thousands separator** to format large numbers with a thousand separator (e.g., 1,000 instead of 1000).
18+
5. (Optional) Set a default value for the field and add a description.
19+
6. Click **Save field** to add the field to your table.
1920

20-
<Callout type="note">
21-
- This field type can hold both positive and negative numbers.
22-
- Supported range (JavaScript): -9007199254740991 to 9007199254740991
23-
</Callout>
21+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
2422

25-
## Similar numerical fields
26-
Following are the other numerical fields available in NocoDB, with some custom add-on features.
27-
- [Decimal](/docs/product-docs/fields/field-types/numerical/decimal)
28-
- [Percent](/docs/product-docs/fields/field-types/numerical/percent)
29-
- [Currency](/docs/product-docs/fields/field-types/numerical/currency)
23+
<Callout type="info">The Number field supports both positive and negative values.</Callout>
24+
25+
## Cell display
26+
27+
The **Number** field appears as a numeric cell in the table. Its display aligns to the right by default for clarity and consistency when handling numerical data. If the **Show thousands separator** option is enabled, large numbers will be formatted with a comma as the thousand separator.
28+
29+
![Cell display](/img/v2/fields/types/numerical/number-display.png)
30+
31+
---
Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,32 @@
11
---
22
title: 'Percent'
3-
description: 'This article explains how to create & work with a Percent field.'
3+
description: 'This article explains how to create and use a Percent field.'
44
tags: ['Fields', 'Field types', 'Numerical types', 'Percent']
55
keywords: ['Fields', 'Field types', 'Numerical types', 'Percent', 'Create percent field']
66
---
77

8+
The **Percent** field is a numerical field used to store percentage values. It is useful for data such as completion rates, discount percentages, or performance metrics.
89

9-
`Percent` field type is used to store percentage values. Use cases include storing `discount`, `tax`, etc.
10+
<Callout type="warning">Values are entered as whole numbers and displayed with a percentage sign (e.g., **75** is shown as **75%**).</Callout>
1011

11-
## Create a percent field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `Percent` from the dropdown.
15-
4. Set default value for the field (Optional).
16-
5. Click on `Save Field` button.
12+
## Create a Percent field
1713

18-
![image](/img/v2/fields/types/percent.png)
14+
1. Click the `+` icon next to the last field in your table.
15+
2. Enter a name for the field.
16+
3. Select **Percent** from the list of field types.
17+
4. (Optional) Enable **Display as progress** to show the percentage as a progress bar.
18+
5. (Optional) Set a default value for the field and add a description.
19+
6. Click **Save field** to add the field to your table.
1920

20-
## Similar numerical fields
21-
Following are the other numerical fields available in NocoDB, with some custom add-on features.
22-
- [Number](/docs/product-docs/fields/field-types/numerical/number)
23-
- [Decimal](/docs/product-docs/fields/field-types/numerical/decimal)
24-
- [Currency](/docs/product-docs/fields/field-types/numerical/currency)
21+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
22+
23+
<Callout type="info"> The **Percent** field does not include a `Show thousand separator` option.</Callout>
24+
25+
## Cell display
26+
27+
The **Percent** field appears as a numeric cell in the table, right-aligned by default.
28+
29+
- When **Display as progress** is enabled, the value is represented as a progress bar.
30+
- Without progress display, the value appears as a standard percentage.
31+
32+
![Cell display](/img/v2/fields/types/numerical/percent-display.png)
Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,56 @@
11
---
2-
title: 'Multi Select'
3-
description: 'This article explains how to create & work with a Multi select field.'
2+
title: 'Multi select'
3+
description: 'This article explains how to create and use a Multi select field.'
44
tags: ['Fields', 'Field types', 'Select based types', 'Multi select']
55
keywords: ['Fields', 'Field types', 'Select based types', 'Multi select', 'Create multi select field']
66
---
77

8+
The **Multi select** field allows you to choose multiple options from a predefined list. It is useful for fields like skills, tags, or applicable categories.
89

9-
`Multi Select` fields allow you to select multiple options from a list of options. The options can be defined in the field configuration.
10+
## Create a Multi select field
1011

11-
## Create a multi select field
12-
1. Click on `+` icon to the right of `Fields header`
13-
2. On the dropdown modal, enter the field name (Optional).
14-
3. Select the field type as `MultiSelect` from the dropdown.
15-
4. Click on `Add option` button to add options.
16-
5. Set default value for the field. The options are populated in the dropdown. Since its multi select, you can select multiple options as default value (Optional).
17-
6. Click on `Save Field` button.
12+
1. Click the `+` icon next to the last field in your table.
13+
2. Enter a name for the field.
14+
3. Select **Multi select** from the list of field types.
15+
4. Click **Add option** to define available options.
16+
5. (Optional) Set default values for the field from the defined options.
17+
6. Click **Save field** to add the field to your table.
1818

19-
![image](/img/v2/fields/types/multiselect.png)
19+
Refer to the general guidelines on [creating a field](/docs/product-docs/fields#create-a-field).
2020

21-
<Callout type="note">
22-
Use of `,` is not allowed for option values.
23-
</Callout>
21+
![image](/img/v2/fields/types/multi-select/multi-select.png)
2422

25-
### Configure color for options
26-
You can re-configure background color for each option. This is useful when you want to highlight certain options. For example, you can configure `High` option to have `red` background color.
27-
To configure, click on the `color` icon next to the option. Select the color from the color picker and click on `Save Field` button.
23+
<Callout type="note"> `✨✨✨` **NocoAI** can assist in generating options for your Multi select field. Click the **Auto Suggest** button to get AI-generated suggestions based on your field name & existing options.</Callout>
2824

29-
![image](/img/v2/fields/types/options-change-colour.png)
25+
## Edit options
3026

31-
### Re-order options
32-
You can re-order options by dragging and dropping the options. To re-order, click on the `drag` icon next to the option and drag it to the desired position. Click on `Save Field` button to save the order.
27+
### Rename options
28+
Click on the option text box to rename an option. Save changes using **Save field**.
3329

34-
![image](/img/v2/fields/types/options-reorder.png)
30+
### Configure colors
31+
Assign background colors to options to visually distinguish them. For example, tag `Urgent` as red to highlight importance.
32+
Click the **color** icon next to an option, select a color, and save changes.
3533

36-
<Callout type="info">The order defined for the options will be used in cells dropdown as well</Callout>
34+
![image](/img/v2/fields/types/multi-select/options-colour.png)
3735

36+
### Reorder options
37+
Drag and drop options using the **drag** icon to reorder them. The new order is reflected in the dropdown inside cells.
3838

39-
### Edit options
40-
You can rename options by clicking on the associated option text box. Click on `Save Field` button to save the changes.
39+
![image](/img/v2/fields/types/multi-select/options-reorder.png)
40+
41+
<Callout type="info">The order you define for options is preserved in the cell dropdown list.</Callout>
4142

4243
### Delete options
43-
You can delete options by clicking on the `x` icon next to the option. You can undo the delete by clicking on the `undo` icon next to the option. Click on `Save Field` button to save the changes.
44+
Click the `x` icon to delete an option. Deleted options can be restored using the **undo** icon before saving.
45+
46+
![image](/img/v2/fields/types/multi-select/options-remove.png)
47+
48+
<Callout type="warning"> Removing an option clears it from all cells where it was selected. If the deleted option was set as a default value, the default will be cleared. </Callout>
4449

45-
<Callout type="note">
46-
- On removing an option, the option value will be removed from all the cells.
47-
- If the option value is set as default value for the field, then the default value will be removed.
48-
</Callout>
50+
## Cell display
4951

50-
![image](/img/v2/fields/types/options-remove.png)
52+
The **Multi select** field displays as a dropdown in table cells, showing the configured options with their respective colors. Multiple options can be selected for a single cell.
5153

52-
## Similar select based fields
53-
- [Single select](/docs/product-docs/fields/field-types/select-based/single-select)
54+
<img src="/img/v2/fields/types/multi-select/display.png" alt="display" style={{width: "80%"}} />
55+
56+
---

0 commit comments

Comments
 (0)