Skip to content

Commit 52593c5

Browse files
serhiipylypchuk1991serhiipylypchuk1991
committed
[add] overview pages
1 parent 9d09b77 commit 52593c5

7 files changed

Lines changed: 226 additions & 24 deletions

File tree

‎docs/api/overview/event_bus_methods_overview.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_label: Event Bus methods
3+
title: Event Bus Methods
4+
description: You can have an Internal Event Bus methods overview of JavaScript RichText 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+
# Event Bus methods
8+
9+
This page provides a list of methods related to the internal Event Bus used by the DHTMLX RichText editor.
10+
These methods are designed for advanced integrations and custom behavior based on the internal event system.
11+
12+
| Name | Description |
13+
| ------------------------------------------------- | -------------------------------------------- |
14+
| [](../internal/detach.md) | @getshort(../internal/detach.md) |
15+
| [](../internal/exec.md) | @getshort(../internal/exec.md) |
16+
| [](../internal/intercept.md) | @getshort(../internal/intercept.md) |
17+
| [](../internal/on.md) | @getshort(../internal/on.md) |
18+
| [](../internal/set-next.md) | @getshort(../internal/set-next.md) |

‎docs/api/overview/events_overview.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
sidebar_label: Events overview
3+
title: Events Overview
4+
description: You can have an Events overview of JavaScript Kanban in the documentation of the DHTMLX JavaScript Kanban library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Kanban.
5+
---
6+
7+
# Events overview
8+
9+
This page lists all events emitted by the DHTMLX RichText editor.
10+
You can use these events to extend functionality, track user interaction, or trigger custom behavior.
11+
12+
| Name | Description |
13+
| ------------------------------------------------------ | --------------------------------------------- |
14+
| [](../events/align.md) | @getshort(../events/align.md) |
15+
| [](../events/clear-text-format.md) | @getshort(../events/clear-text-format.md) |
16+
| [](../events/copy.md) | @getshort(../events/copy.md) |
17+
| [](../events/create-new.md) | @getshort(../events/create-new.md) |
18+
| [](../events/cut.md) | @getshort(../events/cut.md) |
19+
| [](../events/delete-link.md) | @getshort(../events/delete-link.md) |
20+
| [](../events/export.md) | @getshort(../events/export.md) |
21+
| [](../events/import.md) | @getshort(../events/import.md) |
22+
| [](../events/indent.md) | @getshort(../events/indent.md) |
23+
| [](../events/insert-image.md) | @getshort(../events/insert-image.md) |
24+
| [](../events/insert-line.md) | @getshort(../events/insert-line.md) |
25+
| [](../events/insert-link.md) | @getshort(../events/insert-link.md) |
26+
| [](../events/insert-list.md) | @getshort(../events/insert-list.md) |
27+
| [](../events/outdent.md) | @getshort(../events/outdent.md) |
28+
| [](../events/paste.md) | @getshort(../events/paste.md) |
29+
| [](../events/print.md) | @getshort(../events/print.md) |
30+
| [](../events/redo.md) | @getshort(../events/redo.md) |
31+
| [](../events/resize-image.md) | @getshort(../events/resize-image.md) |
32+
| [](../events/set-font-family.md) | @getshort(../events/set-font-family.md) |
33+
| [](../events/set-font-size.md) | @getshort(../events/set-font-size.md) |
34+
| [](../events/set-line-height.md) | @getshort(../events/set-line-height.md) |
35+
| [](../events/set-text-color.md) | @getshort(../events/set-text-color.md) |
36+
| [](../events/set-text-format.md) | @getshort(../events/set-text-format.md) |
37+
| [](../events/set-text-style.md) | @getshort(../events/set-text-style.md) |
38+
| [](../events/show-popup.md) | @getshort(../events/show-popup.md) |
39+
| [](../events/subscript.md) | @getshort(../events/subscript.md) |
40+
| [](../events/superscript.md) | @getshort(../events/superscript.md) |
41+
| [](../events/toggle-fullscreen-mode.md) | @getshort(../events/toggle-fullscreen-mode.md)|
42+
| [](../events/toggle-layout-mode.md) | @getshort(../events/toggle-layout-mode.md) |
43+
| [](../events/toggle-shortcut-info.md) | @getshort(../events/toggle-shortcut-info.md) |
44+
| [](../events/undo.md) | @getshort(../events/undo.md) |
45+
| [](../events/update-link.md) | @getshort(../events/update-link.md) |

