feat: more docs

This commit is contained in:
Stevan Freeborn
2023-04-13 09:27:38 -05:00
parent 0b9ebcb71c
commit fd18398baa
3 changed files with 126 additions and 40 deletions
+40 -34
View File
@@ -14,40 +14,46 @@ function TreeNode({ doc }: { doc: Doc }) {
return ( return (
<li className={styles.listItem}> <li className={styles.listItem}>
{hasChildren ? ( {hasChildren ? (
<div <div className={styles.expandable}>
onClick={() => setIsExpanded(!isExpanded)} <a
className={styles.expandable} href={`#${doc.title
> .replaceAll(' ', '-')
<a className={styles.link}>{doc.title}</a> .toLowerCase()}`}
{isExpanded ? ( className={styles.link}
<svg >
xmlns="http://www.w3.org/2000/svg" {doc.title}
width="16" </a>
height="16" <div onClick={() => setIsExpanded(!isExpanded)}>
fill="currentColor" {isExpanded ? (
className={styles.chevron} <svg
viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"
> width="16"
<path height="16"
fillRule="evenodd" fill="currentColor"
d="M7.646 4.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1-.708.708L8 5.707l-5.646 5.647a.5.5 0 0 1-.708-.708l6-6z" className={styles.chevron}
/> viewBox="0 0 16 16"
</svg> >
) : ( <path
<svg fillRule="evenodd"
xmlns="http://www.w3.org/2000/svg" d="M7.646 4.646a.5.5 0 0 1 .708 0l6 6a.5.5 0 0 1-.708.708L8 5.707l-5.646 5.647a.5.5 0 0 1-.708-.708l6-6z"
width="16" />
height="16" </svg>
fill="currentColor" ) : (
className={styles.chevron} <svg
viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"
> width="16"
<path height="16"
fillRule="evenodd" fill="currentColor"
d="M1.646 4.646a.5.5 0 0 1 .708 0L8 10.293l5.646-5.647a.5.5 0 0 1 .708.708l-6 6a.5.5 0 0 1-.708 0l-6-6a.5.5 0 0 1 0-.708z" className={styles.chevron}
/> viewBox="0 0 16 16"
</svg> >
)} <path
fillRule="evenodd"
d="M1.646 4.646a.5.5 0 0 1 .708 0L8 10.293l5.646-5.647a.5.5 0 0 1 .708.708l-6 6a.5.5 0 0 1-.708 0l-6-6a.5.5 0 0 1 0-.708z"
/>
</svg>
)}
</div>
</div> </div>
) : ( ) : (
<a <a
@@ -13,19 +13,19 @@ These are objects representing a content record in your instance. You can create
--- ---
- App Id - App Id
- integer - number
- The id of the app or survey. - The id of the app or survey.
--- ---
- recordId - recordId
- integer - number
- The id of the record. - The id of the record.
--- ---
- fieldData - fieldData
- array - object[]
- An array of field value objects. - An array of [Field Value](#field-values) objects.
{% /table %} {% /table %}
@@ -1,6 +1,6 @@
# Field Values {% #field-values %} # Field Values {% #field-values %}
These are objects representing a field value in a record. They will comprise the `fieldData` array in a [Record](#records) object. These are objects representing a field value in a record. They will comprise the `fieldData` array in a [Record](#records) object. The `type` property will determine what the type and structure of the `value` property will be.
## Field Value Properties ## Field Value Properties
@@ -19,7 +19,7 @@ These are objects representing a field value in a record. They will comprise the
--- ---
- fieldId - fieldId
- integer - number
- The id of the field. - The id of the field.
--- ---
@@ -29,3 +29,83 @@ These are objects representing a field value in a record. They will comprise the
- The value of the field. - The value of the field.
{% /table %} {% /table %}
### Field Value Types
{% table .propertiesTable %}
- Type
- Description
- Value Data Type
---
- String
- A string value.
- `string`
---
- Integer
- An integer value.
- `number`
---
- Decimal
- A decimal value.
- `number`
---
- Date
- A date value.
- `string`
---
- TimeSpan
- A time span value.
- `string`
---
- Guid
- A GUID value.
- `string`
---
- StringList
- A list of string values.
- `string[]`
---
- IntegerList
- A list of integer values.
- `number[]`
---
- GuidList
- A list of GUID values.
- `string[]`
---
- AttachmentList
- A list of [Attachment](#attachment) values.
- `object[]`
---
- ScoringGroupList
- A list of [Scoring Group](#scoring-group) values.
- `object[]`
---
- FileList
- A list of file values.
- `number[]`