docs: add list value section to value 1

This commit is contained in:
Stevan Freeborn
2023-04-23 17:50:23 -05:00
parent f7611e58e2
commit f0fd67d61e
3 changed files with 64 additions and 0 deletions
+6
View File
@@ -95,6 +95,12 @@ export const versionOne: DocsStructure = {
copy: 'copy.md', copy: 'copy.md',
example: 'example.md', example: 'example.md',
}, },
{
title: 'List Values',
folder: 'list_values',
copy: 'copy.md',
example: 'example.md',
},
], ],
}, },
], ],
@@ -0,0 +1,43 @@
# List Values {% #list-values %}
These are objects that represent the defined values of a [List Field](#list-field) or a [Formula Field](#formula-field) with a `List Value` output type.
## List Value Properties
{% table %}
- Property Name
- Data Type
- Description
---
- Id
- `string`
- The unique id of the list value.
---
- Name
- `string`
- The name of the list value.
---
- SortOrder
- `number`
- The sort order of the list value.
---
- NumericValue
- `number`
- The numeric value of the list value.
---
- Color
- `string`
- The color of the list value.
{% /table %}
@@ -0,0 +1,15 @@
# The List Value Object
{% code heading="LIST VALUE" defaultLanguage="json" %}
```json
{
"Id": "b235afb2-b786-4c87-bce9-fbd700e246c1",
"Name": "list_value_1",
"SortOrder": 1,
"NumericValue": 1,
"Color": "#6dcff6"
}
```
{% /code %}