Home Schema Example JSON Schema

Table Settings

Type: object

Schema for configuring the look and feel of a table.

 No Additional Properties

root title

Title

Type: string

Title of the table for display to the user. Will be passed through i18n.

Must be at least 1 characters long

root defaultSortField

Default sort field

Type: string

This is used to decide the default sorting for the result set.

Must be at least 1 characters long

root orderDesc

Order descending

Type: boolean

Result is order in descending order based on the default sort field is set to true.

root columns

Columns

Type: array of object

Settings for each column in the table. This is an ordered array of columns from left to right.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root columns columns items
Type: object
No Additional Properties

root columns columns items id

ID

Type: string

Column unique identifier. This is used for sorting purposes.

Must be at least 1 characters long

root columns columns items header

Header

Type: string or object

The column header for display. Will be passed through i18n if its a string, if it is an object it will be rendered based on the component property (ie. component "TableSectionHeader, TableSubSectionHeader", componentProps "title, subtitle").

root columns columns items is_required

Is Required

Type: boolean

Boolean flag indicating if this column is required.

root columns columns items accessor

Accessor

Type: string

Accessor value to use to retrieve the data

Must be at least 1 characters long

root columns columns items sticky

Sticky

Type: enum (of string)

Make column sticky either to left or right

Must be one of:

  • "left"
  • "right"

root columns columns items bgColor

Background color

Type: string

background color of the column

Must be at least 3 characters long

root columns columns items subColumns

Sub columns

Type: array of object

Define child columns within a header column. The properties of this column are similar to its parent

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root columns columns items subColumns subColumns items
Type: object

Additional Properties of any type are allowed.

root columns columns items subColumns subColumns items additionalProperties
Type: object

root columns columns items component

Component

Type: enum (of string)

The component to render. Defaults to Text.

Must be one of:

  • "Text"
  • "Link"
  • "Alert"
  • "Comment"
  • "BGTableCell"
  • "Badge"
  • "Status"

root columns columns items width

Width

Type: string

Width of the column. Defaults to browser math.

Must be at least 1 characters long

root columns columns items style

Style

Type: object

Styling props to pass to the component.

Additional Properties of any type are allowed.

root columns columns items style additionalProperties
Type: object

root columns columns items disableSortBy

Disable Sort By

Type: boolean

Make this column un-sortable. Defaults to false.

root columns columns items data

Data

Type: object

Describes how data is being formatted and rendered to the user.

 No Additional Properties

root columns columns items data valueTemplate

Value Template

Type: string

Template string (include ${x} variables) to define how cells are rendered.

For a list of substitutable variables, refer to the corresponding Jarvis Chernobyl Provider settings.

root columns columns items data hrefTemplate

Href Template

Type: string

Template string for href of Link component. The same variables set as valueTemplate is supported.