diff --git a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/010.single-line-text.md b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/010.single-line-text.md index 429bbeb556..13ea0b2835 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/010.single-line-text.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/010.single-line-text.md @@ -6,7 +6,7 @@ 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 +## Create a single line text 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. @@ -19,7 +19,7 @@ import TabItem from '@theme/TabItem'; Specify default value without quotes. ::: -### Similar text based fields +## 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) diff --git a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/020.long-text.md b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/020.long-text.md index e988a205a1..dc54841011 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/020.long-text.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/020.long-text.md @@ -6,7 +6,7 @@ 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 +## Create a `Long Text` 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. @@ -27,7 +27,7 @@ import TabItem from '@theme/TabItem'; ![image](/img/v2/fields/long-text-expand-2.png) -### Similar text based fields +## 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) diff --git a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/030.email.md b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/030.email.md index c04deffb3f..053e6f1848 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/030.email.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/030.email.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; - Optional validation for Email ID - Cell display as clickable link -## Create field +## Create an `Email` 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. @@ -23,7 +23,7 @@ import TabItem from '@theme/TabItem'; - 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 +## 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) diff --git a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/040.phonenumber.md b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/040.phonenumber.md index 188ac6e3b3..394bdc71a2 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/040.phonenumber.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/040.phonenumber.md @@ -6,7 +6,7 @@ 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 +## Create a `Phone number` 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. @@ -21,7 +21,7 @@ import TabItem from '@theme/TabItem'; - 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 +## 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) diff --git a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/050.url.md b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/050.url.md index 1d0d9e36b0..b74a676928 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/050.url.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/010.text-based/050.url.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; - Optional validation for URL - Cell display as clickable link -## Create field +## Create an `URL` 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. @@ -24,7 +24,7 @@ import TabItem from '@theme/TabItem'; - Validation only ensures that the value entered is a valid URL. It does not check if the URL exists. ::: -### Similar text based fields +## 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) diff --git a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/010.number.md b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/010.number.md index d453496a31..81da06c512 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/010.number.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/010.number.md @@ -6,7 +6,7 @@ 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 +## Create a number 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. @@ -19,3 +19,9 @@ import TabItem from '@theme/TabItem'; - This field type can hold both positive and negative numbers. - Supported range (JavaScript): -9007199254740991 to 9007199254740991 ::: + +## Similar numerical fields +Following are the other numerical fields available in NocoDB, with some custom add-on features. +- [Decimal](020.decimal.md) +- [Percent](030.percent.md) +- [Currency](040.currency.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/020.decimal.md b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/020.decimal.md index 3f260571b8..ecb1260afa 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/020.decimal.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/020.decimal.md @@ -6,7 +6,7 @@ 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 a decimal 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. @@ -19,3 +19,9 @@ import TabItem from '@theme/TabItem'; :::info - Default decimal precision is 1 digit ::: + +## Similar numerical fields +Following are the other numerical fields available in NocoDB, with some custom add-on features. +- [Number](010.number.md) +- [Percent](030.percent.md) +- [Currency](040.currency.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.percent.md b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.percent.md index 25d1ddcb74..e08b44162d 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.percent.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/030.percent.md @@ -6,11 +6,17 @@ import TabItem from '@theme/TabItem'; `Percent` field type is used to store percentage values. Use cases include storing `discount`, `tax`, etc. -## Create field +## Create a percent 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) \ No newline at end of file +![image](/img/v2/fields/percent.png) + +## Similar numerical fields +Following are the other numerical fields available in NocoDB, with some custom add-on features. +- [Number](010.number.md) +- [Decimal](020.decimal.md) +- [Currency](040.currency.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/040.currency.md b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/040.currency.md new file mode 100644 index 0000000000..a7b913ade0 --- /dev/null +++ b/packages/noco-docs/docs/060.fields/030.field-types/020.numerical/040.currency.md @@ -0,0 +1,72 @@ +--- +title: 'Currency' +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +`Currency` field type is used to store currency values. It is a numerical field with additional provision to set the currency symbol in display. + +## 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 `Currency` from the dropdown. +4. Configure `Currency Locale` : defaults to `en-US` +5. Configure `Currency Symbol` : defaults to `$` +6. [**Optional**] Set default value for the field. +7. Click on `Save Column` button. + +![image](/img/v2/fields/currency.png) + +### Cell display +![image](/img/v2/fields/currency-cell-display.png) + +### Supported locales +https://www.npmjs.com/package/locale-codes#locale-list + +:::note +NocoDB adheres to ISO639-1 standard for locale codes. +::: + +### Supported currencies + +| | | | | | | +|-----|-----|-----|-----|-----|-----| +| AED | AFN | ALL | AMD | ANG | AOA | +| ARS | AUD | AWG | AZN | BAM | BBD | +| BDT | BGN | BHD | BIF | BMD | BND | +| BOB | BOV | BRL | BSD | BTN | BWP | +| BYR | BZD | CAD | CDF | CHE | CHF | +| CHW | CLF | CLP | CNY | COP | COU | +| CRC | CUP | CVE | CYP | CZK | DJF | +| DKK | DOP | DZD | EEK | EGP | ERN | +| ETB | EUR | FJD | FKP | GBP | GEL | +| GHC | GIP | GMD | GNF | GTQ | GYD | +| HKD | HNL | HRK | HTG | HUF | IDR | +| ILS | INR | IQD | IRR | ISK | JMD | +| JOD | JPY | KES | KGS | KHR | KMF | +| KPW | KRW | KWD | KYD | KZT | LAK | +| LBP | LKR | LRD | LSL | LTL | LVL | +| LYD | MAD | MDL | MGA | MKD | MMK | +| MNT | MOP | MRO | MTL | MUR | MVR | +| MWK | MXN | MXV | MYR | MZN | NAD | +| NGN | NIO | NOK | NPR | NZD | OMR | +| PAB | PEN | PGK | PHP | PKR | PLN | +| PYG | QAR | ROL | RON | RSD | RUB | +| RWF | SAR | SBD | SCR | SDD | SEK | +| SGD | SHP | SIT | SKK | SLL | SOS | +| SRD | STD | SYP | SZL | THB | TJS | +| TMM | TND | TOP | TRY | TTD | TWD | +| TZS | UAH | UGX | USD | USN | USS | +| UYU | UZS | VEB | VND | VUV | WST | +| XAF | XAG | XAU | XBA | XBB | XBC | +| XBD | XCD | XDR | XFO | XFU | XOF | +| XPD | XPF | XPT | XTS | XXX | YER | +| ZAR | ZMK | ZWD | | | | + + + +## Similar numerical fields +Following are the other numerical fields available in NocoDB, with some custom add-on features. +- [Number](010.number.md) +- [Decimal](020.decimal.md) +- [Percent](030.percent.md) diff --git a/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/010.single-select.md b/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/010.single-select.md index 10988d8d45..df13898099 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/010.single-select.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/010.single-select.md @@ -6,7 +6,7 @@ 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 +## Create a single select 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. @@ -44,4 +44,7 @@ You can delete options by clicking on the `x` icon next to the option. You can u - 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) \ No newline at end of file +![image](/img/v2/fields/single-select-delete.png) + +## Similar select based fields +- [Multi select](020.multi-select.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/020.multi-select.md b/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/020.multi-select.md index 1846f402d6..4c49311786 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/020.multi-select.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/030.select-based/020.multi-select.md @@ -6,7 +6,7 @@ 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 +## Create a multi select 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. @@ -45,3 +45,6 @@ You can delete options by clicking on the `x` icon next to the option. You can u ![image](/img/v2/fields/single-select-delete.png) +## Similar select based fields +- [Single select](010.single-select.md) + diff --git a/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md b/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md index cb371d78a6..7cb78285f4 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/010.links.md @@ -19,16 +19,68 @@ NocoDB supports following types of relations: - For every `Has-Many` relation defined, NocoDB augments `Belongs-to` relationship column in the adjacent table automatically ::: -## Create field +## Create a link 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. +5. Select the table to which the relation is to be established with. +6. [**Optional**] Configure label to be used for display in the cell. Defaults to `Link`, `Links`. 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. \ No newline at end of file +The cell will display number of links for a record to the related table. + +![image](/img/v2/fields/links-cell-display.png) + +Clicking on the link-text will open a `Linked Records` modal with the list of links & associated additional information. + +### List linked records + +![image](/img/v2/fields/linked-records-modal.png) + +A brief note about the modal components: +1. This modal is displaying linked records for `PENELOPE` +2. Icon represents `Many-to-Many` relation +3. Linked records belong to `Film` table +4. Search bar, to narrow down the list of linked records displayed +5. List (cards) of linked records +6. To view additional information (expanded record), hover on the card & click on the `<>` icon +7. Indicates total records linked +8. Pagination bar +9. Click on `+ Link more Records` button to add new links : [Read more](#link-new-records) + +### Link new records + +Modal to add new links can be opened by +- Clicking on `+ Link more Records` button in the `Linked Records` modal +- Clicking on the `+` icon in the cell (appears on clicking on the cell) + +![image](/img/v2/fields/add-link-modal.png) + +A brief note about the modal components: +1. Links being created are for `PENELOPE` +2. Icon represents `Many-to-Many` relation +3. Linked records belong to `Film` table +4. Search bar, to narrow down the list of records displayed +5. Linked record card is displayed in blue color +6. Records available for link are displayed in white color; use expand icon on the cord to view additional information +7. Indicates total records linked (including the ones being linked) +8. Pagination bar + +:::info +Multiple records can be linked at once. +::: + +### Unlink records +To unlink a record, open the `Linked Records` modal & click on the card of the record to be unlinked. + +:::info +Multiple records can be unlinked at once. +::: + +### Related fields +- [Lookup](020.lookup.md) +- [Rollup](030.rollup.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/020.lookup.md b/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/020.lookup.md index 6cb4fae9d0..ef4cdf7641 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/020.lookup.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/020.lookup.md @@ -4,4 +4,20 @@ title: 'LookUp' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -![image](/img/v2/fields/lookup.png) \ No newline at end of file +`Lookup` fields help bring additional column information from related table into the current table. This is useful when you want to display additional information about a record in a table. For example, if you have a table of `Orders` and a table of `Customers`, you can use a `Lookup` field to display the customer's name and address in the `Orders` table. + +## Create a Lookup 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 `Lookup` from the dropdown. +4. Select the link column from the dropdown. This is the column that links the current table to the related table. +5. Select the column for display from the dropdown. This is the column that will be displayed in the current table. +6. Click on `Save Column` button. + +![image](/img/v2/fields/lookup.png) + +## Similar links-based fields +- [Links](010.links.md) +- [Rollup](030.rollup.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/030.rollup.md b/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/030.rollup.md index a73a509204..2fcdb72fba 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/030.rollup.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/040.links-based/030.rollup.md @@ -4,4 +4,30 @@ title: 'Rollup' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -![image](/img/v2/fields/rollup.png) \ No newline at end of file +`Rollup` fields are used to aggregate data from fields in the related table. Often used to calculate totals, averages, and other aggregate data. + +## Create a Rollup 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 `Lookup` from the dropdown. +4. Select the link column from the dropdown. This is the column that links the current table to the related table. +5. Select the column for display from the dropdown. This is the column that will be displayed in the current table. +6. Select the aggregation function from the dropdown. This is the function that will be used to aggregate the data. +7. Click on `Save Column` button. + +![image](/img/v2/fields/rollup.png) + +### Aggregation Functions +NocoDB supports the following aggregation functions: +- Count +- Minimum +- Maximum +- Average +- Sum +- Count Distinct +- Sum Distinct +- Average Distinct + +## Similar links-based fields +- [Links](010.links.md) +- [Lookup](020.lookup.md) \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/010.attachment.md b/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/010.attachment.md index 385e1591f1..0cd95f2738 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/010.attachment.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/010.attachment.md @@ -4,3 +4,52 @@ title: 'Attachment' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +`Attachment` fields allow you to upload files to your records. You can upload any file type, and the file will be linked to the record. You can also upload multiple files to a single `Attachment` field record. + +## Create an Attachment 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 `Attachment` from the dropdown. +4. Click on `Save Column` button. + +![image](/img/v2/fields/attachment.png) + +### Cell display +The cell display for `Attachment` field is either a clickable preview if file is an image in recognizable format or a file-type icon. +![image](/img/v2/fields/attachment-cell.png) + +### Upload files +To upload files to an `Attachment` field, +- Click on the `+` icon in the cell, choose the file to upload and click on `Upload` button. OR +- Drag drop the file to the cell. OR +- Click on expand icon `<>`, choose the file to upload or drag-drop file; click on `Upload` button. + +## Expand modal +Expand modal for `Attachment` field displays the list of files uploaded to the field. You can also upload files from the expand modal. To access expand modal, click on the expand icon `<>` in the cell. + +![image](/img/v2/fields/attachment-expand.png) + +Expand modal supports the following actions: + +### Attach file(s) +- Click on `Attach file(s)` button <1> +- Choose the file(s) to upload + +### Delete file +- Click on `x` icon <2> to the top left of the image card to delete the file + +### Download file +- Click on `Download` button <5> to download the file + +### Bulk Download file(s) +- Select the files by clicking on the checkbox <3> to the top left of the image card +- Click on `Bulk Download` button <4> to download the selected files + +### Rename file +- Click on `Rename` button <5> to rename the file +- Enter the new name in the input field +- Click on `Rename` button to save the new name + +:::note +Rename file only renames the file in NocoDB display (expand record & tool tip on hover). It does not rename the file in the storage. +::: \ No newline at end of file diff --git a/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/020.checkbox.md b/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/020.checkbox.md index 75b5914010..b1b9e8342f 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/020.checkbox.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/020.checkbox.md @@ -4,4 +4,27 @@ title: 'Checkbox' import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -! \ No newline at end of file +The checkbox field type is used to store boolean values. It can be used to store a simple yes/no value, or true/false, or any other boolean value. + +## Create a checkbox 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 `Checkbox` from the dropdown. +4. [**Optional**] Select icon for the field; defaults to `check` icon. +5. [**Optional**] Select color for the field; defaults to `grey`. +6. [**Optional**] Set default value for the field. +7. Click on `Save Column` button. + +![image](/img/v2/fields/checkbox.png) + +### Cell display +Cell displays the icon in the color selected for the field. A true value will be represented by a checked icon or a filled icon +![image](/img/v2/fields/attachment-cell-display.png) + +### Supported icons +NocoDB supports the following icons for the checkbox field type. +![image](/img/v2/fields/checkbox-icon.png) + +## Related fields +- [Rating](030.rating.md) + diff --git a/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/030.rating.md b/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/030.rating.md index 5e60fcacee..dcaf1dfb5e 100644 --- a/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/030.rating.md +++ b/packages/noco-docs/docs/060.fields/030.field-types/050.custom-types/030.rating.md @@ -2,4 +2,29 @@ title: 'Rating' --- import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; \ No newline at end of file +import TabItem from '@theme/TabItem'; + +The + +## Create a checkbox 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 `Rating` from the dropdown. +4. [**Optional**] Select icon for the field; defaults to `star` icon. +5. [**Optional**] Configure max count for the field; defaults to `5`. +6. [**Optional**] Select color for the field; defaults to `grey`. +7. [**Optional**] Set default value for the field. +8. Click on `Save Column` button. + +![image](/img/v2/fields/rating.png) + +### Cell display +Cell displays the ratings in the color & icon selected for the field. +![image](/img/v2/fields/rating-cell.png) + +### Supported icons +NocoDB supports the following icons for the rating field type. +![image](/img/v2/fields/rating-icon.png) + +## Related fields +- [Checkbox](020.checkbox.md) \ No newline at end of file diff --git a/packages/noco-docs/static/img/v2/fields/add-link-modal.png b/packages/noco-docs/static/img/v2/fields/add-link-modal.png new file mode 100644 index 0000000000..eed317543b Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/add-link-modal.png differ diff --git a/packages/noco-docs/static/img/v2/fields/attachment-cell-display.png b/packages/noco-docs/static/img/v2/fields/attachment-cell-display.png new file mode 100644 index 0000000000..801d391e63 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/attachment-cell-display.png differ diff --git a/packages/noco-docs/static/img/v2/fields/attachment-cell.png b/packages/noco-docs/static/img/v2/fields/attachment-cell.png new file mode 100644 index 0000000000..ed7c6e68a2 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/attachment-cell.png differ diff --git a/packages/noco-docs/static/img/v2/fields/attachment-expand.png b/packages/noco-docs/static/img/v2/fields/attachment-expand.png new file mode 100644 index 0000000000..7d39aa05db Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/attachment-expand.png differ diff --git a/packages/noco-docs/static/img/v2/fields/attachment.png b/packages/noco-docs/static/img/v2/fields/attachment.png new file mode 100644 index 0000000000..39316001fc Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/attachment.png differ diff --git a/packages/noco-docs/static/img/v2/fields/checkbox-icon.png b/packages/noco-docs/static/img/v2/fields/checkbox-icon.png new file mode 100644 index 0000000000..181bf72035 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/checkbox-icon.png differ diff --git a/packages/noco-docs/static/img/v2/fields/checkbox.png b/packages/noco-docs/static/img/v2/fields/checkbox.png new file mode 100644 index 0000000000..74a46319e8 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/checkbox.png differ diff --git a/packages/noco-docs/static/img/v2/fields/currency-cell-display.png b/packages/noco-docs/static/img/v2/fields/currency-cell-display.png new file mode 100644 index 0000000000..dc019c6961 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/currency-cell-display.png differ diff --git a/packages/noco-docs/static/img/v2/fields/linked-records-modal.png b/packages/noco-docs/static/img/v2/fields/linked-records-modal.png new file mode 100644 index 0000000000..0098abdb09 Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/linked-records-modal.png differ diff --git a/packages/noco-docs/static/img/v2/fields/links-cell-display.png b/packages/noco-docs/static/img/v2/fields/links-cell-display.png new file mode 100644 index 0000000000..a41c73d62f Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/links-cell-display.png differ diff --git a/packages/noco-docs/static/img/v2/fields/rating-cell.png b/packages/noco-docs/static/img/v2/fields/rating-cell.png new file mode 100644 index 0000000000..06bb2c1d8c Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/rating-cell.png differ diff --git a/packages/noco-docs/static/img/v2/fields/rating-icon.png b/packages/noco-docs/static/img/v2/fields/rating-icon.png new file mode 100644 index 0000000000..6e5c40a1dc Binary files /dev/null and b/packages/noco-docs/static/img/v2/fields/rating-icon.png differ