Skip to content

Commit 778f6e9

Browse files
[update] RichText 2.0
1 parent 0d89b78 commit 778f6e9

21 files changed

Lines changed: 3049 additions & 4582 deletions

docs/api/editor_api_methods.md

Lines changed: 65 additions & 65 deletions
Large diffs are not rendered by default.

docs/api/events_bus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,6 @@ richtext.events.on("Change", function(action, canUndo, canRedo){
8787

8888
#### Details
8989

90-
[See the list of Richtext events](api/events.md).
90+
[See the list of RichText events](api/events.md).
9191

9292
You can attach several handlers to the same event and all of them will be executed. If some of handlers return *false*, the related operations will be blocked. Event handlers are processed in the same order that they are attached.

docs/api/overview.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Become familiar with a range of objects, methods, and events availa
88

99
~~~js
1010
var richtext = new dhx.Richtext("richtext_container", {
11-
mode:"document"
11+
mode:"document"
1212
});
1313
~~~
1414

@@ -53,7 +53,7 @@ var richtext = new dhx.Richtext("richtext_container", {
5353
| ------------------------------------------------ | ---------------- |
5454
| [customStats](api/properties.md#customstats) | defines the logic of displaying custom statistics |
5555
| [mode](api/properties.md#mode) | the working mode of the RichText editor |
56-
| [toolbarBlocks](api/properties.md#toolbarblocks) | specifies blocks of buttons that will be shown in the Richtext toolbar |
56+
| [toolbarBlocks](api/properties.md#toolbarblocks) | specifies blocks of buttons that will be shown in the RichText Toolbar |
5757

5858
### Editor API methods
5959

@@ -76,19 +76,19 @@ var EditorAPI = richtext.getEditorAPI();
7676

7777
| Name | Description |
7878
|-----------------------------------------|----------------------------------------------|
79-
| [add](api/toolbar_methods.md#add) | adds a new control to the toolbar |
80-
| [remove](api/toolbar_methods.md#remove) | removes a control from the toolbar |
79+
| [add](api/toolbar_methods.md#add) | adds a new control to the Toolbar |
80+
| [remove](api/toolbar_methods.md#remove) | removes a control from the Toolbar |
8181
| [update](api/toolbar_methods.md#update) | updates configuration options of the control |
8282

8383
### Toolbar controls
8484

85-
Besides using the [default](guides/customization.md#default-controls) controls of the toolbar, you can customize the toolbar by adding the following controls:
85+
Besides using the [default](guides/customization.md#default-controls) controls of the toolbar, you can customize the Toolbar by adding the following controls:
8686

8787
| Name | Description |
8888
|------------------------------------------------------|--------------------------------------------------------------|
8989
| [Button](api/toolbar_controls.md#button) | a simple button that can have an icon |
9090
| [Custom HTML](api/toolbar_controls.md#custom-html) | an item that contains any custom HTML content (for example, an image, icon or other element) |
9191
| [ImageButton](api/toolbar_controls.md#imagebutton) | a button with an image |
9292
| [SelectButton](api/toolbar_controls.md#selectbutton) | a button that contains a drop-down list of options |
93-
| [Separator](api/toolbar_controls.md#separator) | a horizontal (between menu options) or vertical (between toolbar controls) line separating items/groups of items from each other |
94-
| [Spacer](api/toolbar_controls.md#spacer) | the item takes space on the toolbar and is used for aligning controls |
93+
| [Separator](api/toolbar_controls.md#separator) | a horizontal (between menu options) or vertical (between Toolbar controls) line separating items/groups of items from each other |
94+
| [Spacer](api/toolbar_controls.md#spacer) | the item takes space on the Toolbar and is used for aligning controls |

docs/api/properties.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: Properties
33
title: Properties
4-
description: Get insight into configuration properties utilized for working with text statistics, setting editor mode, and customizing the toolbar in DHTMLX Rich Text Editor.
4+
description: Get insight into configuration properties utilized for working with text statistics, setting editor mode, and customizing the Toolbar in DHTMLX Rich Text Editor.
55
---
66

77
## `customStats`
@@ -50,7 +50,7 @@ ____
5050

5151
## `defaultStyles`
5252

53-
Defines default values of the toolbar selection controls
53+
Defines default values of the Toolbar selection controls
5454

5555
`defaultStyles?: object;`
5656

@@ -91,7 +91,7 @@ The working mode of the RichText editor
9191
**Values**: "default", "document"
9292

9393
~~~jsx
94-
var richtext = new dhx.RichText("richtext_container", {
94+
var richtext = new dhx.Richtext("richtext_container", {
9595
mode: "document"
9696
});
9797
~~~
@@ -104,13 +104,13 @@ ____
104104

105105
## `toolbarBlocks`
106106

107-
Specifies blocks of buttons that will be shown in the Richtext toolbar
107+
Specifies blocks of buttons that will be shown in the RichText toolbar
108108

109109
`toolbarBlocks?: array;`
110110

111111
~~~jsx
112-
// default toolbar blocks
113-
var richtext = new dhx.RichText("richtext_container", {
112+
// default Toolbar blocks
113+
var richtext = new dhx.Richtext("richtext_container", {
114114
toolbarBlocks: ["undo", "style", "decoration", "colors", "align", "link"]
115115
});
116116
~~~
@@ -123,10 +123,10 @@ var richtext = new dhx.RichText("richtext_container", {
123123

124124
### Full toolbar
125125

126-
The full toolbar contains several more blocks: `"clear"`, `"fullscreen"`, and `"stats"`:
126+
The full Toolbar contains several more blocks: `"clear"`, `"fullscreen"`, and `"stats"`:
127127

128128
~~~jsx
129-
var richtext = new dhx.RichText(document.body, {
129+
var richtext = new dhx.Richtext(document.body, {
130130
// full toolbar
131131
toolbarBlocks: [
132132
"undo", "style", "decoration", "colors", "align",
@@ -137,23 +137,23 @@ var richtext = new dhx.RichText(document.body, {
137137

138138
**Related sample:** [RichText. Full Toolbar](https://snippet.dhtmlx.com/5yga5ce1)
139139

140-
### Short toolbar definition
140+
### Short Toolbar definition
141141

142142
The default set of buttons can be specified via the `"default"` definition in the `toolbarBlocks` array, like this:
143143

144144
~~~jsx
145-
var richtext = new dhx.RichText(document.body, {
145+
var richtext = new dhx.Richtext(document.body, {
146146
// full toolbar
147147
toolbarBlocks: ["default", "clear", "stats", "fullscreen"]
148148
});
149149
~~~
150150

151151
### Custom toolbar
152152

153-
It is also possible to create a custom toolbar by setting desired blocks in the random order:
153+
It is also possible to create a custom Toolbar by setting desired blocks in the random order:
154154

155155
~~~jsx
156-
var richtext = new dhx.RichText(document.body, {
156+
var richtext = new dhx.Richtext(document.body, {
157157
toolbarBlocks: ["clear", "colors", "align", "decoration",
158158
"undo", "fullscreen", "link"
159159
]

docs/api/toolbar_controls.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
sidebar_label: Toolbar controls
33
title: Toolbar controls
4-
description: Learn how to add custom toolbar controls and configure them to your requirements using the available API properties of DHTMLX Rich Text Editor.
4+
description: Learn how to add custom Toolbar controls and configure them to your requirements using the available API properties of DHTMLX Rich Text Editor.
55
---
66

7-
Besides using the [default](guides/customization.md#default-controls) controls of the toolbar, you can customize the toolbar by adding the following controls:
7+
Besides using the [default](guides/customization.md#default-controls) controls of the toolbar, you can customize the Toolbar by adding the following controls:
88

99
## `Button`
1010

@@ -56,7 +56,7 @@ An item that contains any custom HTML content (for example, an image, icon or ot
5656

5757
```js
5858
richtext.toolbar.data.add({
59-
type: "customHTML",
59+
type: "customHTML",
6060
id: "htmlbutton-id",
6161
value: "Some value",
6262
icon: "icon-name"
@@ -84,7 +84,7 @@ A button with an image
8484

8585
```js
8686
richtext.toolbar.data.add({
87-
type: "imageButton",
87+
type: "imageButton",
8888
count: 10,
8989
src: "../img/avatar.png"
9090
}, 3);
@@ -113,7 +113,7 @@ A button that contains a drop-down list of options
113113

114114
```js
115115
richtext.toolbar.data.add({
116-
id: "select_button",
116+
id: "select_button",
117117
type: "selectButton",
118118
value: "1",
119119
items: [
@@ -135,7 +135,7 @@ richtext.toolbar.data.add({
135135

136136
## `Separator`
137137

138-
A horizontal (between menu options) or vertical (between toolbar controls) line separating items/groups of items from each other
138+
A horizontal (between menu options) or vertical (between Toolbar controls) line separating items/groups of items from each other
139139

140140

141141
| Properties | Type | Description |
@@ -145,13 +145,13 @@ A horizontal (between menu options) or vertical (between toolbar controls) line
145145

146146
```js
147147
richtext.toolbar.data.add({
148-
type:"separator"
148+
type:"separator"
149149
}, 4);
150150
```
151151

152152
## `Spacer`
153153

154-
The item takes space on the toolbar and is used for aligning controls
154+
The item takes space on the Toolbar and is used for aligning controls
155155

156156

157157
| Properties | Type | Description |
@@ -161,6 +161,6 @@ The item takes space on the toolbar and is used for aligning controls
161161

162162
```js
163163
richtext.toolbar.data.add({
164-
type:"spacer"
164+
type:"spacer"
165165
}, 4);
166166
```

docs/api/toolbar_methods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: Toolbar methods
33
title: Toolbar methods
4-
description: Check the list of API methods of DHTMLX Rich Text Editor enabling you to add and remove toolbar controls as well as update their configuration.
4+
description: Check the list of API methods of DHTMLX Rich Text Editor enabling you to add and remove Toolbar controls as well as update their configuration.
55
---
66

77

0 commit comments

Comments
 (0)