Skip to main content

useCanvasSelection()v4.0.527

Subscribes a React component to a canvas selection controller.

warning

Experimental API: This package is not stable. Its public API may change without a major version bump.

SelectionCount.tsx
import {useCanvasSelection, type CanvasController} from '@remotion/sdk';

export const SelectionCount = ({controller}: {controller: CanvasController}) => {
  const {selectedItems} = useCanvasSelection(controller.selection);
  return <span>{selectedItems.length} selected</span>;
};

Parameter​

controller​

A CanvasSelectionController, usually controller.selection from useCanvasController().

Return value​

A CanvasSelectionSnapshot with the following properties.

selectedItems​

A readonly array of CanvasSelectionItem values. An item has a type discriminator. The sequence variant contains nodePathInfo; other variants represent a sequence property, effect, keyframe, easing segment, or guide. Use getCanvasSelectionItemKey() to compare items by identity.

anchor​

The CanvasSelectionItem used as the starting point for a subsequent Shift selection, or null when there is no anchor.

The controller's select() method accepts shiftKey, toggleKey, and the ordered selectable items. See createCanvasController().

Compatibility​

BrowsersEnvironments
Chrome
Firefox
Safari

See also​