Browse Source

docs: field types

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
pull/6467/head
Raju Udava 1 year ago
parent
commit
193ed2450c
  1. 11
      packages/noco-docs/docs/060.fields/020.create-field.md
  2. 5
      packages/noco-docs/docs/060.fields/030.field-types/010.single-line-text.md
  3. 31
      packages/noco-docs/docs/060.fields/030.field-types/010.text-based/010.single-line-text.md
  4. 37
      packages/noco-docs/docs/060.fields/030.field-types/010.text-based/020.long-text.md
  5. 33
      packages/noco-docs/docs/060.fields/030.field-types/010.text-based/030.email.md
  6. 31
      packages/noco-docs/docs/060.fields/030.field-types/010.text-based/040.phonenumber.md
  7. 34
      packages/noco-docs/docs/060.fields/030.field-types/010.text-based/050.url.md
  8. 5
      packages/noco-docs/docs/060.fields/030.field-types/010.text-based/_category_.json
  9. 5
      packages/noco-docs/docs/060.fields/030.field-types/020.long-text.md
  10. 21
      packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.number.md
  11. 19
      packages/noco-docs/docs/060.fields/030.field-types/020.numerical/040.decimal.md
  12. 14
      packages/noco-docs/docs/060.fields/030.field-types/020.numerical/050.percent.md
  13. 5
      packages/noco-docs/docs/060.fields/030.field-types/020.numerical/_category_.json
  14. 5
      packages/noco-docs/docs/060.fields/030.field-types/030.number.md
  15. 0
      packages/noco-docs/docs/060.fields/030.field-types/030.select-based/090.single-select.md
  16. 0
      packages/noco-docs/docs/060.fields/030.field-types/030.select-based/100.multi-select.md
  17. 5
      packages/noco-docs/docs/060.fields/030.field-types/030.select-based/_category_.json
  18. 5
      packages/noco-docs/docs/060.fields/030.field-types/040.decimal.md
  19. 0
      packages/noco-docs/docs/060.fields/030.field-types/040.links-based/200.links.md
  20. 0
      packages/noco-docs/docs/060.fields/030.field-types/040.links-based/210.lookup.md
  21. 0
      packages/noco-docs/docs/060.fields/030.field-types/040.links-based/220.rollup.md
  22. 5
      packages/noco-docs/docs/060.fields/030.field-types/040.links-based/_category_.json
  23. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/060.attachment.md
  24. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/070.checkbox.md
  25. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/080.rating.md
  26. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/300.QR-code.md
  27. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/310.barcode.md
  28. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/320.geometry.md
  29. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/330.specific-db-type.md
  30. 0
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/340.json.md
  31. 5
      packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/_category_.json
  32. 5
      packages/noco-docs/docs/060.fields/030.field-types/050.percent.md
  33. 0
      packages/noco-docs/docs/060.fields/030.field-types/060.formula/170.formula.md
  34. 5
      packages/noco-docs/docs/060.fields/030.field-types/060.formula/_category_.json
  35. 0
      packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/110.date-time.md
  36. 0
      packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/120.date.md
  37. 0
      packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/130.time.md
  38. 0
      packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/140.duration.md
  39. 5
      packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/_category_.json
  40. 5
      packages/noco-docs/docs/060.fields/030.field-types/150.email.md
  41. 5
      packages/noco-docs/docs/060.fields/030.field-types/151.phonenumber.md
  42. 5
      packages/noco-docs/docs/060.fields/030.field-types/160.url.md
  43. BIN
      packages/noco-docs/static/img/v2/fields/URL.png
  44. BIN
      packages/noco-docs/static/img/v2/fields/decimal.png
  45. BIN
      packages/noco-docs/static/img/v2/fields/email.png
  46. BIN
      packages/noco-docs/static/img/v2/fields/long-text-expand-2.png
  47. BIN
      packages/noco-docs/static/img/v2/fields/long-text-expand.png
  48. BIN
      packages/noco-docs/static/img/v2/fields/long-text.png
  49. BIN
      packages/noco-docs/static/img/v2/fields/number.png
  50. BIN
      packages/noco-docs/static/img/v2/fields/percent.png
  51. BIN
      packages/noco-docs/static/img/v2/fields/phone-number.png
  52. BIN
      packages/noco-docs/static/img/v2/fields/single-line-text.png

