Skip to content

useSelectionCapabilities

useSelectionCapabilities() exposes reactive booleans for whether common editor actions are currently allowed.

Use it when building:

  • menus
  • toolbars
  • keyboard shortcuts
  • action buttons
  • contextual panels

Usage

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

const caps = useSelectionCapabilities()

Basic example

vue
<script setup lang="ts">
import { useSelectionCapabilities } from '@open-pencil/vue'

const { canDelete, canDuplicate, canCreateComponent } = useSelectionCapabilities()
</script>

<template>
  <div class="flex gap-2">
    <button :disabled="!canDuplicate">Duplicate</button>
    <button :disabled="!canDelete">Delete</button>
    <button :disabled="!canCreateComponent">Make component</button>
  </div>
</template>

Practical examples

Gate menu entries

ts
const { canMoveToPage, canGoToMainComponent } = useSelectionCapabilities()

Enable zoom commands only when useful

ts
const { canZoomToSelection } = useSelectionCapabilities()

Released under the MIT License.