Skip to main content

@lexical/react/LexicalCheckListPlugin

Functions​

CheckListPlugin()​

CheckListPlugin(__namedParameters): null

Defined in: packages/lexical-react/src/LexicalCheckListPlugin.tsx:24

Enables check list support, wiring up the keyboard and pointer interactions that toggle the checked state of check list items. Pass disableTakeFocusOnClick to stop the editor from taking focus when a checkbox is clicked.

This is a legacy plugin. When building an editor with the extension API, configure CheckListExtension instead.

Parameters​

__namedParameters​
disableTakeFocusOnClick?​

boolean = false

Returns​

null

null, this plugin renders no DOM of its own.