Pages

A page is a free-form container. Unlike a view, which is bound to a single object, a page combines multiple components, embeds views, and manages local state — your home screens, custom record layouts, and utility panels.

const homePage = {
  name: 'sales_home',
  label: 'Sales Home',
  type: 'home',
  regions: [
    { name: 'header', width: 'full', components: [
      { type: 'metric_card', id: 'total_revenue', label: 'Total Revenue',
        properties: { object: 'opportunity', field: 'amount', aggregate: 'sum', format: 'currency' } },
    ]},
    { name: 'main', width: 'large', components: [
      { type: 'list_view', id: 'recent_deals', label: 'Recent Deals',
        properties: { object: 'opportunity', view: 'recent_open', limit: 10 } },
    ]},
  ],
}

Page properties

Page types

Only these five types are valid — earlier roadmap types that never shipped a renderer were removed from the schema.

Regions

Regions are the layout zones; each holds components:

regions: [
  { name: 'sidebar', width: 'small', components: [/* … */] },
  { name: 'content', width: 'large', components: [/* … */] },
]

width accepts 'small', 'medium', 'large', or 'full'.

Components

Components are the building blocks inside regions:

{
  type: 'chart',
  id: 'revenue_chart',
  label: 'Revenue Trend',
  properties: { chartType: 'line', object: 'opportunity',
                categoryField: 'close_date', valueField: 'amount' },
  events: { onClick: "navigate_to('opportunity_detail', { id: $event.id })" },
  visibility: "os.user.profile == 'sales_manager'",
}

The standard, namespaced component types:

Components may also carry dataSource (per-element object binding for multi-object pages), responsive, and aria configuration. Custom string types are accepted for project-specific widgets.

Variables

Pages hold local state shared across components:

variables: [
  { name: 'selected_tab', type: 'string', defaultValue: 'overview' },
  { name: 'date_range',   type: 'object', defaultValue: { start: null, end: null } },
]

type accepts 'string' (default), 'number', 'boolean', 'object', 'array', or 'record_id'.

A record-type page is the supported path for bespoke record layouts — reach for it when the roles-derived detail page (see Forms) isn't enough. Compose record:highlights in a full-width header, record:details and record:activity in a sidebar, and record:related_list components in the main region.

Surface a page from an app with a page navigation entry, or make it the app's landing page via homePageId.

Doc pages

A doc is a page of package documentation: plain Markdown files in a flat src/docs/ directory, compiled into the package artifact and rendered in the console at /docs/<name>. Docs also ground the AI assistant when it answers questions about your package.

src/docs/
  crm_index.md            → doc name "crm_index"
  crm_user_guide.md       → doc name "crm_user_guide"

The filename stem becomes the doc name — no directory taxonomy, no ordering file. The flat layout keeps cross-references stable: links resolve by basename, never by path.

Doc resolution is package-scoped: two installed packages may each ship a doc with the same bare name and coexist — neither overwrites the other.

For dynamic content — a live flow diagram, a record table — don't try to embed a component. Link to the metadata by URL; the platform renders the live view, the doc just points at it.

Where to go next