Page Include

Simple but powerful, the Page Include component pulls in another (separate) Skuid page into the current Skuid page. While it is a more complex component, the Page Include component unlocks a lot of potential, especially for larger applications:

  • Improve runtime for complex pages by loading specific elements (components and models) only when they are needed.
  • “Componentize” elements of your Skuid apps into separate pages, allowing them to be reused across different parts of the app.
  • More easily configure different parts of a Skuid app: instead of having to burrow into a component’s action script to access a modal or sliding panel and then make changes to it, turn those elements into separate pages and add them to the current page using the Page Include component.

Using the Page Include Component

Note

Page Includes are not “place holders” for pages to be created later. Any pages referenced by a Page Include must be created before adding the Page Include component to the current page.

Once you have decided which additional Skuid page to include in the Skuid page you are currently building:

  • Drag and drop the Page Include component into the page.
    • Select whether to use the Page Include to call a Skuid Page or a Page Assignment and configure the appropriate properties.

Warning

Ensure any pages included through this component use the same Design System. If not, the pages may have inconsistent theming and styles.

Properties

Basic Tab [[]]

  • Type: (Skuid on Salesforce only) Select the type of Page Include.

    • Skuid Page: The Page Include points to a specific Skuid page.
      • Skuid Page: The name of the Skuid page.
      • Query String (optional): The URL parameters to send along with the Page Include request. Values must be URL-encoded and multiple parameters are joined with an ampersand (&). (Accepts merge syntax.)

    Note

    This property is useful to set filterable conditions within the page include or pass data to model conditions. For example, two options to pass a record ID from a “parent” Skuid page to the page within this component:

  • Use URL parameters via merge syntax: id={{$Param.Id}}

  • Use model values through merge syntax: id={{$Model.[modelnameof parent].data.0.Id}}&whatid={{$Model.[modelname].data.0.AccountId}}

  • Page Assignment: (Skuid on Salesforce only) Instead of pointing to a page, the Page Includes points to a Skuid page assignment.

    • Object Type: The Salesforce object attached to the page assignment
    • Action Type: The Salesforce action overridden by the page assignment:
      • Tab
      • List
      • View
      • Edit
      • New
      • Clone

Advanced Tab [[]]

  • Unique Id (optional): Skuid automatically generates an alphanumeric Id for the component; if preferred, give it a practical name.

    Note

    A unique name will make it easier to locate the Page Include for later use.

  • Show Loading Indicator: if checked, a loading indicator (Loading…) will display when a page include is being updated or retrieving records.

Rendering tab [[]]

Conditional rendering allows you to display or hide the Button Set component, based on defined data conditions.

Troubleshooting

Debugging query strings [[]]

When working with Page Include components, you may need to verify query strings or debug the component in other various ways. Use Chrome Developer Tools (specifically the Network tab):

  1. Open Developer Tools by right clicking the page and selecting Inspect, or using the hot keys (Windows: Ctrl + Shift + I) (Mac: Cmd + Opt + I).
  2. Click the Network tab.
  3. Click the XHR filter.
  4. Look for the request that begins with include?isinclude=true.

The customized parameters from the Query String field (or page assignment parameters if you selected that option) appear here prepended by an ampersand (&). Check the parameters that are sent to the Page Include to find a solution to any issues.