Action

An action in your created component is an async callback function that allows you to read contextual information about the action being dispatched, along with information about the component that is initiating the call.

It can be defined in an async function inside the createComponent call, and includes 3 arguments:

action: async (element, action, context) => {
    return {}
},

element

The element calling the action. This object contains the following keys:

Name	Description

action

The main action object being sent. See the Actions reference to learn more about the GitBook specific actions your components can read, or how to create your own custom actions for your integrations.

This object contains the following key:

Name	Description

context

Context about your integration, including the environment and installation details the integration is running in.

This object contains the following keys:

Name	Description