Create a Skuid Module

Creating a Skuid Module allows you to do 2 things:

  • Include your Skuid pages in an AppExchange package that extends Skuid
  • Create and use custom Skuid components

You don’t need to have an AppExchange package to create and use custom components, but you do still need to create a Module.

Choose a Module name

The first step is to choose a Module name.

  • 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.

  • If you’re developing a set of custom Skuid components, ensure that your module name matches the JavaScript files used to create the component. For example a Maps module would be connected to the MapsJS.resource and MapsBuildersJS.resource files.

    Note

    Component packs are the recommended method for installing custom components.

Register your Module with Skuid

Next, you’ll need to add your Module name as one of the options in the Skuid Page object’s Module picklist field:

In Salesforce Setup:

  1. Navigate to Setup > Create > Objects.
  2. Click the label for the Page object.
  3. Click the Module field label.
  4. Under the Values pane, click New.
  5. Enter the module’s name.
  6. Click Save.

(ISV’s Only) Using Your Module’s 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 (not ideal, we know, but we’re working on an alternate way). For ISV’s using Trialforce, all you have to do is to add your Module name as a picklist value in your Trialforce template.