Create a Custom Dashboard Widget

Contentstack allows you to create dashboard widgets for your stack’s dashboard.

To create a dashboard widget, log in to your Contentstack account, and perform the following steps:

  1. Go to your stack, navigate to the “Settings” gear icon, and select Extensions.
  2. On the Extensions page, click on the + Add Extension button, and select Create new. If you have not added any extensions in the stack yet, click on the create a new one link as shown below.
  3. In the Select Extension Type window, select Dashboard Widget.
    select dashboard widget
  4. In the Create New Extension page,enter values in the fields as given below:
    • Title: Provide a suitable title for your custom dashboard widget. This title will be visible as a widget name on the main dashboard page.
    • Default width: Choose the width of the custom dashboard widget. Select either Half Width or Full Width as per your requirement.

      Tip: The height is configurable through the Extensions SDK. You can also define if the user can toggle between Half Width and Full Width in the SDK.

    • Hosting method: Select how you want to host the widget:
      • External Hosting: Select this option for externally hosted widgets. You need to provide the URL in the External hosting URL field that appears below.
      • Hosted on Contentstack: Select this option if you can write the code in the Extension source code field that appears below.
    • Config Parameter: If you have used any config parameters (such as access token) in the source code, specify the value of the parameters in this field.
    • Enable dashboard widget: Check this option to make the Dashboard Widget enabled for all users of the stack on the main Dashboard page.

      Tip: Using the “Settings” gear icon on the Dashboard page, the users can show or hide the widget on their Dashboard.

  5. Finally, click on Save.

Testing Dashboard Widget Extension

When you create your dashboard widget extension to integrate with Contentstack, you can follow the steps given below to test the extension and verify if the extension is working fine before releasing it.

To test the extension, first, clone the extension repo that you have built and install the dependencies. Then, edit the HTML, CSS, and JS files from the source folder.

To install the required dependencies, run the following command in the root folder.

npm install gulp-cli -g
npm install

To create a new build for the extension, run the following command (index.html):

gulp build

To update/test the extension while developing, run the following command:

gulp watch

Now, create a server using the Lite Server npm module. Before that, install the Lite Server module by using the following command:

npm install -g lite-server

Then, run the lite-server — in the root folder — by using the following command:

lite-server

After running the above command, you will get the following screen:

Local_server.png

Make note of the port no in Access URLs (the localhost URL).

Next, we need to install ngrok to build secure tunnels from a public endpoint (that is the internet) to a locally running server. Issue the following command to install ngrok:

npm install ngrok -g
ngrok http <<port number>>
ngrok_hosting.png

Once you run the above command, you will get a URL. Now create an extension by navigating to your stack and selecting Settings > + Add Extension > Create new.

On the Select Extensions Type screen, select Dashboard Widget and then add the required details on the Create New Dashboard screen.

In the Hosting method field, select External hosting and paste the above URL in this field. Now save your extension and check the dashboard where you have added your extension.

You should see your updated changes.

API Reference

Here are the links to the API requests related to this action:

Was this article helpful?

Thanks for your feedbackSmile-icon

More articles in "Get Started With Dashboard Widgets"

On This Page

top-arrow