Skip to main content
Version: 3.0.0-LTS

Pages

Pages allow you to have multiple pages in a single application, making your ToolJet applications easier to navigate and more user-friendly.

Multi-page app

Pages Panel​

You can open the Pages Panel by clicking on the Pages icon on the left sidebar of the app-builder.

Pages Panel

Panel Options​

Add Page​

  • On the header of the Pages Panel, you'll find a + button to add more pages to your application.
  • Click the + button to add a new page.
  • Enter the name for the new page and press enter.
Pages Panel

Settings​

  • You can use the settings option to customize the page navigation sidebar for your app.
  • Click on the settings button and a new panel will open on the right.

Properties Tab​

  • Collapsable: This option allows you to make the page navigation sidebar collapsible.
  • Style: Choose whether you want to display Text only, Text + icon, or Icon only on the page navigation sidebar.
  • Hide page menu in viewer mode: This option lets you hide the page navigation sidebar in viewer mode.
Pages Panel

Style Tab​

  • You can use the style tab to customize the page navigation sidebar.
Pages Panel

Pin​

  • By default, the panel will close when you click outside the panel. You can pin the Pages panel from the Pin button and the panel won't close until you unpin it.
Pages Panel

Page Options​

There are several options available for a Page. To use these options, click on the kebab menu on the right of the page card.

Pages Panel

Page Handle​

Page Handle is the slug that is added at the end of the application URL. By default, the page handle is the name of the page in lowercase and with spaces replaced by hyphens. You can change the page handle by clicking on the Edit symbol next to the page handle.

Rename​

Rename option will allow you to rename the page. Renaming a page will not change the slug/page handle.

Mark Home​

Mark home option can be used to make a page the default landing page of the application. When you open the application, the page marked as home will be the first page that you see.

Hide Page on app menu​

Hide Page option can be used to hide a page from the page navigation sidebar in viewer mode. You can go to the options again and unhide the app from the page navigation sidebar. Page marked as home cannot be hidden.
Note: After hiding a page, although the page may not appear in the pages navigation sidebar, it can still be accessed by utilizing either the switch page Action or the page URL.

Pages Panel

Duplicate​

The duplicate page option allows you to create and add a copy of the page in the pages list. The duplicated page will be an exact replica of the original page.

Event Handlers​

Like other ToolJet components, pages can also be attached to event handlers. For pages, the On page load event is available. You can use all the available actions for this event, along with the new actions added specifically for Pages.

Disable Page​

Disable Page Option can be used to disable a page. A disabled page won't be accessible in the viewer mode.
Note: Page marked as home can't be disabled.

Delete Page​

You can delete a page from an application using this option.
Note: Page marked as home cannot be deleted.

Exposed variables​

VariableDescription
handleThe handle represents the slug of the page within an app. In the URL https://app.tooljet.com/applications/crm2/home, crm2 refers to the app name, and home corresponds to the handle. The handle is automatically set when a page is added, and you can also rename the handle from the Page options. To access the value of the handle variable dynamically, use {{page.handle}}
nameThe name indicates the name of the page set during its creation. To access the value of the name variable dynamically, use {{page.name}}
idEach page in the ToolJet app receives a unique identifier upon creation. To access the value of the id dynamically, use {{page.id}}
variablesVariables is an object that contains all the variables created for a specific page using the Set Page Variable action. The value of a specific variable can be accessed dynamically using {{page.variables.<pageVariableName>}}, where <pageVariableName> refers to the variable created for that page using the Set Page variable action.