Rate this page:

Extension Factories

Extension factories are a set of provided helper utilities to create extensions.

They will set the type of the extensions automatically, and provide type definitions for your attribute provider if you're using TypeScript.

Signature

1
type factory = (api: ExtensionAPI, context: Context<{}>) => ExtensionAttributes;

Parameters

NameTypeDescription
extensionAPIExtensionAPIExtension API that provides methods to render and clean up the extension.
contextobjectAn object with information that products share with extensions to share important information about the screen where they are rendered.

Custom types and attributes

There is a set of default attributes that all products support, but products can also add custom attributes or extension types to extend their UI in custom ways.

Always remember to check the documentation of each product's extension point and supported attributes.

Read more information about Revealing extension points on the page.

Rate this page: