Pages

Page
A container for panes. A specific page can be referenced in a URL via the hash fragment.

In this document we will cover the following:

  1. How to create a page
  2. How to navigate to a page
  3. How to edit a page
  4. How to add children to a page
  5. How to create parameterized pages
  6. How to interact with pages programmatically
  7. How to delete a page

Create a page

  1. Click the plus button next to the list of pages in the toolbar Add page
  2. Fill in the name of the page and hit Apply
    Create page

Navigate to page

  1. Click on the name of the page you wish to navigate to Navigate to page

Edit page

  1. Click on the pencil icon of the page you wish to edit Edit page

Adding children to page

  1. Click on the plus button of the page you wish to add children to Add child
  2. Save the children by clicking Apply
    Save child

Parameterized pages

  1. Edit the page you’d like to make parameterized
  2. Toggle the ‘Parameter’ field to true and fill in the default value for the parameter Page Params
  3. Hit Apply

Note

The default value for the parameter will be used when navigating to the page

Programmatic interaction

The portal provides an interface via the CB_PORTAL object for interacting with pages from within a parser, widget, or datasource.

Selecting a page programmatically

CB_PORTAL.selectPage("/states/TX/city/Austin")

Example use case:

  1. User selects a state from a list of states so the portal should navigate to a new page

Retrieving the current path parameters

CB_PORTAL.getPathParams() // will return {"state": "TX", "city": "Austin"} if the current path is "/states/TX/city/Austin"

Example use case:

  1. The current page changes so the portal should display data that is relevant to the URL parameters
  2. The portal needs to load the correct state on initial startup when the URL is “/states/TX/city/Austin”

Delete page

  1. Click on the trash icon of the page you wish to delete Delete page
  2. Confirm deletion when prompted