11
packages/noco-docs/docs/060.fields/020.create-field.md

@ -2,4 +2,13 @@
title: 'Create field' title: 'Create field'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
## Create field
1. Click on `+` icon to the right of `Fields header`
2. On the dropdown modal, enter the field name.
3. Select the field type from the dropdown.
4. [Optional] Default value can be set for the field.

5
packages/noco-docs/docs/060.fields/030.field-types/010.single-line-text.md

@ -1,5 +0,0 @@
---
title: 'Single line text'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

31
packages/noco-docs/docs/060.fields/030.field-types/010.text-based/010.single-line-text.md

@ -0,0 +1,31 @@
---
title: 'Single line text'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Single line text` field is a simple text based field. It can hold any text value. It is generally used for storing short text values like name, email, phone number, etc. For storing text values with multiple lines, use [Long text](020.long-text.md) field.
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Single line text` from the dropdown.
4. [**Optional**] Set default value for the field.
5. Click on `Save Column` button.
![image](/img/v2/fields/single-line-text.png)
:::note
Specify default value without quotes.
:::
### Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Long text](020.long-text.md)
- [URL](050.url.md)
- [Email](030.email.md)
- [Phone](040.phonenumber.md)

37
packages/noco-docs/docs/060.fields/030.field-types/010.text-based/020.long-text.md

@ -0,0 +1,37 @@
---
title: 'Long text'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Long Text` field is text based field that allows text in multiple lines. It is useful for storing lengthy text like description, notes, etc.
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Long text` from the dropdown.
4. [**Optional**] Set default value for the field.
5. Click on `Save Column` button.
![image](/img/v2/fields/long-text.png)
:::note
- Specify default value without quotes.
- Use `Enter` key to add new line.
:::
### Cell display
`Long Text` field is displayed as a single line text field in the table view. Click on the expand icon in the cell to view the full text.
![image](/img/v2/fields/long-text-expand.png)
![image](/img/v2/fields/long-text-expand-2.png)
### Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](010.single-line-text.md)
- [URL](050.url.md)
- [Email](030.email.md)
- [Phone](040.phonenumber.md)

33
packages/noco-docs/docs/060.fields/030.field-types/010.text-based/030.email.md

@ -0,0 +1,33 @@
---
title: 'Email'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Email` field is text based field custom-built for storing E-mail IDs. It is a special type of `Single line text` field with
- Optional validation for Email ID
- Cell display as clickable link
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Email` from the dropdown.
4. [**Optional**] Enable validation by toggling the `Validate Email` checkbox.
5. [**Optional**] Set default value for the field.
6. Click on `Save Column` button.
![image](/img/v2/fields/email.png)
:::note
- Specify default value without quotes.
- Validation only ensures that the value entered is a valid email ID. It does not check if the email ID exists.
:::
### Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](010.single-line-text.md)
- [Long text](020.long-text.md)
- [URL](050.url.md)
- [Phone](040.phonenumber.md)

31
packages/noco-docs/docs/060.fields/030.field-types/010.text-based/040.phonenumber.md

@ -0,0 +1,31 @@
---
title: 'Phone Number'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Phone number` field is text based field that allows you to store phone numbers. It also allows you to validate the phone number.
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Phonenumber` from the dropdown.
4. [**Optional**] Enable validation by toggling the `Validate Phonenumber` checkbox.
5. [**Optional**] Set default value for the field.
6. Click on `Save Column` button.
![image](/img/v2/fields/phone-number.png)
:::note
- Specify default value without quotes.
- Validation only ensures that the value entered is a valid phone number. It does not check if the phone number exists.
:::
### Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](010.single-line-text.md)
- [Long text](020.long-text.md)
- [URL](050.url.md)
- [Email](030.email.md)

