Modules

Warning

Modules are only available with Skuid on Salesforce.

Modules are an organizational feature that allows builders to group related pages. Modules act similar to a folder, however, instead of physically dragging and dropping a page into a folder, a builder will select which pages they want to include in a module and metadata is added to those pages, assigning it to the module.

Modules also give builders a way to include Skuid pages in an AppExchange package that extends Skuid.

Note

It is possible to use modules to include custom code by prepending the static resource name with the name of the module–for example, a Maps module would connect to MapsJS.resource–but the recommended best practice is Static Resources.

Creating a Module [[]]

  1. In Salesforce, navigate to Create > Objects.
  2. Click the Page label.
  3. In the Custom Fields & Relationships section, in the field label column, find and click Module.
  4. In the Values section, click New.
  5. Enter the desired module name.
  6. Click Save.

Note

Skuid relies on naming conventions, based on the name of your module, for automatically locating StaticResource files related to your module. If you’re developing a managed AppExchange package, your module name must correspond to your package’s namespace, e.g. if your namespace is AcmeRecruiting1, your module name should also be AcmeRecruiting1.

Using modules to build Page Packs [[]]

You can create page packs from a module by using the Package Pages in Module(s) option in the page list.

  1. From the Skuid navigation bar, click Compose > All Pages.
  2. Click on the dropdown arrow next to Create New Page.
  3. Select fa-suitcase Package Pages in Module(s).
  4. Select the module to build a page pack from.
  5. Click fa-suitcase Package.

(ISVs Only) Using Module Pages in Customer Orgs [[]]

Note

This section applies only to ISV’s intending to include their Skuid pages in a managed package that extends Skuid.

Because extension packages cannot add additional picklist Values to a picklist owned by a base package, you’ll need to manually add in your module’s name as a picklist value in whatever org the package is installed into. For ISV’s using Trialforce, all you have to do is to add your module name as a picklist value in your Trialforce template.