ILayoutVariable
Interface representing a layout variable. These can be used
anywhere in the layout, and the values will be interpolated
into the layout before rendering. All $ref values will be
resolved before interpolation.
Properties
| Property | Type | Notes |
|---|---|---|
| "boolean" | "color" | "date" | "datetime" | "number" | "string" | "time" | "url" |
The type of the variable. Used to generate a json & ui schemas allowing values to be provided by the user, during a "Create from..." operation. |
|
| RefOrValue |
The value of the variable. This can be a string, number, boolean, date, datetime, time, color, or url. If the value is a reference, it will be resolved before interpolation |
|
| Optional | string |
A description of the variable. This is used to provide a hint to the user when they are entering a value for the variable. |
Interface defined in packages/common/src/layouts/layout-shared-types.ts:143