@types/ckeditor__ckeditor5-list

  • Version 35.3.0
  • Published
  • 25.9 kB
  • 6 dependencies
  • MIT license

Install

npm i @types/ckeditor__ckeditor5-list
yarn add @types/ckeditor__ckeditor5-list
pnpm add @types/ckeditor__ckeditor5-list

Overview

TypeScript definitions for @ckeditor/ckeditor5-list

Index

Classes

class DocumentList

class DocumentList extends Plugin {}
  • The document list feature.

property pluginName

static readonly pluginName: string;

    property requires

    static readonly requires: [typeof DocumentListEditing, typeof ListUI];

      class DocumentListEditing

      class DocumentListEditing extends Plugin {}
      • The editing part of the document-list feature. It handles creating, editing and removing lists and list items.

      property pluginName

      static readonly pluginName: string;

        property requires

        static readonly requires: [any, any, typeof DocumentListUtils];

          method afterInit

          afterInit: () => void;

            method init

            init: () => void;

              method registerDowncastStrategy

              registerDowncastStrategy: (strategy: DowncastStrategy) => void;
              • Registers a downcast strategy.

              class DocumentListProperties

              class DocumentListProperties extends Plugin {}
              • The document list properties feature.

              property pluginName

              static pluginName: string;

                property requires

                static readonly requires: [
                typeof DocumentListPropertiesEditing,
                typeof ListPropertiesUI
                ];

                  class DocumentListPropertiesEditing

                  class DocumentListPropertiesEditing extends Plugin {}
                  • The document list properties engine feature.

                  property pluginName

                  static readonly pluginName: string;

                    property requires

                    static readonly requires: [
                    typeof DocumentListEditing,
                    typeof DocumentListPropertiesUtils
                    ];

                      method init

                      init: () => void;

                        class List

                        class List extends Plugin {}

                          property pluginName

                          static readonly pluginName: string;

                            property requires

                            static readonly requires: [typeof ListEditing, typeof ListUI];

                              class ListEditing

                              class ListEditing extends Plugin {}

                                property pluginName

                                static readonly pluginName: string;

                                  property requires

                                  static readonly requires: [any, any];

                                    method afterInit

                                    afterInit: () => void;

                                      method init

                                      init: () => void;

                                        class ListProperties

                                        class ListProperties extends Plugin {}

                                          property pluginName

                                          static readonly pluginName: string;

                                            property requires

                                            static readonly requires: [
                                            typeof ListPropertiesEditing,
                                            typeof ListPropertiesUI
                                            ];

                                              class ListPropertiesEditing

                                              class ListPropertiesEditing extends Plugin {}
                                              • The engine of the list properties feature.

                                              constructor

                                              constructor(editor: Editor);

                                                property pluginName

                                                static readonly pluginName: string;

                                                  property requires

                                                  static readonly requires: [typeof ListEditing];

                                                    method afterInit

                                                    afterInit: () => void;

                                                      method init

                                                      init: () => void;

                                                        class ListPropertiesUI

                                                        class ListPropertiesUI extends Plugin {}
                                                        • The list properties UI plugin. It introduces the extended 'bulletedList' and 'numberedList' toolbar buttons that allow users to control such aspects of list as the marker, start index or order.

                                                        property pluginName

                                                        static readonly pluginName: string;

                                                          method init

                                                          init: () => void;

                                                            class ListUI

                                                            class ListUI extends Plugin {}

                                                              property pluginName

                                                              static readonly pluginName: string;

                                                                method init

                                                                init: () => void;

                                                                  class TodoList

                                                                  class TodoList extends Plugin {}

                                                                    property pluginName

                                                                    static readonly pluginName: string;

                                                                      property requires

                                                                      static readonly requires: [typeof TodoListEditing, typeof TodoListUI];

                                                                        class TodoListEditing

                                                                        class TodoListEditing extends Plugin {}

                                                                          property pluginName

                                                                          static readonly pluginName: string;

                                                                            property requires

                                                                            static readonly requires: [typeof ListEditing];

                                                                              method init

                                                                              init: () => void;

                                                                                class TodoListUI

                                                                                class TodoListUI extends Plugin {}

                                                                                  property pluginName

                                                                                  static readonly pluginName: string;

                                                                                    method init

                                                                                    init: () => void;

                                                                                      Package Files (14)

                                                                                      Dependencies (6)

                                                                                      Dev Dependencies (0)

                                                                                      No dev dependencies.

                                                                                      Peer Dependencies (0)

                                                                                      No peer dependencies.

                                                                                      Badge

                                                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/ckeditor__ckeditor5-list.

                                                                                      • Markdown
                                                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/ckeditor__ckeditor5-list)
                                                                                      • HTML
                                                                                        <a href="https://www.jsdocs.io/package/@types/ckeditor__ckeditor5-list"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>