Important

This feature is currently in Early Availability (EA) status. For more information, see our product lifecycle phases.

Create a new extension

This guide walks you through creating and configuring an extension. Extensions let you add new features, customize pages, or override existing pages to match your needs.

Before you begin, ensure the following:

• You have a marketplace account with the Marketplace Manager role.
• The toolkit is installed. If not, follow the installation instructions.

The steps below create a new extension in the marketplace and set it up with the toolkit. You can update the configuration later if needed.

Step 1. Create a new extension in the marketplace

1. Log in to the marketplace using your credentials.

2. Once logged in, navigate to the /admin/extensions section within the marketplace dashboard.

3. Locate the "Create an extension" button at the top-right corner of the page and click on it to proceed.

4. You are taken to the "Create Extensions" form. You can change any of this information later.

5. Enter a unique, descriptive name for the extension and the path where the extension will be stored.

6. Determine the extension type that best suits your needs. There are three options:

   a. Unlinked Page: A page accessible within the marketplace but not connected to a specific menu.

   b. Linked Page: Creates a new menu item accessible through the marketplace's navigation menus.

7. If you opt for a Linked Page, you will need to select the appropriate menu (secondary or tertiary) and provide a label for the extension. The new extension will only appear in the marketplace once it's published and enabled.

8. Establish the access role for the extension to control user accessibility:

   a. Everyone: Accessible to all users, including those who are logged out.

   b. Logged-in users: Accessible only to users who are logged in to the marketplace.

   c. Specific roles: Accessible exclusively to users with assigned roles.

9. Customize the page layout, if necessary. While it's generally recommended to keep the default platform layout, you can remove the header/footer or modify the background color to suit your needs.

10. After completing these steps, click "Save" to create the new extension.

Step 2. Create a new extension using the UI Toolkit

With the extension now configured, the following steps will guide you through linking the extension to actual code using the UI Toolkit:

1. On the /admin/extensions page, locate your newly created extension in the table. It should be the first entry in the list.
2. Hover over the info icon under the Status column. A tooltip will pop up.
3. Copy the command from the tooltip (use the copy button or copy it manually). The command will look like the following, with your extension's values:

   sfb-toolkit create-extension <extension-name> <marketplace-domain> <extension-path>

4. Open a command-line window (terminal or command prompt).
5. Navigate to the workspace folder you created with the UI Toolkit's setup command.
6. Execute the command that you copied earlier.
7. cd to your extension's directory, which should be found under extensions/<my-extension-name>.
8. Run npm install to install the extension's dependencies. This may take a few moments.
9. When the command completes, your extension is ready.

Next, you can run your extension locally and upload your extension.