|
1 | | -= TinyMCE for touch-enabled and mobile devices |
| 1 | += TinyMCE for Touch-Enabled and Mobile Devices |
2 | 2 | :navtitle: TinyMCE for mobile |
3 | 3 | :description: The TinyMCE rich text editing experience for mobile devices. |
4 | 4 | :keywords: mobile, tablet, phone |
5 | 5 |
|
6 | | -The mobile experience for {productname} is enabled by default and has the following differences when compared to the "desktop" experience: |
| 6 | +The mobile editing experience for {productname} is enabled by default. It differs from the desktop version in several key ways to provide a responsive and touch-optimized interface: |
7 | 7 |
|
8 | | -* Horizontal contextual menus on mobile. |
9 | | -* Side-scrolling toolbars and contextual menus on mobile. |
10 | | -* Contextual keyboard options for dialogs using xref:dialog-components.adoc#inputmode[`+inputMode+`]. |
11 | | -* xref:mobile-defaults-for-selected-options[Mobile defaults for selected options]. |
| 8 | +* Horizontal and side-scrolling toolbars and contextual menus. |
| 9 | +* Context-sensitive keyboard behavior using xref:dialog-components.adoc#inputmode[`+inputMode+`]. |
| 10 | +* Predefined mobile-specific default values for selected configuration options. |
| 11 | +* Touch gestures for accessing the context menu, depending on platform. |
12 | 12 |
|
13 | | -{productname} plugins on mobile devices, that have known issues: |
| 13 | +{productname} automatically detects the platform and displays an optimal UI based on screen size and device type. |
| 14 | + |
| 15 | +[TIP] |
| 16 | +==== |
| 17 | +The native context menu remains accessible on mobile devices even when a custom {productname} context menu is configured. On iOS, this is done with a _single tap_; on Android, a _double tap_ is required. If the xref:contextmenu.adoc#contextmenu_never_use_native[`+contextmenu_never_use_native+`] option is enabled, native menu access is disabled on both platforms. |
| 18 | +==== |
| 19 | + |
| 20 | +NOTE: iPads are treated as desktop-class devices due to Apple's environment constraints. While the `+mobile+` configuration will not apply on iPads, touch interactions such as context toolbars and menus will still behave as expected. |
| 21 | + |
| 22 | +include::partial$misc/admon-mobile-context-menus.adoc[] |
| 23 | + |
| 24 | +include::partial$misc/mobile-platform-compatibility.adoc[] |
| 25 | + |
| 26 | +== Mobile Plugin Limitations |
| 27 | + |
| 28 | +Some plugins offer limited functionality or are unsupported when used on mobile devices, particularly in inline mode. |
| 29 | + |
| 30 | +=== Known Plugin Limitations |
14 | 31 |
|
15 | 32 | [cols="1,3", options="header"] |
16 | 33 | |=== |
17 | 34 | |Feature |
18 | 35 | |Limitation |
19 | 36 |
|
20 | 37 | |xref:editimage.adoc[Image Editing] |
21 | | -|Unable to resize images automatically within the editor without using the Edit Image dialog properties. |
| 38 | +|Image resizing is only available through the Edit Image dialog; in-editor resizing is not supported. |
22 | 39 |
|
23 | 40 | |xref:autoresize.adoc[Autoresize] |
24 | | -|Resizing is not applicable in inline mode. |
| 41 | +|Automatic resizing is not applicable when using inline mode. |
25 | 42 |
|
26 | 43 | |xref:fullscreen.adoc[Full Screen] |
27 | | -|Only available in `classic` Editing mode. |
| 44 | +|The Full Screen plugin is only available in `classic` editing mode. |
28 | 45 |
|
29 | 46 | |xref:introduction-to-powerpaste.adoc[PowerPaste] |
30 | | -|Clipboard limitations on mobile block core functionality. |
| 47 | +|Clipboard restrictions on mobile platforms prevent core PowerPaste functionality. |
31 | 48 | |=== |
32 | 49 |
|
33 | | - |
34 | | -[TIP] |
35 | | -The native context menu on a mobile device can still be accessed with a {productname} context menu configured, either by a _single tap_ on iOS, or by a _double tap_ on Android. However if the xref:contextmenu.adoc#contextmenu_never_use_native[`+contextmenu_never_use_native+`] option is enabled, neither _single_ nor _double tap_ will have any effect. |
36 | | - |
37 | | -{productname} plugins that are unsupported on mobile devices: |
| 50 | +=== Unsupported Plugins on Mobile |
38 | 51 |
|
39 | 52 | [cols="1,3", options="header"] |
40 | 53 | |=== |
41 | 54 | |Feature |
42 | 55 | |Limitation |
43 | 56 |
|
44 | 57 | |xref:introduction-to-tiny-comments.adoc[Comments] |
45 | | -|Not applicable in inline mode. |
| 58 | +|Not supported in inline mode on mobile devices. |
46 | 59 |
|
47 | 60 | |xref:moxiemanager.adoc[MoxieManager] |
48 | | -|Not applicable in inline mode. |
| 61 | +|Not supported in inline mode. |
49 | 62 |
|
50 | 63 | |xref:permanentpen.adoc[Permanent Pen] |
51 | | -|Not applicable due to mobile UX constraints. |
| 64 | +|Not supported due to UX constraints on mobile. |
52 | 65 |
|
53 | 66 | |xref:advcode.adoc[Enhanced Code Editor] |
54 | | -|Dialog is currently not usable in mobile viewports. |
| 67 | +|Dialog interface is not usable in mobile viewports. |
55 | 68 |
|
56 | 69 | |xref:footnotes.adoc[Footnotes] |
57 | | -|Links for created footnotes are not clickable after insertion. |
| 70 | +|Inserted footnote links are not clickable after insertion. |
58 | 71 | |=== |
59 | 72 |
|
60 | | -{productname} will detect the platform and show an optimal UI experience based on the device type and screen size. |
61 | | - |
62 | | -NOTE: iPads do not use the `+mobile+` part of the {productname} init configuration. This is due to a constraint added by Apple to return the environment as a "desktop environment" for iPads. iPad users will receive the other changes to touch functionality, such as context toolbars and context menus. |
63 | | - |
64 | | -include::partial$misc/admon-mobile-context-menus.adoc[] |
65 | | - |
66 | | -include::partial$misc/mobile-platform-compatibility.adoc[] |
| 73 | +== Configuring Mobile Behavior |
67 | 74 |
|
68 | | -== Configuring mobile |
69 | | - |
70 | | -Add the following `+meta+` tag to the `+head+` of pages using {productname} to ensure the mobile user interface functions as intended. |
| 75 | +To ensure the {productname} mobile UI functions correctly, include the following `+meta+` tag in the `+<head>+` of your HTML: |
71 | 76 |
|
72 | 77 | [source,html] |
73 | 78 | ---- |
74 | 79 | <meta name="viewport" content="width=device-width, initial-scale=1"> |
75 | 80 | ---- |
76 | 81 |
|
77 | | -To set mobile specific options, add the option to xref:themobileoption[the `+mobile+` option] configuration, such as: |
| 82 | +To customize behavior on mobile devices, use the `+mobile+` configuration option. For example: |
78 | 83 |
|
79 | 84 | [source,js] |
80 | 85 | ---- |
81 | 86 | tinymce.init({ |
82 | | - selector: 'textarea', // change this value according to your HTML |
| 87 | + selector: 'textarea', // Adjust this value to match your HTML |
83 | 88 | mobile: { |
84 | 89 | menubar: true |
85 | 90 | } |
86 | 91 | }); |
87 | 92 | ---- |
88 | 93 |
|
89 | | -[[mobile-defaults-for-selected-options]] |
90 | | -=== Mobile defaults for selected options |
91 | | - |
92 | | -These mobile-specific default values have been set to disable unsupported options for mobile devices or to provide the best experience without configuration from developers. |
| 94 | +== Mobile-Specific Defaults |
93 | 95 |
|
94 | | -The following options have mobile-specific default values: |
| 96 | +The following options are automatically set to provide a better experience on mobile devices: |
95 | 97 |
|
96 | | -* xref:menus-configuration-options.adoc#menubar[`+menubar+`] - defaults to `+false+` on mobile phones. |
97 | | -* xref:toolbar-configuration-options.adoc#toolbar_mode[`+toolbar_mode+`] - defaults to `+scrolling+` on mobile devices. The toolbar will side-scroll by default. |
98 | | -* xref:toolbar-configuration-options.adoc#toolbar_sticky[`+toolbar_sticky+`] - Sticky Toolbar is not supported on mobile devices and defaults to `+false+`. |
99 | | -* xref:table.adoc#table_grid[`+table_grid+`] - Table grid is not supported on mobile devices and defaults to `+false+`. When creating tables on mobile, a dialog is shown instead of the table grid. |
100 | | -* xref:editor-size-options.adoc#resize[`+resize+`] - Resizing is not supported on mobile devices and defaults to `+false+`. |
101 | | -* xref:content-behavior-options.adoc#object_resizing[`+object_resizing+`] - Object resizing is not supported on mobile devices and defaults to `+false+`. |
| 98 | +* xref:menus-configuration-options.adoc#menubar[`+menubar+`] — Defaults to `+false+` on mobile phones. |
| 99 | +* xref:toolbar-configuration-options.adoc#toolbar_mode[`+toolbar_mode+`] — Defaults to `+scrolling+`; enables side-scrolling toolbars. |
| 100 | +* xref:toolbar-configuration-options.adoc#toolbar_sticky[`+toolbar_sticky+`] — Defaults to `+false+`; sticky toolbars are not supported. |
| 101 | +* xref:table.adoc#table_grid[`+table_grid+`] — Defaults to `+false+`; a dialog replaces the table grid. |
| 102 | +* xref:editor-size-options.adoc#resize[`+resize+`] — Defaults to `+false+`; in-editor resizing is disabled. |
| 103 | +* xref:content-behavior-options.adoc#object_resizing[`+object_resizing+`] — Defaults to `+false+`; object resizing is not supported. |
102 | 104 |
|
103 | | -=== Unsupported options for mobile |
| 105 | +== Unsupported Configuration Options |
104 | 106 |
|
105 | | -The following options are not available on mobile: |
| 107 | +The following configuration options are not applicable or functional on mobile devices: |
106 | 108 |
|
107 | | -* xref:toolbar-configuration-options.adoc#toolbar_sticky[`+toolbar_sticky+`]. |
108 | | -* xref:table.adoc#table_grid[`+table_grid+`]. |
109 | | -* xref:editor-size-options.adoc#resize[`+resize+`]. |
110 | | -* xref:content-behavior-options.adoc#object_resizing[`+object_resizing+`]. |
| 109 | +* xref:toolbar-configuration-options.adoc#toolbar_sticky[`+toolbar_sticky+`] |
| 110 | +* xref:table.adoc#table_grid[`+table_grid+`] |
| 111 | +* xref:editor-size-options.adoc#resize[`+resize+`] |
| 112 | +* xref:content-behavior-options.adoc#object_resizing[`+object_resizing+`] |
111 | 113 |
|
112 | | -include::partial$configuration/mobile.adoc[] |
| 114 | +include::partial$configuration/mobile.adoc[] |
0 commit comments