selection.registerOnChange

API reference for the selection.registerOnChange method.

Registers a callback that runs when a user selects or deselects an element.

To learn more, see Transforming elements.

Usage

import { selection } from "@canva/preview/design";

(async () => {
  await selection.registerOnChange({
    scope: "text",
    onChange: (event) => {
      console.log(event);
    },
  });
})();

Parameters

#optionsobject

Required

The options for registering an element selection callback.

#options.scopestring

Required

The type of selection event to listen for.

#options.onChangefunction

Required

The callback that runs when a user selects or deselects an element.

Returns

Promise<void>