Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Docs: Updates in to-do list feature guide: enable to-do list feature …
Browse files Browse the repository at this point in the history
…in the snippet. Add links to API.
  • Loading branch information
Piotr Jasiun committed Aug 14, 2019
1 parent 0c683b3 commit 58cddca
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/_snippets/features/todo-list.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import { CS_CONFIG } from '@ckeditor/ckeditor5-cloud-services/tests/_utils/cloud

import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';

// import TodoList from '@ckeditor/ckeditor5-list/src/todolist';
import TodoList from '@ckeditor/ckeditor5-list/src/todolist';

// ClassicEditor.builtinPlugins.push( TodoList );
ClassicEditor.builtinPlugins.push( TodoList );

ClassicEditor
.create( document.querySelector( '#snippet-todo-list' ), {
Expand All @@ -22,7 +22,7 @@ ClassicEditor
'|',
'bulletedList',
'numberedList',
// 'todoList',
'todoList',
'|',
'link',
'insertTable',
Expand Down
6 changes: 3 additions & 3 deletions docs/features/todo-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ category: features

# To-do lists

The to-do list feature lets you create a list of interactive checkboxes with labels. It supports all features of regular lists so you can nest a to-do list together with bulleted and numbered lists in any combination.
The {@link module:list/todolist~TodoList to-do list} feature lets you create a list of interactive checkboxes with labels. It supports all features of regular lists so you can nest a to-do list together with bulleted and numbered lists in any combination.

## Demo

{@snippet features/todo-list}

## Keyboard support

You can check and uncheck a list item by using the <kbd>Ctrl</kbd> + <kbd>Space</kbd> (or <kbd>⌘</kbd> + <kbd>Space</kbd> if you are using macOS) shortcut when the selection is in that item.
You can check and uncheck a list item by using the <kbd>Ctrl</kbd> + <kbd>Space</kbd> shortcut when the selection is in that item.

## Installation

Expand Down Expand Up @@ -78,7 +78,7 @@ For nested lists:

### Model representation

From the technical point of view, to-do lists are built on top of the list feature. In the CKEditor 5 data model they are represented as a special `listType`, with an optional `todoListChecked` attribute:
From the technical point of view, to-do lists are built on top of the {@link module:list/list~List list feature}. In the CKEditor 5 data model they are represented as a special `listType`, with an optional `todoListChecked` attribute:

```html
<listItem listType="todo">Foo</listItem>
Expand Down

0 comments on commit 58cddca

Please sign in to comment.