Skip to content

Commit 8047a4a

Browse files
committed
997581: Markdown auto format documentation
1 parent c14b201 commit 8047a4a

File tree

2 files changed

+164
-0
lines changed

2 files changed

+164
-0
lines changed

ej2-asp-core-mvc/rich-text-editor/EJ2_ASP.MVC/tools/text-formatting.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,55 @@ The following example demonstrates how to customize the bullet format lists in t
200200
{% endtabs %}
201201
{% endif %}
202202

203+
### Checklist
204+
205+
The `Checklist` feature lets you create interactive task lists with clickable checkboxes. You can configure checkbox behavior, customize the visual appearance, manage item states, and enable keyboard interactions. This makes it perfect for project management, note-taking, and task tracking within your content. You can easily toggle between checked and unchecked states, giving you an intuitive way to manage the completion status of your list items—making it a simple and effective TODO list solution.
206+
207+
#### Inserting a checklist
208+
209+
You can embed interactive task lists directly within the Rich Text Editor. Here’s how you can insert a Checklist:
210+
- **Using the Toolbar**: Click the Checklist button in the editor toolbar, usually represented by a checkbox icon.
211+
- **Using the Shortcut**: Press `Ctrl+Shift+9` (or `Cmd+Shift+9` on macOS) to insert a Checklist at your cursor’s position.
212+
- **Converting Existing Lists**: Select an existing bullet or numbered list and click the Checklist button to convert it into an interactive checklist.
213+
- **Toggling Checklist Items**: You can toggle the state of checklist items between checked and unchecked by clicking the checkbox. If you prefer using the keyboard, press `Ctrl+Enter` (or `Cmd+Enter` on macOS) to toggle the check marks based on your selection or cursor position in the editor.
214+
215+
#### Configuring Checklist
216+
217+
To enable the Checklist feature in your editor, add the `Checklist` toolbar item to the `ToolbarSettings.Items` property. This feature supports customizable behavior and can be easily integrated into your Rich Text Editor toolbar for quick access.
218+
219+
Below is an example of how to configure the Checklist in the Rich Text Editor:
220+
221+
{% if page.publishingplatform == "aspnet-core" %}
222+
223+
{% tabs %}
224+
{% highlight cshtml tabtitle="CSHTML" %}
225+
{% include code-snippet/rich-text-editor/checklist-cs1/tagHelper %}
226+
{% endhighlight %}
227+
{% highlight c# tabtitle="Controller.cs" %}
228+
{% include code-snippet/rich-text-editor/checklist-cs1/controller.cs %}
229+
{% endhighlight %}
230+
{% endtabs %}
231+
232+
{% elsif page.publishingplatform == "aspnet-mvc" %}
233+
234+
{% tabs %}
235+
{% highlight razor tabtitle="CSHTML" %}
236+
{% include code-snippet/rich-text-editor/checklist-cs1/razor %}
237+
{% endhighlight %}
238+
{% highlight c# tabtitle="Controller.cs" %}
239+
{% include code-snippet/rich-text-editor/checklist-cs1/controller.cs %}
240+
{% endhighlight %}
241+
{% endtabs %}
242+
{% endif %}
243+
244+
## Nested list creation using Tab key
245+
246+
In the Rich Text Editor, pressing the `Tab` key while the cursor is inside a list item automatically creates a nested list. This behavior allows users to structure their content hierarchically by indenting list items. Each press of the `Tab` key increases the nesting level, converting the current item into a sub-item of the previous one.
247+
248+
Please refer to the below video for visual behavior and interaction examples:
249+
250+
![Rich Text Editor list editing behaviour](../images/list-editing.gif)
251+
203252
## Increase and decrease indent
204253

205254
The Rich Text Editor allows you to set indentation for text blocks such as paragraphs, headings, or lists. This feature helps you visually organize and structure your content, making it easier to read and understand.
@@ -381,6 +430,39 @@ Use the `Blockquote` tool in the editor below to see the feature in action.
381430

382431
> In a markdown editor, blockquotes are represented using the `>` symbol.
383432
433+
### Nested blockquotes
434+
435+
The Rich Text Editor also supports nested blockquotes, allowing one blockquote to be placed inside another.
436+
437+
While the toolbar does not provide a direct method to apply blockquote formatting recursively (i.e., within an already blockquote section), nested blockquotes can still be achieved in the following ways:
438+
439+
1. **Pasting preformatted content:** If you paste content that already contains nested blockquote tags (e.g., from another editor or email), the Rich Text Editor will preserve and render the nested structure correctly.
440+
2. **Pre-loading nested blockquote HTML:** You can initialize the editor with nested blockquote content using the value property.
441+
3. **Manual editing via Source Code view:** You can manually insert nested blockquote tags using the SourceCode toolbar option.
442+
443+
{% if page.publishingplatform == "aspnet-core" %}
444+
445+
{% tabs %}
446+
{% highlight cshtml tabtitle="CSHTML" %}
447+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/tagHelper %}
448+
{% endhighlight %}
449+
{% highlight c# tabtitle="Controller.cs" %}
450+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/controller.cs %}
451+
{% endhighlight %}
452+
{% endtabs %}
453+
454+
{% elsif page.publishingplatform == "aspnet-mvc" %}
455+
456+
{% tabs %}
457+
{% highlight razor tabtitle="CSHTML" %}
458+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/razor %}
459+
{% endhighlight %}
460+
{% highlight c# tabtitle="Controller.cs" %}
461+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/controller.cs %}
462+
{% endhighlight %}
463+
{% endtabs %}
464+
{% endif %}
465+
384466
## Horizontal line
385467

386468
The Rich Text Editor enables users to insert horizontal dividers using the `HorizontalLine` tool available in the toolbar. Horizontal lines (<hr>) help visually separate sections of content, enhancing readability and structural clarity.

