Sliding Panels¶
Similar to Skuid modals, sliding panels are hidden containers for Skuid components that can appear from any of the four sides of the screen. They are useful for optional information, hidden menus, or sidebars on mobile. You can integrate them into your page using the Action Framework.
Note
Sliding panels will not function in pages with the Salesforce® header or Salesforce sidebar enabled. If you are working within Skuid SFX, you must disable both of them to use sliding panels within your page.
Using Sliding Panels¶
Sliding panels are generally used to give additional/optional information related to the action the end user is currently taking. They can be added to a Skuid page through an Action Framework action such as Open Sliding Panel.
After adding the action, click the Configure Panel button in the properties pane to begin configuring the sliding panel for that particular action.
Sliding panels can be set everywhere the Action Framework is available, and every Toggle Sliding Panel or Open Sliding Panel action will create a unique sliding panel for that action. This means you can have multiple sliding panels appear at one time, all of which are uniquely configured for whatever action activates them.
Note
The Close Sliding Panels action will close all sliding panels, regardless of their origin.
Creating a sliding panel: a use case¶
One of the most common use cases for a sliding panel is a mobile-friendly menu within a navigation component. Let’s create one within a Skuid page to illustrate sliding panel concepts and properties.
Navigate to an existing Skuid page or create a new one.
Drag a navigation component into the canvas.
Click Add Nav Item, then click the newly-created Navigation Item.
Set its fields:
- Label: Menu
- Icon: Select an appropriate icon.
Click the Actions tab.
Click Add action.
Set the Action type to Open Sliding Panel.
Set Behavior to Open.
Click Configure panel.
Much like configuring Skuid modals, you will now see a Skuid window containing a separate canvas. Here you may configure the properties for your sliding panel, as well as drag and drop components into its canvas.
For this example:
- Set your sliding panel properties:
- Origin: Left
- Close when User Clicks Outside of Panel: Checked
- Width: 200px
- Drag a Header component into the sliding panel canvas.
- Set the Header component’s fields:
- Title: Menu
- Subtitle: Mobile
- Close the Sliding Panel configuration window.
- Click Save.
- Click Preview.
While within the Skuid page, click the navigation item you’ve configured above to open the sliding panel you’ve configured. Click anywhere on the page to close the panel.
This is a simple example, but you can use this model as a basis for a variety of use cases:
- Listing a full set of navigation items within a mobile-friendly menu. (Bonus points if it’s within a principal page’s header!)
- Adding related information to a record page using merge syntax.
- Placing advanced page operations within an “experts-only” panel.
Experiment with different sliding panel properties and components to create useful additions to your Skuid apps.
Properties¶
(Just need to look up a property? Try going directly to the Property Library.)
Component properties¶
General tab [[]]¶
Origin: This determines which part of the screen the sliding panel will slide in from. There are four selectable options:
- Left
- Right
- Top
- Bottom
Slide Style: This property determines how a sliding panel will enter the screen. There are three options:
Overlay: The sliding panel overlays the page content.
Reveal: Main page content slides to the side to reveal the panel underneath—the opposite of overlay.
Push: Main content and panel are figuratively side-by-side, and the two slide over to show the panel.
Warning
Skuid allows builders to add multiple sliding panes to a page–and have more than one panel open at a time. It is possible to configure those panels to have different origins and slide styles.
However, mixing multiple pages, origin options, and style styles on a single page can result in unexpected behaviors (especially with Push and Reveal Slide style). For this reason, building a page where users can Reveal or Push two panels at the same time is not recommended.
Close when user clicks outside of panel: Check this box to have the sliding panel close if the end user clicks anywhere outside of the sliding panel. If this box is unchecked, users may still interact with all other Skuid components while the sliding panel is open.
Width: Sets the fixed width of the sliding panel. Accepts all standard Skuid sizing measurements.
Display errors: Display errors will show either “On page” or “In sliding panel”. This controls where the errors will show allowing the end user to better understand the action they need to take.
Styles tab [[]]¶
Global styles for this component are set in the Design System Studio. The following Style properties can be adjusted for an individual page.
Style variant: Style variants are created and set in the Design System Studio. Some components have pre-defined variants for a specific aspect of a component’s style. Also, Skuid builders can style and customize elements to create their own themes within the DSS. These themes will dynamically populate as selectable values in the Style Variant dropdown menu.
Note
To refresh available style variant options, click
Refresh style variants.This is useful for when changes to the design system (like style variants or variable options) have been made in another browser window or by another user.
Interactions tab [[]]¶
Click
Add interaction then select:- Action type: To initialize the display of the record details, choose the interaction:
- Click: Best for desktop, as well as mobile.
- Right-click: The right-click interaction will launch the actions added here. A common pattern is to create a customized context menu by using the Show/hide menu action.
- Disable the browser’s default menu?: Override the browser’s context menu for the Skuid page, component, or element. If the browser’s context menu is not disabled, then the actions will run while the browser’s context menu appears on screen.
In the
More Options menu on the selected interaction, click Add action, then edit the Action Type:- Action Type: Use the Action Framework to launch actions.
After-close actions tab [[]]¶
Set actions that will occur once the modal is closed.
Click
Add action, then select:- Action Type: Use the Action Framework to launch actions.