Side panel

Show/Hide content without a modal screen

A side panel is a special container that slides in from the right hand side when opened.

You can put any components or blocks that you wish inside a side panel, however it is particularly well suited to form entry.

Side panel with nested form block

Side panel with nested form block

App preview of a side panel

App preview of a side panel

Opening a side panel

Side panels are opened via the Open Side Panel Action. This could be triggered from a button click, or some other event such as on change.

You can choose to open any side panel that is anywhere in the screen component tree.

Closing a side panel

A side panel can be closed by a user simply clicking an area outside of the panel, or by clicking the close arrow.

Close side panel

Close side panel

Alternatively, the Close Side Panel action can be used.

No screen needs to be selected as this action will automatically close any currently open side panel.

πŸ‘

Table block

The Table block supports built-in side panels for quickly viewing row detail or creating new entries.

App state & Side panel

When using the side panel you may want to create/update App state for use by a component nested within. An example of this would be; the Form / Form Block components, app state can be passed into these. The aim of this is to prevent users from jumping between pages and providing a more enriched interactive experience.

Additionally you can use the side panel as an area which contains additional information of the selected item.

Example

Form usage

  1. Add the table component with a related data provider (for this I will be using the inbuilt test data).
  2. Add the side panel component.
  3. Within the table component ON ROW CLICK add 2 different actions: Update state and Open side panel
    On row click button within the table component
  4. Add a key name, I've used selectedRow and updated the value with {{ Clicked row._id }}.
    Setting up table click for side panel.
  5. Add a Form / Form Block for this example I will be using the Form Block
  6. Change the form to update/read only, then add the selectedRow app state to the Row ID

A similar approach to the above can be done for simply displaying additional information.

Follow the previous steps until Step 5. (Please ensure the side panel along with the newly created data provider are nested within the parent data provider.) From here we are going to add a Data provider and nested within that a Repeater. From here click on your newly created Data provider, then click Define Filters

Add a filter which uses the parent Data provider (limits the outgoing requests). Start building out your side panel area to include additional content you wish to show on click.

Gif showing the end result of the above.


What’s Next