layout.rk
Layer 6: the app shell and pages built from UI blocks. Templates: side-only (Frappe-style sidebar, default), top-nav, pos (full-screen counter), portal (customers).
Lives in <site>/layouts/<name>.rk · Schema layout.json (source) · first line: # yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/layout.json
Properties
| Property | Type | Meaning |
|---|---|---|
name required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
label | label | A label in Bahasa Indonesia (required) and optionally English. |
label.id required | string | |
label.en | string | |
extends | string | default "rangka/side-only" |
shell | top-nav · side-only · pos · portal | default "side-only" |
home | string | Start page, e.g. dashboard:crm_overview pattern ^(dashboard|model|page):[a-z][a-z0-9_]*$ |
nav | object | |
nav.top | list of object | at most 6 |
nav.top[].to required | string | pattern ^(dashboard|model|page|settings|url):.+$ |
nav.top[].label | label | A label in Bahasa Indonesia (required) and optionally English. |
nav.top[].label.id required | string | |
nav.top[].label.en | string | |
nav.top[].icon | string | |
nav.top[].if | CEL | A CEL expression (plus Rangka helpers) |
nav.side | list of object | |
nav.side[].group | label | A label in Bahasa Indonesia (required) and optionally English. |
nav.side[].group.id required | string | |
nav.side[].group.en | string | |
nav.side[].items required | list of object or object | |
nav.side[].collapsed | boolean | Starting state of the group (contract 0037) |
nav.create | list of string | Models offered by the blue Buat button |
nav.app_switcher | boolean | default true |
responsive | object | Desk shells per width (contract 0038); breakpoints come from the design tokens |
responsive.tablet | rail · sidebar · drawer | 768-1023px; default rail |
responsive.phone | drawer · tabs | below 768px; default drawer |
responsive.tabs | list of object | phone: tabs only; a last Menu tab opens the drawer at least 2, at most 5 |
responsive.tabs[].to required | string | pattern ^(dashboard|model|page|settings|url):.+$ |
responsive.tabs[].label | label | A label in Bahasa Indonesia (required) and optionally English. |
responsive.tabs[].label.id required | string | |
responsive.tabs[].label.en | string | |
responsive.tabs[].icon | string | |
responsive.tabs[].if | CEL | A CEL expression (plus Rangka helpers) |
pages | list of object | |
pages[].name required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
pages[].label required | label | A label in Bahasa Indonesia (required) and optionally English. |
pages[].label.id required | string | |
pages[].label.en | string | |
pages[].icon | string | |
pages[].roles | list of name | |
pages[].blocks required | list of object | at least 1 |
pages[].blocks[].block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
pages[].blocks[].span | integer | min 1, max 12 |
pages[].blocks[].props | object | Props of the UI block, e.g. |
pages[].blocks[].children | list of object | |
pages[].blocks[].children[].block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
pages[].blocks[].children[].span | integer | min 1, max 12 |
pages[].blocks[].children[].props | object | Props of the UI block, e.g. |
pages[].blocks[].children[].children | list of object | |
pages[].blocks[].children[].if | CEL | A CEL expression (plus Rangka helpers) |
pages[].blocks[].if | CEL | A CEL expression (plus Rangka helpers) |
link
| Property | Type | Meaning |
|---|---|---|
to required | string | pattern ^(dashboard|model|page|settings|url):.+$ |
label | label | A label in Bahasa Indonesia (required) and optionally English. |
label.id required | string | |
label.en | string | |
icon | string | |
if | CEL | A CEL expression (plus Rangka helpers) |
block
| Property | Type | Meaning |
|---|---|---|
block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
span | integer | min 1, max 12 |
props | object | Props of the UI block, e.g. |
children | list of object | |
children[].block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
children[].span | integer | min 1, max 12 |
children[].props | object | Props of the UI block, e.g. |
children[].children | list of object | |
children[].children[].block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
children[].children[].span | integer | min 1, max 12 |
children[].children[].props | object | Props of the UI block, e.g. |
children[].children[].children | list of object | |
children[].children[].if | CEL | A CEL expression (plus Rangka helpers) |
children[].if | CEL | A CEL expression (plus Rangka helpers) |
if | CEL | A CEL expression (plus Rangka helpers) |
page
| Property | Type | Meaning |
|---|---|---|
name required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
label required | label | A label in Bahasa Indonesia (required) and optionally English. |
label.id required | string | |
label.en | string | |
icon | string | |
roles | list of name | |
blocks required | list of object | at least 1 |
blocks[].block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
blocks[].span | integer | min 1, max 12 |
blocks[].props | object | Props of the UI block, e.g. |
blocks[].children | list of object | |
blocks[].children[].block required | page_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed | |
blocks[].children[].span | integer | min 1, max 12 |
blocks[].children[].props | object | Props of the UI block, e.g. |
blocks[].children[].children | list of object | |
blocks[].children[].if | CEL | A CEL expression (plus Rangka helpers) |
blocks[].if | CEL | A CEL expression (plus Rangka helpers) |
Example
From rangka-apps/examples/sites/kopi-senja/layouts/crm_first.rk (first 60 lines):
yaml
# yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/layout.json
name: crm_first
label: {id: CRM dulu}
extends: rangka/top-nav
shell: top-nav
home: dashboard:crm_overview
nav:
top:
- {to: 'dashboard:crm_overview', label: {id: Dasbor}}
- {to: 'model:deal', label: {id: Peluang}}
- {to: 'model:sales_invoice', label: {id: Faktur}, if: "app_installed('invoicing')"}
create: [deal, lead, sales_invoice]
app_switcher: true
pages:
- name: pagi_ini
label: {id: Pagi ini}
icon: time
blocks:
- {block: page_header, props: {title: Pagi ini}}
- block: columns
children:
- {block: number, span: 4, props: {dashboard: crm_overview, widget: pipeline}}
- {block: list, span: 8, props: {dashboard: crm_overview, widget: activities_due}}Generated from the schema by website/scripts/gen-reference.mjs. Edit the schema, not this page.