34
packages/noco-docs/docs/060.fields/030.field-types/010.text-based/050.url.md

@ -0,0 +1,34 @@
---
title: 'URL'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`URL` field is text based field custom-built for storing URLs. It is a special type of `Single line text` field with
- Optional validation for URL
- Cell display as clickable link
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `URL` from the dropdown.
4. [**Optional**] Enable validation by toggling the `Validate URL` checkbox.
5. [**Optional**] Set default value for the field.
6. Click on `Save Column` button.
![image](/img/v2/fields/url.png)
:::note
- Specify default value without quotes.
- Validation only ensures that the value entered is a valid URL. It does not check if the URL exists.
:::
### Similar text based fields
Following are the other text based fields available in NocoDB, custom-built for specific use cases.
- [Single line text](010.single-line-text.md)
- [Long text](020.long-text.md)
- [Email](030.email.md)
- [Phone](040.phonenumber.md)

5
packages/noco-docs/docs/060.fields/030.field-types/010.text-based/_category_.json

@ -0,0 +1,5 @@
{
"label": "Text based",
"collapsible": true,
"collapsed": true
}

5
packages/noco-docs/docs/060.fields/030.field-types/020.long-text.md

@ -1,5 +0,0 @@
---
title: 'Long text'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

21
packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.number.md

@ -0,0 +1,21 @@
---
title: 'Number'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Number` field type is used to store numerical values. Use cases include storing `age`, `salary`, `price`, `quantity`, etc.
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Number` from the dropdown.
4. [**Optional**] Set default value for the field.
5. Click on `Save Column` button.
![image](/img/v2/fields/number.png)
:::info
- This field type can hold both positive and negative numbers.
- Supported range (JavaScript): -9007199254740991 to 9007199254740991
:::

19
packages/noco-docs/docs/060.fields/030.field-types/020.numerical/040.decimal.md

