Skip to main content

Pages

A page is one screen in your app. It has a route, a title, and a type. The type decides how Buildiq renders it, so it is the first choice you make.

The four you will use most​

TypeUse it for
dashboardAn overview assembled from widgets.
indexA list of records from one schema.
detailA single record, in full.
customA screen whose component you supply.

The other nine​

form · settings · logs · chat · files · map · roadmap · search · wiki

Each one is a narrower job. Pick one when it is exactly your screen. Pick custom when none of them is, because custom means you write the component yourself and maintain it.

What a page declares​

FieldWhat it does
idThe page's name, referenced by menu entries and deep links.
routeThe path, for example /applications.
typeOne of the thirteen above.
titleWhat the user reads at the top.
permissionWho may open it.
widgetsThe blocks in the body. See Widgets.
actionsThe controls in the header. See Actions.
sidebarWhether the page shows a sidebar. See Sidebars.
primaryActionThe one prominent button.
configType-specific settings, for example which schema an index lists.
slotsNamed insertion points for your own components.
componentFor custom only, the component to mount.

headerComponent, actionsComponent and sidebarComponent let you replace one region of a page with your own component while the rest stays declarative.

Templates and instances​

Two fields exist for repetition. A pageTemplate declares a page shape once with params. A pageInstance points at that template with templateRef and fills in the register, schema and label. Use them when the same page shape repeats across several schemas, so a change lands in one place.

Where a page lives​

Pages are entries in your app's manifest under pages. Buildiq's page designer edits those entries.

Next: give your page something to show. See Widgets.