‎docs/api/overview/main_overview.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
sidebar_label: API overview
3+
title: API Overview
4+
description: You can have an API overview of JavaScript RichText 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+
# API overview
8+
9+
## RichText constructor
10+
11+
~~~js
12+
new richtext.RichText("#root", {
13+
// configuration parameters
14+
});
15+
~~~
16+
17+
**Parameters**:
18+
19+
- an HTML container (e.g., CSS selector or DOM element)
20+
- a configuration object ([see properties](api/overview/properties_overview.md))
21+
22+
## RichText methods
23+
24+
| Name | Description |
25+
| ----------------------------------------------|-------------------------------------------|
26+
| [](../methods/get-value.md) | @getshort(../methods/get-value.md) |
27+
| [](../methods/set-value.md) | @getshort(../methods/set-value.md) |
28+
| [](../methods/set-config.md) | @getshort(../methods/set-config.md) |
29+
| [](../methods/set-locale.md) | @getshort(../methods/set-locale.md) |
30+
| [](../methods/destructor.md) | @getshort(../methods/destructor.md) |
31+
32+
## Event Bus methods
33+
34+
| Name | Description |
35+
| ----------------------------------------------|-------------------------------------------|
36+
| [](../internal/exec.md) | @getshort(../internal/exec.md) |
37+
| [](../internal/intercept.md) | @getshort(../internal/intercept.md) |
38+
| [](../internal/on.md) | @getshort(../internal/on.md) |
39+
| [](../internal/detach.md) | @getshort(../internal/detach.md) |
40+
| [](../internal/set-next.md) | @getshort(../internal/set-next.md) |
41+
42+
## State methods
43+
44+
| Name | Description |
45+
| ----------------------------------------------|-------------------------------------------|
46+
| [](../internal/get-state.md) | @getshort(../internal/get-state.md) |
47+
| [](../internal/get-reactive-state.md) | @getshort(../internal/get-reactive-state.md) |
48+
49+
## Events
50+
51+
| Name | Description |
52+
| ----------------------------------------------|-------------------------------------------|
53+
| [](../events/align.md) | @getshort(../events/align.md) |
54+
| [](../events/clear-text-format.md) | @getshort(../events/clear-text-format.md) |
55+
| [](../events/copy.md) | @getshort(../events/copy.md) |
56+
| [](../events/create-new.md) | @getshort(../events/create-new.md) |
57+
| [](../events/cut.md) | @getshort(../events/cut.md) |
58+
| [](../events/delete-link.md) | @getshort(../events/delete-link.md) |
59+
| [](../events/export.md) | @getshort(../events/export.md) |
60+
| [](../events/import.md) | @getshort(../events/import.md) |
61+
| [](../events/indent.md) | @getshort(../events/indent.md) |
62+
| [](../events/insert-image.md) | @getshort(../events/insert-image.md) |
63+
| [](../events/insert-line.md) | @getshort(../events/insert-line.md) |
64+
| [](../events/insert-link.md) | @getshort(../events/insert-link.md) |
65+
| [](../events/insert-list.md) | @getshort(../events/insert-list.md) |
66+
| [](../events/outdent.md) | @getshort(../events/outdent.md) |
67+
| [](../events/paste.md) | @getshort(../events/paste.md) |
68+
| [](../events/print.md) | @getshort(../events/print.md) |
69+
| [](../events/redo.md) | @getshort(../events/redo.md) |
70+
| [](../events/resize-image.md) | @getshort(../events/resize-image.md) |
71+
| [](../events/set-font-family.md) | @getshort(../events/set-font-family.md) |
72+
| [](../events/set-font-size.md) | @getshort(../events/set-font-size.md) |
73+
| [](../events/set-line-height.md) | @getshort(../events/set-line-height.md) |
74+
| [](../events/set-text-color.md) | @getshort(../events/set-text-color.md) |
75+
| [](../events/set-text-format.md) | @getshort(../events/set-text-format.md) |
76+
| [](../events/set-text-style.md) | @getshort(../events/set-text-style.md) |
77+
| [](../events/show-popup.md) | @getshort(../events/show-popup.md) |
78+
| [](../events/subscript.md) | @getshort(../events/subscript.md) |
79+
| [](../events/superscript.md) | @getshort(../events/superscript.md) |
80+
| [](../events/toggle-fullscreen-mode.md) | @getshort(../events/toggle-fullscreen-mode.md) |
81+
| [](../events/toggle-layout-mode.md) | @getshort(../events/toggle-layout-mode.md) |
82+
| [](../events/toggle-shortcut-info.md) | @getshort(../events/toggle-shortcut-info.md) |
83+
| [](../events/undo.md) | @getshort(../events/undo.md) |
84+
| [](../events/update-link.md) | @getshort(../events/update-link.md) |
85+
86+
## Properties
87+
88+
| Name | Description |
89+
| ----------------------------------------------|-------------------------------------------|
90+
| [](../config/default-styles.md) | @getshort(../config/default-styles.md) |
91+
| [](../config/fullscreen-mode.md) | @getshort(../config/fullscreen-mode.md) |
92+
| [](../config/image-upload-url.md) | @getshort(../config/image-upload-url.md) |
93+
| [](../config/layout-mode.md) | @getshort(../config/layout-mode.md) |
94+
| [](../config/locale.md) | @getshort(../config/locale.md) |
95+
| [](../config/menubar.md) | @getshort(../config/menubar.md) |
96+
| [](../config/toolbar.md) | @getshort(../config/toolbar.md) |
97+
| [](../config/value.md) | @getshort(../config/value.md) |

‎docs/api/overview/methods_overview.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_label: Methods overview
3+
title: Methods Overview
4+
description: You can have a Methods overview of JavaScript RichText 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+
# Methods overview
8+
9+
This page provides a summary of the core methods available in the DHTMLX RichText editor.
10+
Use this reference to quickly navigate to detailed descriptions of each method, understand their purpose, and see usage examples.
11+
12+
| Name | Description |
13+
| ------------------------------------------------------ | ----------------------------------------- |
14+
| [](../methods/destructor.md) | @getshort(../methods/destructor.md) |
15+
| [](../methods/get-value.md) | @getshort(../methods/get-value.md) |
16+
| [](../methods/set-value.md) | @getshort(../methods/set-value.md) |
17+
| [](../methods/set-config.md) | @getshort(../methods/set-config.md) |
18+
| [](../methods/set-locale.md) | @getshort(../methods/set-locale.md) |

‎docs/api/overview/properties_overview.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
sidebar_label: Properties overview
3+
title: Properties Overview
4+
description: You can have a Properties overview of JavaScript RichText 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+
# Properties overview
8+
9+
This page lists all configuration properties that can be used when initializing the DHTMLX RichText editor.
10+
They help you control layout, toolbar, value, localization, and other aspects of the editor.
11+
12+
| Name | Description |
13+
| --------------------------------------------------------|----------------------------------------------|
14+
| [](../config/default-styles.md) | @getshort(../config/default-styles.md) |
15+
| [](../config/fullscreen-mode.md) | @getshort(../config/fullscreen-mode.md) |
16+
| [](../config/image-upload-url.md) | @getshort(../config/image-upload-url.md) |
17+
| [](../config/layout-mode.md) | @getshort(../config/layout-mode.md) |
18+
| [](../config/locale.md) | @getshort(../config/locale.md) |
19+
| [](../config/menubar.md) | @getshort(../config/menubar.md) |
20+
| [](../config/toolbar.md) | @getshort(../config/toolbar.md) |
21+
| [](../config/value.md) | @getshort(../config/value.md) |

‎docs/api/overview/state_methods_overview.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_label: State methods
3+
title: State Methods
4+
description: You can have an Internal State methods overview of JavaScript RichText 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+
# State methods
8+
9+
This page lists methods for accessing and working with the internal state of the DHTMLX RichText editor.
10+
These methods are useful for debugging, integrating with reactive systems, or implementing advanced custom logic.
11+
12+
| Name | Description |
13+
| ----------------------------------------------------------- | ------------------------------------------------ |
14+
| [](../internal/get-reactive-state.md) | @getshort(../internal/get-reactive-state.md) |
15+
| [](../internal/get-state.md) | @getshort(../internal/get-state.md) |

‎sidebars.js‎

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,8 @@ module.exports = {
3131
collapsible: true,
3232
collapsed: false,
3333
link: {
34-
type: "generated-index",
35-
title: "RichText API",
36-
keywords: ["api", "methods", "properties", "events"],
37-
image: "/img/docusaurus.png"
34+
type: "doc",
35+
id: "api/overview/main_overview"
3836
},
3937
items: [
4038
// JS RichText methods
@@ -44,10 +42,8 @@ module.exports = {
4442
collapsible: true,
4543
collapsed: true,
4644
link: {
47-
type: "generated-index",
48-
title: "RichText methods",
49-
keywords: ["methods"],
50-
image: "/img/docusaurus.png"
45+
type: "doc",
46+
id: "api/overview/methods_overview"
5147
},
5248
items: [
5349
"api/methods/destructor",
@@ -76,10 +72,8 @@ module.exports = {
7672
collapsible: true,
7773
collapsed: true,
7874
link: {
79-
type: "generated-index",
80-
title: "Event Bus methods",
81-
keywords: ["internal api"],
82-
image: "/img/docusaurus.png"
75+
type: "doc",
76+
id: "api/overview/event_bus_methods_overview"
8377
},
8478
items: [
8579
"api/internal/detach",
@@ -95,10 +89,8 @@ module.exports = {
9589
collapsible: true,
9690
collapsed: true,
9791
link: {
98-
type: "generated-index",
99-
title: "State methods",
100-
keywords: ["internal api"],
101-
image: "/img/docusaurus.png"
92+
type: "doc",
93+
id: "api/overview/state_methods_overview"
10294
},
10395
items: [
10496
"api/internal/get-reactive-state",
@@ -114,10 +106,8 @@ module.exports = {
114106
collapsible: true,
115107
collapsed: true,
116108
link: {
117-
type: "generated-index",
118-
title: "RichText events",
119-
keywords: ["internal api"],
120-
image: "/img/docusaurus.png"
109+
type: "doc",
110+
id: "api/overview/events_overview"
121111
},
122112
items: [
123113
"api/events/align",
@@ -161,10 +151,8 @@ module.exports = {
161151
collapsible: true,
162152
collapsed: true,
163153
link: {
164-
type: "generated-index",
165-
title: "RichText properties",
166-
keywords: ["properties"],
167-
image: "/img/docusaurus.png"
154+
type: "doc",
155+
id: "api/overview/properties_overview"
168156
},
169157
items: [
170158
"api/config/default-styles",

0 commit comments

Comments
 (0)