npmpackage.info

Gathering detailed insights and metrics for @contentstack/ui-extensions-sdk

@contentstack/ui-extensions-sdk

The function of Contentstack's UI can be extended by adding custom widgets and fields through extensions. The following Extensions SDK gives an overview of different custom extensions for you to add to the Contentstack app.

2.2.3

MIT

HTML

508,678 4.9

Installations

npm install @contentstack/ui-extensions-sdk

Pull Requests

Open

18

Total

50

Closed

21

Merged

11

Issues

Open

4

Total

7

Closed

3

Releases

v2.2.3

2.2.3

Published on 21 Aug 2023

v2.2.2

2.2.2-2

Published on 18 Aug 2023

v2.2.1

2.2.1

Published on 28 Jul 2022

2.2.0 Extension SDK Enhancement

2.2.0

Published on 24 Apr 2020

View all 4 releases

Developer

contentstack

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

16.20.2

NPM Version

8.19.4 Statistics

21 Stars

111 Commits

12 Forks

13 Watching

25 Branches

35 Contributors

Updated on 22 Oct 2024

Languages

HTML (83.72%)

JavaScript (12.83%)

CSS (3.45%)

Total Downloads

Cumulative downloads

Total Downloads

508,678

Last day

-32%

298

Compared to previous day

Last week

1.7%

2,103

Compared to previous week

Last month

10.9%

8,264

Compared to previous month

Last year

-21.3%

149,823

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Contentstack Extensions SDK

The Extensions SDK allows you to extend Contentstack’s UI by helping you create Custom Fields, Custom Widgets, and Dashboard Widgets.

Custom Fields enable users to introduce simpler interface controls, such as color picker, code editor, video selector, and more, or maybe complex micro web applications such as Shopify or Snipkart. Because of their dissociated nature, custom fields can be reused multiple times.

Custom Widgets are like micro content-processing apps that help you analyze the entry content and provide recommendations. Some of the useful widgets you can create using this type of extension are text intelligence, SEO recommendations, language translation, grammar checker and more.

Dashboard Widgets let you add powerful widgets to the stack’s dashboard that let users do more from a centralized location. Some examples of this type of extension include personal notes, recently published content, notification centre, and stack usage summary.

This SDK overview document introduces you to the concept of custom extensions.

Getting started

Include the compiled version of the extension client library by adding the following line to your application.

1<script
2    src="https://unpkg.com/@contentstack/ui-extensions-sdk@2.2.3/dist/ui-extension-sdk.js"
3    integrity="sha512-LMktiFAj7j/AUFctMlgY8qmLrLIQVctwwCsnCXIWnvgF9JlanilvFbZxOCtPNB5eO3vp2Nhw9ED1UsWa+ltSvQ=="
4    crossorigin="anonymous"
5></script>

Extensions examples

Custom Fields

Some of the examples of custom field extensions are:

Color Picker - Displays a native color picker polyfill that allows users to select color as input value and saves the color code in the backend
Ace Editor - Displays a code editor written in JavaScript, allowing you to edit HTML, PHP, JavaScript and more easily
JSON Editor - Displays a simple editor that lets you view, edit and format JSON code within the field of your content type
Key-value Field - Lets you add key-value as input value of a field of your content type
Progress Bar - Allows users to set value of a field by sliding the progress bar to the left or right
Star Ratings - Lets you provide rating by choosing number of stars
Brightcove - Lets you fetch and display your Brightcove videos into a field of your content type.
Shopify - Lets you load products of your Shopify store into the field of your content type.
Egnyte - Allows you to fetch files of your Egnyte account and display them into a field of your content type.
Ooyala - Lets you fetch and display your Ooyala videos into a field of your content type.
Optimizely - Lets you serve personalized content by allowing you to select the audience for each entry.
Youtube - Lets you fetch and display your Youtube videos into a field of your content type.
External API Lookup - Lets you fetch data from an external API and display the data as possible values for the field on an entry page in Contentstack.

Custom Widgets

Some of the examples of custom widget extensions are:

Text Intelligence - Lets you use MonekyLearn APIs to provide helpful recommendations such as content summarizer, keyword extractor, retail classifier, etc.
Google Analytics - Displays the traffic analysis and statistics of your entry (using Google Analytics data) on the sidebar of the entry.
Optimizely Experiments - Lets you retrieve and display Optimizely Experiments and their details in your entry.
Developer Tools - This widget extension provides developers with quick tools (API endpoint, JSON, etc.) to work with an entry or all entries of a content type and do a lot more.

Dashboard Widgets

Some of the examples of the dashboard widget extensions are:

Google Analytics - Displays the traffic analysis and statistics of your site on the stack dashboard.
Content Type Visualizer - Content Type Visualizer Dashboard Widget offers a graphical representation of all content types, along with their fields, in a particular stack.

Using Contentstack styles

Extensions are rendered within an iframe, you will need to include the ui-extension-sdk.min.css library within your custom extension in order to use any of the styles provided by Contentstack.

Include the CSS file in your extension code as follows:

1<link
2    rel="stylesheet"
3    type="text/css"
4    href="https://unpkg.com/@contentstack/ui-extensions-sdk/dist/ui-extension-sdk.css"
5    integrity="sha512-yPPI/jWiqPr0HIh+1A2QPP5p58sSYqbPoBykxIuBckT1vzGwNbrOmwYM03qGI4ffnxd7q4kkoDys0kdZzxYn9A=="
6    crossorigin="anonymous"
7/>

For more information on styling your extension, refer to our style guide.

More information

License

Licensed under MIT.

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

4

Maintained

Determines if the project is "actively maintained".

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 2

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/codeql-analysis.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/jira.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/jira.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/jira.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/jira.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/jira.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/jira.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/jira.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/jira.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/npm-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/npm-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/npm-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/npm-publish.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sast-scan.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/sast-scan.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sca-scan.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/sca-scan.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sca-scan.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/sca-scan.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-copyright-years-in-license-file.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/update-copyright-years-in-license-file.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-copyright-years-in-license-file.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/contentstack/ui-extensions-sdk/update-copyright-years-in-license-file.yml/master?enable=pin
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 2 out of 2 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.9

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@contentstack/ui-extensions-sdk

Installations

Pull Requests

18

50

21

11

Issues

4

7

3

Releases

Developer

contentstack

Developer Guide

CommonJS

No

16.20.2

8.19.4

Statistics

Languages

Total Downloads

508,678

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Contentstack Extensions SDK

Getting started

Extensions examples

Custom Fields

Custom Widgets

Dashboard Widgets

Using Contentstack styles

More information

License

10

10

10

10

10

4

2

2

0

0

0

0

4.9

/10