Scheduler - Multi Event Selection

#Usage

import { Scheduler } from '@primeui/vue-scheduler';

<Scheduler.Root :event-selection="eventSelectionOptions" @event-selection-change="onEventSelectionChange">
    <Scheduler.SelectionToolbar />
</Scheduler.Root>

Multi-event selection is configured on the root. Add Scheduler.SelectionToolbar when selected events need visible actions such as moving, clearing, or applying a shared status.

#Event Selection

eventSelectionOptions controls whether multiple events can be selected, how selection is presented, and whether it survives navigation.

import type { SchedulerEventSelectionOptions } from '@primeui/vue-scheduler';

const eventSelectionOptions: SchedulerEventSelectionOptions = {
    multiple: true,
    selectMode: 'click',
    preserveOnNavigation: true
};

click uses the normal event surface: click an event to select it, use Ctrl or Cmd-click to build a set, and drag one selected event to move the set together. checkbox is available when a product wants always-visible selection toggles, but it is not required for bulk workflows. Add maxSelection as a number when a flow needs a selection cap. Handle event-selection-change through onEventSelectionChange when the app persists selected ids outside Scheduler.

#Timed Bulk Move

Selected timed events move together when one selected event is dragged. Use Ctrl or Cmd-click to build the selected set first. The selection toolbar stays visible while events are selected, so users can clear or invert the set before dragging.

#Bulk Edit

Bulk edit flows stay app-owned. Use the selection toolbar slot to read selectedEventIds, update the backing event array, then clear the selection after the action completes.

#Checkbox Resource Selection

Checkbox mode is useful when users need to scan a dense resource schedule and build a review set without modifier keys. This date-grouped resource example keeps the selected ids shared across dates and resources, so a dispatcher can gather the items that need the same follow-up. Select a few items, then drag one selected event into another lane to move the set together.

#Persistence

Keep destructive actions parent-owned. Use selectedIds for persistence calls, then replace the events array after the server accepts the change. If a save removes or changes selected events, clear or remap the selection before rendering the next range.

Multi-select works best for events with clear identity. Generated placeholder events, unsaved drafts, and recurring occurrences should receive temporary ids before they enter the Scheduler. Reconcile them when the permanent ids arrive.

#API

Key APIs are eventSelection, Scheduler.SelectionToolbar, @event-selection-change, @event-selection-limit-reached, selected event payloads, and semantic event outlets.

#Related Docs

• Keyboard
• Events Reference