@ -0,0 +1,19 @@
---
title: 'Decimal'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Decimal` from the dropdown.
4. Configure `Precision`- NocoDB supports upto 8 digits of precision.
5. [**Optional**] Set default value for the field.
6. Click on `Save Column` button.
![image](/img/v2/fields/decimal.png)
:::info
- Default decimal precision is 1 digit
:::

14
packages/noco-docs/docs/060.fields/030.field-types/020.numerical/050.percent.md

@ -0,0 +1,14 @@
---
title: 'Percent'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Create field
1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name.
3. Select the field type as `Percent` from the dropdown.
4. [**Optional**] Set default value for the field.
5. Click on `Save Column` button.
![image](/img/v2/fields/percent.png)

5
packages/noco-docs/docs/060.fields/030.field-types/020.numerical/_category_.json

@ -0,0 +1,5 @@
{
"label": "Numerical",
"collapsible": true,
"collapsed": true
}

5
packages/noco-docs/docs/060.fields/030.field-types/030.number.md

@ -1,5 +0,0 @@
---
title: 'Number'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

0
packages/noco-docs/docs/060.fields/030.field-types/090.single-select.md → packages/noco-docs/docs/060.fields/030.field-types/030.select-based/090.single-select.md

0
packages/noco-docs/docs/060.fields/030.field-types/100.multi-select.md → packages/noco-docs/docs/060.fields/030.field-types/030.select-based/100.multi-select.md

5
packages/noco-docs/docs/060.fields/030.field-types/030.select-based/_category_.json

@ -0,0 +1,5 @@
{
"label": "Select based",
"collapsible": true,
"collapsed": true
}

5
packages/noco-docs/docs/060.fields/030.field-types/040.decimal.md

@ -1,5 +0,0 @@
---
title: 'Decimal'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

0
packages/noco-docs/docs/060.fields/030.field-types/200.links.md → packages/noco-docs/docs/060.fields/030.field-types/040.links-based/200.links.md

0
packages/noco-docs/docs/060.fields/030.field-types/210.lookup.md → packages/noco-docs/docs/060.fields/030.field-types/040.links-based/210.lookup.md

0
packages/noco-docs/docs/060.fields/030.field-types/220.rollup.md → packages/noco-docs/docs/060.fields/030.field-types/040.links-based/220.rollup.md

5
packages/noco-docs/docs/060.fields/030.field-types/040.links-based/_category_.json

@ -0,0 +1,5 @@
{
"label": "Links based",
"collapsible": true,
"collapsed": true
}

0
packages/noco-docs/docs/060.fields/030.field-types/060.attachment.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/060.attachment.md

0
packages/noco-docs/docs/060.fields/030.field-types/070.checkbox.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/070.checkbox.md

0
packages/noco-docs/docs/060.fields/030.field-types/080.rating.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/080.rating.md

0
packages/noco-docs/docs/060.fields/030.field-types/300.QR-code.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/300.QR-code.md

0
packages/noco-docs/docs/060.fields/030.field-types/310.barcode.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/310.barcode.md

0
packages/noco-docs/docs/060.fields/030.field-types/320.geometry.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/320.geometry.md

0
packages/noco-docs/docs/060.fields/030.field-types/330.specific-db-type.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/330.specific-db-type.md

0
packages/noco-docs/docs/060.fields/030.field-types/340.json.md → packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/340.json.md

5
packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/_category_.json

@ -0,0 +1,5 @@
{
"label": "Custom types",
"collapsible": true,
"collapsed": true
}

5
packages/noco-docs/docs/060.fields/030.field-types/050.percent.md

@ -1,5 +0,0 @@
---
title: 'Percent'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

0
packages/noco-docs/docs/060.fields/030.field-types/170.formula.md → packages/noco-docs/docs/060.fields/030.field-types/060.formula/170.formula.md

5
packages/noco-docs/docs/060.fields/030.field-types/060.formula/_category_.json

@ -0,0 +1,5 @@
{
"label": "Formula",
"collapsible": true,
"collapsed": true
}

0
packages/noco-docs/docs/060.fields/030.field-types/110.date-time.md → packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/110.date-time.md

0
packages/noco-docs/docs/060.fields/030.field-types/120.date.md → packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/120.date.md

0
packages/noco-docs/docs/060.fields/030.field-types/130.time.md → packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/130.time.md

0
packages/noco-docs/docs/060.fields/030.field-types/140.duration.md → packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/140.duration.md

5
packages/noco-docs/docs/060.fields/030.field-types/070.date-time-based/_category_.json

@ -0,0 +1,5 @@
{
"label": "Date Time based",
"collapsible": true,
"collapsed": true
}

5
packages/noco-docs/docs/060.fields/030.field-types/150.email.md

@ -1,5 +0,0 @@
---
title: 'Email'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

5
packages/noco-docs/docs/060.fields/030.field-types/151.phonenumber.md

@ -1,5 +0,0 @@
---
title: 'Phone Number'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

5
packages/noco-docs/docs/060.fields/030.field-types/160.url.md

@ -1,5 +0,0 @@
---
title: 'URL'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

BIN
packages/noco-docs/static/img/v2/fields/URL.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

BIN
packages/noco-docs/static/img/v2/fields/decimal.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

BIN
packages/noco-docs/static/img/v2/fields/email.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
packages/noco-docs/static/img/v2/fields/long-text-expand-2.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 165 KiB

BIN
packages/noco-docs/static/img/v2/fields/long-text-expand.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

BIN
packages/noco-docs/static/img/v2/fields/long-text.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

BIN
packages/noco-docs/static/img/v2/fields/number.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
packages/noco-docs/static/img/v2/fields/percent.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

BIN
packages/noco-docs/static/img/v2/fields/phone-number.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

BIN
packages/noco-docs/static/img/v2/fields/single-line-text.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Loading…
Cancel
Save