useExtensionEditor

hook

UseExtensionEditorGeneratedType

Returns information about the editor where the extension is being rendered.

Editor | undefined

export function useExtensionEditor(): Editor | undefined {
  return useApi().extension.editor;
}

Editor

• type

  Indicates whether the extension is rendering in the checkout editor.

  "checkout"

export interface Editor {
  /**
   * Indicates whether the extension is rendering in the checkout editor.
   */
  type: 'checkout';
}