Skip to content

App: shared shapes

Shapes that many keys take, listed once here: a message that may be translated, a link target and a component declaration. A key that takes one says = <name>. Every key here is stable (status). All parts.

Key Type Status What it does
&lt;appTarget>.app string Stable
Key Type Status What it does
&lt;appTarget>.key object Stable Used in examples/apps/lintel/jobs.ts.
&lt;appTarget>.key.*.column string Stable Used in examples/apps/lintel/app.ts.
Key Type Status What it does
&lt;appTarget>.kind "home" · "view" · "record" Stable One of home, record, view. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;appTarget>.resource string Stable
Key Type Status What it does
&lt;appTarget>.tenant object Stable
&lt;appTarget>.tenant.kind "choose" · "platform" Stable One of choose, platform. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;appTarget>.tenant[kind=tenant].id string | integer | object Stable
&lt;appTarget>.tenant[kind=tenant].id.column string Stable Used in examples/apps/lintel/app.ts.
&lt;appTarget>.tenant[kind=tenant].kind Stable One of tenant. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;appTarget>.view string Stable Used in examples/apps/lintel/app.ts.
Key Type Status What it does
&lt;appTarget>[kind=home].key Stable Used in examples/apps/lintel/jobs.ts.
Key Type Status What it does
&lt;appTarget>[kind=home].kind Stable One of home. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;appTarget>[kind=home].resource Stable
Key Type Status What it does
&lt;appTarget>[kind=home].view Stable Used in examples/apps/lintel/app.ts.
Key Type Status What it does
&lt;appTarget>[kind=record].kind Stable One of record. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;appTarget>[kind=record].view Stable Used in examples/apps/lintel/app.ts.
Key Type Status What it does
&lt;appTarget>[kind=view].key Stable Used in examples/apps/lintel/jobs.ts.
Key Type Status What it does
&lt;appTarget>[kind=view].kind Stable One of view. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;appTarget>[kind=view].resource Stable
Key Type Status What it does
&lt;component>.id string Stable
Key Type Status What it does
&lt;component>.kind "section" · "value" · "input" · "list" · "page" Stable section (default): a custom section. value: a value renderer. input: a form field’s control. list: a list view’s rows. A free-form page is a file of its own (pages/<path>.page.tsx, definePage), not a component. One of input, list, page, section, value. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;component>.module string Stable A path inside the App directory, written from it: ‘./widgets/Thing.tsx’.
Key Type Status What it does
&lt;component>.props object Stable
&lt;component>.props.*[type=boolean].default boolean Stable
&lt;component>.props.*[type=boolean].type Stable One of boolean. Used in examples/apps/lintel/blueprint.ts.
&lt;component>.props.*[type=choice].default string Stable
&lt;component>.props.*[type=choice].options array Stable
&lt;component>.props.*[type=choice].type Stable One of choice. Used in examples/apps/lintel/blueprint.ts.
&lt;component>.props.*[type=number].default number Stable
&lt;component>.props.*[type=number].max number Stable Used in examples/apps/lintel/commands/ledger.ts.
&lt;component>.props.*[type=number].min number Stable Used in examples/apps/lintel/commands/ledger.ts.
&lt;component>.props.*[type=number].type Stable One of number. Used in examples/apps/lintel/blueprint.ts.
&lt;component>.props.*[type=text].default string Stable
&lt;component>.props.*[type=text].max integer Stable Used in examples/apps/lintel/commands/ledger.ts.
&lt;component>.props.*[type=text].type Stable One of text. Used in examples/apps/lintel/blueprint.ts.
Key Type Status What it does
&lt;presentationCopy>.args object Stable Each ICU argument’s column path: { “title”: “thread_id.title” }.
Key Type Status What it does
&lt;presentationCopy>.message string Stable Used in examples/apps/lintel/commands/leasing.ts.