Extension

Extension

Class representing an extension from Contentstack UI.

Members

config :Object

Source:
This method gives you the configuration parameters. Check out our UI Extension documentation .
Type:
  • Object

currentUser :Object

Source:
This object holds details of the current user.
Type:
  • Object

entry :Entry

Source:
This gives you the entry object which allows you to interact with the current entry. Not available in case of the Dashboard Widget extension.
Type:

field :Field

Source:
Gives you the extension field object which allows you to interact with the field. Only available for the Custom Field extension.
Type:

fieldConfig :Object

Source:
This method gives you the instance configuration parameters set from the content type builder page in the field settings. This is only available for the Custom Field extension.
Type:
  • Object

stack :Stack

Source:
This method returns stack object which allows users to read and manipulate a range of objects in a stack.
Type:

store :Store

Source:
Store to persist data for extension. Note: Data is stored in the browser external:localStorage and will be lost if the external:localStorage is cleared in the browser.
Type:

type :string

Source:
type of extension, 'FIELD' || 'WIDGET' || 'DASHBOARD'.
Type:
  • string

window :Window

Source:
The window object provides users with methods that allow them to adjust the size of the iframe that contains the extension. Not available in case of custom widgets.
Type: