Skip to content

Commit aba23eb

Browse files
[dev] refactoring
1 parent 778f6e9 commit aba23eb

72 files changed

Lines changed: 3666 additions & 823 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api/config/default-styles.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: defaultStyles
3+
title: defaultStyles Config
4+
description: You can learn about the defaultStyles config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# defaultStyles
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
defaultStyles?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
defaultStyles: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)

docs/api/config/fullscreen.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: fullscreen
3+
title: fullscreen Config
4+
description: You can learn about the fullscreen config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# fullscreen
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
fullscreen?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
fullscreen: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: imageUploadUrl
3+
title: imageUploadUrl Config
4+
description: You can learn about the imageUploadUrl config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# imageUploadUrl
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
imageUploadUrl?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
imageUploadUrl: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)

docs/api/config/layout-mode.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: layoutMode
3+
title: layoutMode Config
4+
description: You can learn about the layoutMode config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# layoutMode
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
layoutMode?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
layoutMode: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)

docs/api/config/menubar.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: menubar
3+
title: menubar Config
4+
description: You can learn about the menubar config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# menubar
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
menubar?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
menubar: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)

docs/api/config/toolbar.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: toolbar
3+
title: toolbar Config
4+
description: You can learn about the toolbar config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# toolbar
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
toolbar?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
toolbar: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)

docs/api/config/value.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
sidebar_label: value
3+
title: value Config
4+
description: You can learn about the value config in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# value
8+
9+
### Description
10+
11+
@short: Optional. ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
value?: ...;
17+
~~~
18+
19+
### Example
20+
21+
~~~jsx {4}
22+
new richtext.Richtext("#root", {
23+
value: ...
24+
// other parameters
25+
});
26+
~~~
27+
28+
**Change log:** The property was added in v2.0
29+
30+
**Related articles:** [Configuration](../../../guides/configuration)
31+
32+
**Related sample:** [Richtext. Lazy rendering and column scroll](https://snippet.dhtmlx.com/...)

docs/api/editor_api_methods.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Returns the data model of the entered text in the JSON format
110110

111111

112112
```js
113-
var model = richtext.getEditorAPI().getModel();
113+
const model = richtext.getEditorAPI().getModel();
114114
```
115115

116116
**Related samples:** [RichText. Get Model](https://snippet.dhtmlx.com/ef6uolvq)
@@ -164,7 +164,7 @@ Returns the position of text selection relative to the browser window
164164
| `object` | the position of text selection relative to the browser window |
165165

166166
```js
167-
var position = richtext.getEditorAPI().getPosition();
167+
const position = richtext.getEditorAPI().getPosition();
168168
```
169169

170170
**Related samples:** [RichText. Get Position](https://snippet.dhtmlx.com/nv42vsjg)
@@ -204,7 +204,7 @@ Returns the position of text selection relative to all other text
204204

205205

206206
```js
207-
var selection = richtext.getEditorAPI().getSelection();
207+
const selection = richtext.getEditorAPI().getSelection();
208208
```
209209

210210
**Related samples:** [RichText. Get Selection](https://snippet.dhtmlx.com/se4p4vin)
@@ -251,7 +251,7 @@ Removes a selected text
251251

252252

253253
```js
254-
var api = richtext.getEditorAPI();
254+
const api = richtext.getEditorAPI();
255255

256256
richtext.getEditorAPI().remove(api.getSelection());
257257
```
@@ -393,7 +393,7 @@ Modifies the entered text
393393

394394

395395
```js
396-
var api = richtext.getEditorAPI();
396+
const api = richtext.getEditorAPI();
397397

398398
richtext.getEditorAPI().update(
399399
{

docs/api/events/align.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
sidebar_label: align
3+
title: align Event
4+
description: You can learn about the align event in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# align
8+
9+
### Description
10+
11+
@short: Fires when ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
"align": ...;
17+
~~~
18+
19+
### Parameters
20+
21+
The callback of the **align** event can take an object with the following parameters:
22+
23+
...
24+
25+
:::info
26+
For handling the inner events you can use the [**Event Bus methods**](api/overview/main_overview.md/#event-bus-methods)
27+
:::
28+
29+
### Example
30+
31+
~~~jsx {7-9}
32+
// create RichText
33+
const editor = new richtext.Richtext("#root", {
34+
...
35+
});
36+
// subscribe on the "align" event
37+
editor.api.on("align", (obj) => {
38+
console.log(obj);
39+
});
40+
~~~
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
sidebar_label: clear-text-format
3+
title: clear-text-format Event
4+
description: You can learn about the clear-text-format event in the documentation of the DHTMLX JavaScript RichText library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX RichText.
5+
---
6+
7+
# clear-text-format
8+
9+
### Description
10+
11+
@short: Fires when ...
12+
13+
### Usage
14+
15+
~~~jsx {}
16+
"clear-text-format": ...;
17+
~~~
18+
19+
### Parameters
20+
21+
The callback of the **clear-text-format** event can take an object with the following parameters:
22+
23+
...
24+
25+
:::info
26+
For handling the inner events you can use the [**Event Bus methods**](api/overview/main_overview.md/#event-bus-methods)
27+
:::
28+
29+
### Example
30+
31+
~~~jsx {7-9}
32+
// create RichText
33+
const editor = new richtext.Richtext("#root", {
34+
...
35+
});
36+
// subscribe on the "clear-text-format" event
37+
editor.api.on("clear-text-format", (obj) => {
38+
console.log(obj);
39+
});
40+
~~~

0 commit comments

Comments
 (0)