Browse Source

docs: fields

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

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

@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem';
5. [**Optional**] Set default value for the field. 5. [**Optional**] Set default value for the field.
6. Click on `Save Column` button. 6. Click on `Save Column` button.
![image](/img/v2/fields/phone-number.png) ![image](/img/v2/fields/phone.png)
:::note :::note
- Specify default value without quotes. - Specify default value without quotes.

0
packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.number.md → packages/noco-docs/docs/060.fields/030.field-types/020.numerical/010.number.md

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

@ -4,6 +4,8 @@ title: 'Decimal'
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
`Decimal` field type is used to store decimal values. Use cases include storing `salary`, `price`, etc. NocoDB supports precision of upto 8 digits.
## Create field ## Create field
1. Click on `+` icon to the right of `Fields header` 1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name. 2. [**Optional**] On the dropdown modal, enter the field name.

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

@ -4,6 +4,8 @@ title: 'Percent'
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
`Percent` field type is used to store percentage values. Use cases include storing `discount`, `tax`, etc.
## Create field ## Create field
1. Click on `+` icon to the right of `Fields header` 1. Click on `+` icon to the right of `Fields header`
2. [**Optional**] On the dropdown modal, enter the field name. 2. [**Optional**] On the dropdown modal, enter the field name.

47
packages/noco-docs/docs/060.fields/030.field-types/030.select-based/010.single-select.md

@ -0,0 +1,47 @@
---
title: 'Single Select'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Single select` fields allow you to select a single option from a list of options. The options can be defined in the field configuration.
## 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 `SingleSelect` from the dropdown.
4. Click on `Add option` button to add options.
5. [**Optional**] Set default value for the field. The options are populated in the dropdown.
6. Click on `Save Column` button.
![image](/img/v2/fields/single-select.png)
## Edit options
### Rename options
You can rename options by clicking on the associated option text box. Click on `Save Column` button to save the changes.
### Re-configure color for options
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.
To configure, click on the `color` icon next to the option. Select the color from the color picker and click on `Save Column` button.
![image](/img/v2/fields/single-select-color.png)
### Re-order options
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 Column` button to save the order.
![image](/img/v2/fields/single-select-reorder.png)
:::info
The order defined for the options will be used in cells dropdown as well.
:::
### Delete options
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 Column` button to save the changes.
:::info
- On removing an option, the option value will be removed from all the cells.
- If the option value is set as default value for the field, then the default value will be removed.
:::
![image](/img/v2/fields/single-select-delete.png)

47
packages/noco-docs/docs/060.fields/030.field-types/030.select-based/020.multi-select.md

@ -0,0 +1,47 @@
---
title: 'Multi Select'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Multi Select` fields allow you to select multiple options from a list of options. The options can be defined in the field configuration.
## 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 `MultiSelect` from the dropdown.
4. Click on `Add option` button to add options.
5. [**Optional**] 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.
6. Click on `Save Column` button.
![image](/img/v2/fields/multi-select.png)
### Configure color for options
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.
To configure, click on the `color` icon next to the option. Select the color from the color picker and click on `Save Column` button.
![image](/img/v2/fields/single-select-color.png)
### Re-order options
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 Column` button to save the order.
![image](/img/v2/fields/single-select-reorder.png)
:::info
The order defined for the options will be used in cells dropdown as well.
:::
### Edit options
You can rename options by clicking on the associated option text box. Click on `Save Column` button to save the changes.
### Delete options
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 Column` button to save the changes.
:::info
- On removing an option, the option value will be removed from all the cells.
- If the option value is set as default value for the field, then the default value will be removed.
:::
![image](/img/v2/fields/single-select-delete.png)

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

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

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

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

34
packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md

@ -0,0 +1,34 @@
---
title: 'Links'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
`Links` field type is used to establish relationship between tables & create links to other records.
NocoDB supports following types of relations:
- `Has-Many` - A record in one table can have multiple records in another table.
- Example: A `Country` can have multiple `Cities`.
- `Belongs-to` - Multiple records in one table can have a single record in another table.
- Example: A `City` `Belongs-to` a `Country`.
- `Many-to-Many` - Multiple records in one table can have multiple records in another table.
- Example: A `Student` can have multiple `Subjects` & a `Subject` can have multiple `Students`.
:::note
- Links can be created only between tables in the same database.
- Self-referencing links are supported. (Link to the same table)
- For every `Has-Many` relation defined, NocoDB augments `Belongs-to` relationship column in the adjacent table automatically
:::
## 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 `Links` from the dropdown.
4. Select the relation type : Either `Has-Many` or `Many-to-Many`.
5. Select the table to which the relation is to be established.
6. [**Optional**] Configure label to be used for display in the cell.
7. Click on `Save Column` button.
![image](/img/v2/fields/links.png)
### Cell display
The cell will display number of links for a record to the related table. Clicking on the link-text will open a `Linked Records` modal with the list of links & associated additional information.

7
packages/noco-docs/docs/060.fields/030.field-types/040.links-based/020.lookup.md

@ -0,0 +1,7 @@
---
title: 'LookUp'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
![image](/img/v2/fields/lookup.png)

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

@ -0,0 +1,7 @@
---
title: 'Rollup'
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
![image](/img/v2/fields/rollup.png)

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

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

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

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

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

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

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

@ -3,3 +3,4 @@ title: 'Attachment'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

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

@ -3,3 +3,5 @@ title: 'Checkbox'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
!

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

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

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

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

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

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

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

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

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

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

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

@ -3,3 +3,4 @@ title: 'Duration'
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 51 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 52 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 49 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 51 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 47 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 48 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 49 KiB

BIN
packages/noco-docs/static/img/v2/fields/single-select-color.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
packages/noco-docs/static/img/v2/fields/single-select-delete.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

BIN
packages/noco-docs/static/img/v2/fields/single-select-reorder.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

BIN
packages/noco-docs/static/img/v2/fields/specific-db-type.png vendored

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Loading…
Cancel
Save