In This Section
- Concepts
- Data
- Build
- Style
- Deploy
- Extend
- Skuid Developer Resources
- Skuid and JavaScript
- Skuid and Apex
- Create a Skuid Custom Component
- Dynamic Creation of Models and Components
- CI/CD with Skuid
- Event Handling Between Custom Lightning Components and Skuid
- Automated Testing
- Reference
- API Reference
- skuid.$
- skuid.actions
- skuid.ajax
- skuid.builder.core
- skuid.builder.core.coreProps
- skuid.calendar
- skuid.collaboration
- skuid.component
- skuid.componentType
- skuid.events
- skuid.formula
- skuid.hotkeys
- skuid.label
- skuid.load
- skuid.model
- skuid.model.Model
- skuid.mustache
- skuid.page
- skuid.sfdc
- skuid.snippet
- skuid.time
- skuid.ui
- skuid.utils
- skuid.version
- Component-Specific APIs
- Skuid Model Metadata Object
- Skuid Model Child Relationship Metadata Object
- Skuid Model Condition Metadata Object
- Skuid Model Field Metadata Object
- Skuid Model Record Type Metadata Object
- Page XML API
- skuid-sfdx
- Skuid Metadata Object Reference
- Skuid Glossary
- Formula and Function Reference
- Open Source Software Attributions
- API Reference
- Site Administration
- Tutorials
- Skuid Page Tutorials
- Add Related Lists with the Table Component
- Build an Activities Related List Tab
- Build a Custom “Create New Record” Page
- Build a Custom Detail Page
- Build a Custom List Page
- Compose a Branded Header and Navigation
- Compose a One-Page App Using Tab Actions and Conditional Rendering
- Conditionally Display Fields
- Create a Custom Clone Page
- Create a Custom “Clone Account” page
- Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
- Mass Create Records
- Show Products in an Opportunity Page
- Skuid Pages for standard Salesforce CRM
- Salesforce Tutorials
- Add Product Line Items to Opportunities with a Popup
- Add Gmail to Salesforce functionality in your email fields
- Create a Custom Edit Page and Set Visualforce Overrides
- Getting Help: Grant Skuid Login Rights to your Org
- Reclaim the Salesforce Home Page
- Redirect to Salesforce Processes
- Skuid for Sales: A Turn-Key Template to Augment Lightning Sales Cloud
- JavaScript Tutorials
- Skuid Page Tutorials
- Legal terms and conditions
- Skuid for Salesforce Evaluation Guide
In This Topic
Visual Navigation¶
Visual navigation actions manage the what the user sees in the browser:
- showing and hiding popups, sliding panels, and components
- sending the user to a specific URL or Skuid page (Skuid Platform only)
- blocking the UI to show messages to the user and unblocking the UI
Close all Popups¶
Closes all open popups.
Close topmost Popup¶
Closes only the topmost—or most recently opened—popup. (Handy for popups within popups.)
Show Popup¶
Displays the popup.
- Configure Popup: Opens popup configuration window, where you build the new popup.
Show message and block UI¶
Blocks the UI and displays a message. Commonly used to notify user about page updates or to prevent the user from interrupting any impending actions.
Message: The text for the message, for example, “Loading…”
Timeout (seconds): Limits how long the UI is blocked.
0.5-10: Increments of seconds until the UI is unblocked.
Never: The UI is never unblocked unless an Unblock the UI action occurs.
Warning
Only use the Never timeout option when there is also an Unblock the UI action later in the script.
Unblock the UI¶
Unblocks the UI once the actions between this and Show message and block UI have completed.
Go to URL¶
Sends the user to another web page, which can be a Skuid page or an external website.
URL: The URL to send a user to.
- A URL
- An ID field for a Salesforce Object
- A page parameter
Open URL in:
Current Window:
If using the button within an iFrame, opens the URL in the current iFrame.
Note
Other content blocks on the page remain the same.
If not using the button within an iFrame, opens the URL in the current window.
Blank Window: Opens the URL in a new tab.
Parent Window: Opens the URL in the current window, whether or not the button is within an iFrame.
When working with Skuid Lightning components:
- Choose Current Window to redirect only the contents of the Skuid Lightning component.
- Choose Parent Window to redirect the entire page.
Skuid on Salesforce [[]]¶
To redirect to the standard Salesforce version of the Skuid page you are on, input the following merge syntax: /{{Model.KeyPrefix}}/o?nooverride=1
.
When working with Skuid Lightning components, for Open URL in property:
- Choose Current Window to redirect only the contents of the Skuid Lightning component.
- Choose Parent Window to redirect the entire page.
Encoding URLs [[]]¶
Ensure that characters within the URLs are URL-encoded where necessary. Some characters can break URLs in certain situations, so they may require the use of their percent-encoded equivalents. This can be especially important when dealing with URL parameters, merge syntax, or using them in tandem.
For example, use this:
https://example.skuidsite.com/app/page?who_id={{ContactId}}&retURL=skuid__ui%3Fpage%3DPage%26id%3D{{Another.Id}}
Not this:
https://example.skuidsite.com/app/page?who_id={{ContactId}}&retURL=skuid__ui?page=Page&id={{Another.Id}}
If you’re more JavaScript-savvy, consider using the encodeURI() or the encodeURIComponent()functions where appropriate.
Go to Skuid Page¶
Note
This action is only available in Skuid Platform.
When Skuid loads a web browser, it must first load all of the backend code to support the page. Using this action, that code stays loaded in the browser while only the Skuid page itself is replaced, resulting in better load times.
Navigation Type:
Skuid Page: Links to a specific Skuid page, regardless of route.
Note
This links to a preview of the specified Skuid page.
Route: Links to a specific route.
Skuid Page or Skuid Route: The page or route name. (Start typing and Skuid autopopulates the field.)
Open Sliding Panel¶
This opens (or toggles) the sliding panel for this specific action.
Note
To keep this panel open, uncheck Close When User Clicks Outside Of Panel in the sliding panel properties.
Configure Panel: Opens the panel configuration window. For more information about building sliding panels, see the sliding panels topic.
Behavior:
Open: The button displays the panel.
Note
If Open is selected, and the action script containing this action occurs again, the sliding panel is not closed. To toggle the panel open and closed, select Toggle as the behavior.
Toggle: The button hides or shows the panel, depending on whether the panel is already showing on the page.
Close Sliding Panel¶
Closes one or all open sliding panels, depending on the selected behavior.
- Behavior:
- Close all: The button closes all open panels.
- Close topmost: The button closes the topmost panel only.
Toggle Component¶
A button with this action hides or shows selected components.
Behavior:
- Toggle: The button hides or shows the component, depending on whether the component is already showing on the page.
- Show: The button displays a hidden component.
- Hide: The button hides a displayed component.
Component: Select which component toggle. Components are listed by their type and unique ID. When a component is selected, a flashing yellow outline indicates the chosen component within the canvas.
Note
Each component’s unique ID is viewable under its Advanced properties tab.