Skip to content

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 ​

PropertyTypeMeaning
name requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
labellabelA label in Bahasa Indonesia (required) and optionally English.
label.id requiredstring
label.enstring
extendsstring
default "rangka/side-only"
shelltop-nav · side-only · pos · portal
default "side-only"
homestringStart page, e.g. dashboard:crm_overview
pattern ^(dashboard|model|page):[a-z][a-z0-9_]*$
navobject
nav.toplist of object
at most 6
nav.top[].to requiredstring
pattern ^(dashboard|model|page|settings|url):.+$
nav.top[].labellabelA label in Bahasa Indonesia (required) and optionally English.
nav.top[].label.id requiredstring
nav.top[].label.enstring
nav.top[].iconstring
nav.top[].ifCELA CEL expression (plus Rangka helpers)
nav.sidelist of object
nav.side[].grouplabelA label in Bahasa Indonesia (required) and optionally English.
nav.side[].group.id requiredstring
nav.side[].group.enstring
nav.side[].items requiredlist of object or object
nav.side[].collapsedbooleanStarting state of the group (contract 0037)
nav.createlist of stringModels offered by the blue Buat button
nav.app_switcherboolean
default true
responsiveobjectDesk shells per width (contract 0038); breakpoints come from the design tokens
responsive.tabletrail · sidebar · drawer768-1023px; default rail
responsive.phonedrawer · tabsbelow 768px; default drawer
responsive.tabslist of objectphone: tabs only; a last Menu tab opens the drawer
at least 2, at most 5
responsive.tabs[].to requiredstring
pattern ^(dashboard|model|page|settings|url):.+$
responsive.tabs[].labellabelA label in Bahasa Indonesia (required) and optionally English.
responsive.tabs[].label.id requiredstring
responsive.tabs[].label.enstring
responsive.tabs[].iconstring
responsive.tabs[].ifCELA CEL expression (plus Rangka helpers)
pageslist of object
pages[].name requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
pages[].label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
pages[].label.id requiredstring
pages[].label.enstring
pages[].iconstring
pages[].roleslist of name
pages[].blocks requiredlist of object
at least 1
pages[].blocks[].block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
pages[].blocks[].spaninteger
min 1, max 12
pages[].blocks[].propsobjectProps of the UI block, e.g.
pages[].blocks[].childrenlist of object
pages[].blocks[].children[].block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
pages[].blocks[].children[].spaninteger
min 1, max 12
pages[].blocks[].children[].propsobjectProps of the UI block, e.g.
pages[].blocks[].children[].childrenlist of object
pages[].blocks[].children[].ifCELA CEL expression (plus Rangka helpers)
pages[].blocks[].ifCELA CEL expression (plus Rangka helpers)
PropertyTypeMeaning
to requiredstring
pattern ^(dashboard|model|page|settings|url):.+$
labellabelA label in Bahasa Indonesia (required) and optionally English.
label.id requiredstring
label.enstring
iconstring
ifCELA CEL expression (plus Rangka helpers)

block ​

PropertyTypeMeaning
block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
spaninteger
min 1, max 12
propsobjectProps of the UI block, e.g.
childrenlist of object
children[].block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
children[].spaninteger
min 1, max 12
children[].propsobjectProps of the UI block, e.g.
children[].childrenlist of object
children[].children[].block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
children[].children[].spaninteger
min 1, max 12
children[].children[].propsobjectProps of the UI block, e.g.
children[].children[].childrenlist of object
children[].children[].ifCELA CEL expression (plus Rangka helpers)
children[].ifCELA CEL expression (plus Rangka helpers)
ifCELA CEL expression (plus Rangka helpers)

page ​

PropertyTypeMeaning
name requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
label.id requiredstring
label.enstring
iconstring
roleslist of name
blocks requiredlist of object
at least 1
blocks[].block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
blocks[].spaninteger
min 1, max 12
blocks[].propsobjectProps of the UI block, e.g.
blocks[].childrenlist of object
blocks[].children[].block requiredpage_header · list · board · form · dashboard · number · chart · table · markdown · filter_bar · tabs · columns · empty_state · embed
blocks[].children[].spaninteger
min 1, max 12
blocks[].children[].propsobjectProps of the UI block, e.g.
blocks[].children[].childrenlist of object
blocks[].children[].ifCELA CEL expression (plus Rangka helpers)
blocks[].ifCELA 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.

Rangka OS is source-available under the Elastic License 2.0 (ELv2). Free to self-host.