BuiltInActionNEW

BuiltInAction:

{
  id: BuiltInActionId;
  label: string;
  description?: string;
  shortcuts?: string[];
  icon?: string;
  isEnabled?: () => boolean;
  handler?: (args: unknown[]) => void | Promise<void>;
}

Built-in actions have pre-defined IDs from BuiltInActionId and automatically use default handlers if not provided. This allows you to customize things without having to reimplement internal functionality.

Example

import { defaultActions } from '@nutrient-sdk/document-authoring';

// Remove all built-in actions except bold built-in (handler auto-populated)
editor.setActions([{ id: 'formatting.bold', label: 'Bold', shortcuts: ['Mod+B'] }]);

// Override the default handler for bold
editor.setActions([
  ...defaultActions.filter(({ id }) => id !== 'formatting.bold'),
  {
    id: 'formatting.bold',
    label: 'Bold',
    shortcuts: ['Mod+B'],
    handler: () => {
      console.log('Custom bold implementation');
    },
  },
]);

// Customize shortcuts and labels while keeping default behavior
editor.setActions([
  ...defaultActions.filter(({ id }) => id !== 'document.export-pdf'),
  { id: 'document.export-pdf', label: 'Download PDF', shortcuts: ['Mod+P'] },
]);

See

• BuiltInActionId for available built-in action IDs.
• CustomAction for defining custom actions.

Properties

id

id: BuiltInActionId

---

label

label: string

---

description?

optional description: string

---

shortcuts?

optional shortcuts: string[]

Keyboard shortcuts for the action. Use “Mod” as the primary modifier key - it will be automatically resolved to:

• “Ctrl” on Windows/Linux
• ”⌘” (Command) on Mac

Examples:

• “Mod+B” becomes “Ctrl+B” on Windows, “⌘B” on Mac
• “Mod+Shift+P” becomes “Ctrl+Shift+P” on Windows, ”⌘⇧P” on Mac

---

icon?

optional icon: string

Icon as data URI (e.g., data:image/svg+xml;base64,… or data:image/png;base64,…). Only data:image/ URIs are allowed for security.

---

isEnabled()?

optional isEnabled: () => boolean

Returns

boolean

---

handler()?

optional handler: (…args) => void | Promise<void>

Handler function - optional for built-in actions (defaults will be used if omitted)

Parameters

args

…unknown[]

Returns

void | Promise<void>