You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/advanced/keyboard-shortcuts.adoc
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -205,6 +205,7 @@ NOTE: Browsers and Screen Readers provide additional shortcuts within the editor
205
205
206
206
include::partial$misc/advcode-shortcuts.adoc[]
207
207
208
+
[[addcustomshortcutstotinymce]]
208
209
== Add custom shortcuts to TinyMCE
209
210
210
211
IMPORTANT: Adding a custom shortcut with a keyboard combination that conflicts with an existing {productname} or browser shortcut will override the existing shortcut.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/ui-components/autocompleter.adoc
+18-11Lines changed: 18 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,20 +61,21 @@ The two arguments this method take are:
61
61
| highlight
62
62
| array
63
63
| Optional
64
-
| When using <<cardmenuitem,CardMenuItems>>, use the highlight option to specify which <<cardtext,CardText>> items to highlight the matched text pattern on.
64
+
| When using xref:cardmenuitem[CardMenuItems], use the highlight option to specify which xref:cardtext[CardText] items to highlight the matched text pattern on.
65
65
|===
66
66
67
67
NOTE: If two or more autocompleters use the same trigger character, then the fetched results will be merged together before being displayed.
68
68
69
69
=== Usage of fetch
70
70
71
-
The `fetch` function is called when the trigger `char` is pressed and the `matches` predicate returns `true`. The `fetch` function is passed the matched text pattern and returns a https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise[Promise] containing matching results, specified as either <<autocompleteitem,AutocompleteItems>> or <<cardmenuitem,CardMenuItems>>. This allows for asynchronous fetching of the items. The `fetchOptions` parameter passed to the `fetch` function is by default an empty object, however using the <<api,reload>> API, additional options can be passed to fetch a different set of results.
71
+
The `fetch` function is called when the trigger `char` is pressed and the `matches` predicate returns `true`. The `fetch` function is passed the matched text pattern and returns a https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise[Promise] containing matching results, specified as either xref:autocompleteitem[AutocompleteItems] or xref:cardmenuitem[CardMenuItems]. This allows for asynchronous fetching of the items. The `fetchOptions` parameter passed to the `fetch` function is by default an empty object, however using the xref:api[reload] API, additional options can be passed to fetch a different set of results.
72
72
73
73
There are two types of items:
74
74
75
-
* <<autocompleteitem,AutocompleteItem>>
76
-
* <<cardmenuitem,CardMenuItem>>
75
+
* xref:autocompleteitem[AutocompleteItem]
76
+
* xref:cardmenuitem[CardMenuItem]
77
77
78
+
[[autocompleteitem]]
78
79
==== AutocompleteItem
79
80
80
81
This is the standard item for the autocompleter. If no type is specified, autocompleter items are assumed to be of type `AutocompleteItem`.
@@ -95,7 +96,7 @@ This is the standard item for the autocompleter. If no type is specified, autoco
95
96
| icon
96
97
| string
97
98
| optional
98
-
| Name of the icon to be displayed. Must be a either single unicode character or an icon from: the link:{baseurl}/advanced/editor-icon-identifiers/[icon pack], a link:{baseurl}/advanced/creating-an-icon-pack/[custom icon pack], or an icon added using the xref:apis/tinymce.editor.ui.registry.adoc#addIcon[`addIcon` API].
99
+
| Name of the icon to be displayed. Must be a either single unicode character or an icon from: the xref:advanced/editor-icon-identifiers.adoc[icon pack], a xref:advanced/creating-an-icon-pack.adoc[custom icon pack], or an icon added using the xref:apis/tinymce.editor.ui.registry.adoc#addIcon[`addIcon` API].
99
100
|===
100
101
101
102
[source, js]
@@ -121,7 +122,7 @@ The `CardMenuItem` allows customization of layout and content. This is done by c
121
122
| items
122
123
| array
123
124
| required
124
-
| An array of <<carditems,CardItems>>
125
+
| An array of xref:carditems[CardItems]
125
126
126
127
| value
127
128
| string
@@ -144,15 +145,18 @@ The `CardMenuItem` allows customization of layout and content. This is done by c
144
145
}
145
146
----
146
147
148
+
[[carditems]]
147
149
==== CardItems
148
150
149
151
`CardItems` are subcomponents for the `CardMenuItem`. Use these to construct your custom item and display relevant information to the user.
150
152
151
153
There are three types of card items:
152
-
* <<cardcontainer,CardContainer>>
153
-
* <<cardtext,CardText>>
154
-
* <<cardimage,CardImage>>
155
154
155
+
* xref:cardcontainer[CardContainer]
156
+
* xref:cardtext[CardText]
157
+
* xref:cardimage[CardImage]
158
+
159
+
[[cardcontainer]]
156
160
===== CardContainer
157
161
158
162
A `CardContainer` is a layout component used to apply a layout to an array of card items.
@@ -163,7 +167,7 @@ A `CardContainer` is a layout component used to apply a layout to an array of ca
163
167
| items
164
168
| array
165
169
| required
166
-
| An array of <<carditem,CardItems>>
170
+
| An array of xref:carditems[CardItems]
167
171
168
172
| direction
169
173
| `'vertical'` or `'horizontal'`
@@ -192,6 +196,7 @@ A `CardContainer` is a layout component used to apply a layout to an array of ca
192
196
}
193
197
----
194
198
199
+
[[cardtext]]
195
200
===== CardText
196
201
197
202
`CardText` is a component for displaying text.
@@ -225,6 +230,7 @@ A `CardContainer` is a layout component used to apply a layout to an array of ca
225
230
}
226
231
----
227
232
233
+
[[cardimage]]
228
234
===== CardImage
229
235
230
236
`CardImage` is a component for displaying an image.
@@ -258,6 +264,7 @@ A `CardContainer` is a layout component used to apply a layout to an array of ca
Copy file name to clipboardExpand all lines: modules/ROOT/pages/ui-components/contextmenu.adoc
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
:keywords: contextmenu context menu contextmenuapi
4
4
:title_nav: Context menu
5
5
6
-
The context menu is a configurable component that appears when the user right clicks in the editable area. By default it does not disable the operating system's native context menu, if there are no items to display at the cursor position the native context menu will be shown.
6
+
The context menu is a configurable component that appears when the user right clicks in the editable area. By default, it does not disable the operating system's native context menu, if there are no items to display at the cursor position the native context menu will be shown.
7
7
8
8
The context menu supports both individual menu items and dynamic context menu sections.
9
9
@@ -73,19 +73,20 @@ When creating a dynamic menu, the structure `type` properties are used in order
73
73
* type `separator` ignores all other properties.
74
74
75
75
////
76
-
- ## Example Usage
76
+
=== Example Usage
77
77
78
78
This example creates a menu with a mixture of dynamic and static menu items. While `link` is the name of both a context menu section and a menu item, context menu sections take preference (the link context menu is dynamic based on the cursor position).
79
79
80
80
The other item names are all menu items and will appear on the context menu regardless of cursor position. A separator is used to distinguish the table edit features from the table insert feature. As `link` is a context menu section, a separator will automatically be inserted after it so it is not necessary to specify one in the configuration.
A context toolbar can only contain either buttons that are defined for a normal toolbar, or buttons specifically registered for launching a link:{baseurl}/ui-components/contextform/[ContextForm]. The buttons comes as a list of strings, where each string is a registered name of a button.
6
+
A context toolbar can only contain either buttons that are defined for a normal toolbar, or buttons specifically registered for launching a xref:ui-components/contextform.adoc[ContextForm]. The buttons come as a list of strings, where each string is a registered name of a button.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/ui-components/customsidebar.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The sidebar API allows developers to add sidebars on editor instances in a simil
12
12
13
13
This is the syntax for the addSidebar function: `editor.ui.registry.addSidebar(name:String, spec:Object)`
14
14
15
-
When a new sidebar is registered, a corresponding toolbar button for toggling the sidebar open and close is also created using the same name. This button can then be included in the toolbar by adding the sidebar name to the link:{baseurl}/configure/editor-appearance/#toolbar/[`toolbar`] option.
15
+
When a new sidebar is registered, a corresponding toolbar button for toggling the sidebar open and close is also created using the same name. This button can then be included in the toolbar by adding the sidebar name to the xref:configure/editor-appearance.adoc#toolbar[`toolbar`] option.
16
16
17
17
=== Specification object
18
18
@@ -24,7 +24,7 @@ The `tooltip` specifies a tooltip to be displayed when hovering over the sidebar
24
24
25
25
==== `icon`
26
26
27
-
The `icon` specifies an icon for the sidebar toggle button. The icon should be the name of an icon provided by the {productname} skin or a xref:apis/tinymce.editor.ui.registry.adoc#addIcon/[custom icon].
27
+
The `icon` specifies an icon for the sidebar toggle button. The icon should be the name of an icon provided by the {productname} skin or a xref:apis/tinymce.editor.ui.registry.adoc#addIcon[custom icon].
0 commit comments