ej2-asp-core-mvc/rich-text-editor/EJ2_ASP.NETCORE/tools/text-formatting.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,55 @@ The following example demonstrates how to customize the bullet format lists in t
200200
{% endtabs %}
201201
{% endif %}
202202

203+
### Checklist
204+
205+
The `Checklist` feature lets you create interactive task lists with clickable checkboxes. You can configure checkbox behavior, customize the visual appearance, manage item states, and enable keyboard interactions. This makes it perfect for project management, note-taking, and task tracking within your content. You can easily toggle between checked and unchecked states, giving you an intuitive way to manage the completion status of your list items—making it a simple and effective TODO list solution.
206+
207+
#### Inserting a checklist
208+
209+
You can embed interactive task lists directly within the Rich Text Editor. Here’s how you can insert a Checklist:
210+
- **Using the Toolbar**: Click the Checklist button in the editor toolbar, usually represented by a checkbox icon.
211+
- **Using the Shortcut**: Press `Ctrl+Shift+9` (or `Cmd+Shift+9` on macOS) to insert a Checklist at your cursor’s position.
212+
- **Converting Existing Lists**: Select an existing bullet or numbered list and click the Checklist button to convert it into an interactive checklist.
213+
- **Toggling Checklist Items**: You can toggle the state of checklist items between checked and unchecked by clicking the checkbox. If you prefer using the keyboard, press `Ctrl+Enter` (or `Cmd+Enter` on macOS) to toggle the check marks based on your selection or cursor position in the editor.
214+
215+
#### Configuring Checklist
216+
217+
To enable the Checklist feature in your editor, add the `Checklist` toolbar item to the `e-richtexteditor-toolbarsettings.items` property. This feature supports customizable behavior and can be easily integrated into your Rich Text Editor toolbar for quick access.
218+
219+
Below is an example of how to configure the Checklist in the Rich Text Editor:
220+
221+
{% if page.publishingplatform == "aspnet-core" %}
222+
223+
{% tabs %}
224+
{% highlight cshtml tabtitle="CSHTML" %}
225+
{% include code-snippet/rich-text-editor/checklist-cs1/tagHelper %}
226+
{% endhighlight %}
227+
{% highlight c# tabtitle="Controller.cs" %}
228+
{% include code-snippet/rich-text-editor/checklist-cs1/controller.cs %}
229+
{% endhighlight %}
230+
{% endtabs %}
231+
232+
{% elsif page.publishingplatform == "aspnet-mvc" %}
233+
234+
{% tabs %}
235+
{% highlight razor tabtitle="CSHTML" %}
236+
{% include code-snippet/rich-text-editor/checklist-cs1/razor %}
237+
{% endhighlight %}
238+
{% highlight c# tabtitle="Controller.cs" %}
239+
{% include code-snippet/rich-text-editor/checklist-cs1/controller.cs %}
240+
{% endhighlight %}
241+
{% endtabs %}
242+
{% endif %}
243+
244+
## Nested list creation using Tab key
245+
246+
In the Rich Text Editor, pressing the `Tab` key while the cursor is inside a list item automatically creates a nested list. This behavior allows users to structure their content hierarchically by indenting list items. Each press of the `Tab` key increases the nesting level, converting the current item into a sub-item of the previous one.
247+
248+
Please refer to the below video for visual behavior and interaction examples:
249+
250+
![Rich Text Editor list editing behaviour](../images/list-editing.gif)
251+
203252
## Increase and decrease indent
204253

205254
The Rich Text Editor allows you to set indentation for text blocks such as paragraphs, headings, or lists. This feature helps you visually organize and structure your content, making it easier to read and understand.
@@ -381,6 +430,39 @@ Use the `Blockquote` tool in the editor below to see the feature in action.
381430

382431
> In a markdown editor, blockquotes are represented using the `>` symbol.
383432
433+
### Nested blockquotes
434+
435+
The Rich Text Editor also supports nested blockquotes, allowing one blockquote to be placed inside another.
436+
437+
While the toolbar does not provide a direct method to apply blockquote formatting recursively (i.e., within an already blockquote section), nested blockquotes can still be achieved in the following ways:
438+
439+
1. **Pasting preformatted content:** If you paste content that already contains nested blockquote tags (e.g., from another editor or email), the Rich Text Editor will preserve and render the nested structure correctly.
440+
2. **Pre-loading nested blockquote HTML:** You can initialize the editor with nested blockquote content using the value property.
441+
3. **Manual editing via Source Code view:** You can manually insert nested blockquote tags using the SourceCode toolbar option.
442+
443+
{% if page.publishingplatform == "aspnet-core" %}
444+
445+
{% tabs %}
446+
{% highlight cshtml tabtitle="CSHTML" %}
447+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/tagHelper %}
448+
{% endhighlight %}
449+
{% highlight c# tabtitle="Controller.cs" %}
450+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/controller.cs %}
451+
{% endhighlight %}
452+
{% endtabs %}
453+
454+
{% elsif page.publishingplatform == "aspnet-mvc" %}
455+
456+
{% tabs %}
457+
{% highlight razor tabtitle="CSHTML" %}
458+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/razor %}
459+
{% endhighlight %}
460+
{% highlight c# tabtitle="Controller.cs" %}
461+
{% include code-snippet/rich-text-editor/nested-quotation-formatting/controller.cs %}
462+
{% endhighlight %}
463+
{% endtabs %}
464+
{% endif %}
465+
384466
## Horizontal line
385467

386468
The Rich Text Editor enables users to insert horizontal dividers using the `HorizontalLine` tool available in the toolbar. Horizontal lines (<hr>) help visually separate sections of content, enhancing readability and structural clarity.

0 commit comments

Comments
 (0)