Skip to content

useEditorCommands

useEditorCommands() expose une couche orientée commandes au-dessus des actions de l'éditeur.

Il est utile pour construire :

  • des menus applicatifs
  • des menus contextuels
  • des barres d'outils
  • des adaptateurs de commandes clavier
  • des sous-menus de déplacement entre pages

Utilisation

ts
import { useEditorCommands } from '@open-pencil/vue'

const { commands, menuItem, runCommand, moveSelectionToPage, otherPages } = useEditorCommands()

Exemple de base

ts
const { menuItem } = useEditorCommands()

const editMenu = [
  menuItem('edit.undo', '⌘Z'),
  menuItem('edit.redo', '⇧⌘Z'),
  { separator: true },
  menuItem('selection.delete'),
]

Exemples pratiques

Exécuter une commande directement

ts
const { runCommand } = useEditorCommands()
runCommand('selection.duplicate')

Construire un sous-menu « Déplacer vers la page »

ts
const { otherPages, moveSelectionToPage } = useEditorCommands()

const items = otherPages.value.map(page => ({
  label: page.name,
  action: () => moveSelectionToPage(page.id),
}))

API associées

Types principaux

ts
type EditorCommandId =
  | 'edit.undo'
  | 'edit.redo'
  | 'selection.selectAll'
  | 'selection.duplicate'
  | 'selection.delete'
  | 'selection.group'
  | 'selection.ungroup'
  | 'selection.createComponent'
  | 'selection.createComponentSet'
  | 'selection.createInstance'
  | 'selection.detachInstance'
  | 'selection.goToMainComponent'
  | 'selection.wrapInAutoLayout'
  | 'selection.bringToFront'
  | 'selection.sendToBack'
  | 'selection.toggleVisibility'
  | 'selection.toggleLock'
  | 'selection.moveToPage'
  | 'view.zoom100'
  | 'view.zoomFit'
  | 'view.zoomSelection'

Released under the MIT License.