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
IMPORTANT: {companyname} does not recommend bundling `tinymce` and `{packageName}` with a module loader. Bundling these packages can be complex and error prone.
IMPORTANT: {companyname} does not recommend bundling `tinymce` and `{packageName}` with a module loader. Bundling these packages can be complex and error prone.
4
-
5
-
To bundle {productname} using a module loader (such as Webpack, Rollup, or Browserify), import or require the `tinymce` package, followed by the `{packageName}` package, then the other required {productname}-related imports.
6
-
7
-
Example of bundling:
8
-
9
-
[source,js,subs="attributes+"]
10
-
----
11
-
/* Add the {packageName} wrapper to the bundle */
12
-
import { Editor } from '@tinymce/{packageName}';
13
-
/* For instructions on bundling TinyMCE, see the Bundling TinyMCE documentation. */
14
-
----
15
-
16
-
For instructions on bundling {productname}, see: xref:introduction-to-bundling-tinymce.adoc[Bundling {productname}].
17
-
18
-
19
-
endif::[]
20
-
ifeval::[{depth} == 2]
21
-
22
1
IMPORTANT: {companyname} does not recommend bundling `tinymce` and `{packageName}` with a module loader. Bundling these packages can be complex and error prone.
23
2
24
3
To bundle {productname} using a module loader (such as Webpack, Rollup, or Browserify), import or require the `tinymce` package, followed by the `{packageName}` package, then the other required {productname}-related imports.
@@ -32,24 +11,4 @@ import { Editor } from '@tinymce/{packageName}';
32
11
/* For instructions on bundling TinyMCE, see the Bundling TinyMCE documentation. */
33
12
----
34
13
35
-
For instructions on bundling {productname}, see: xref:introduction-to-bundling-tinymce.adoc[Bundling {productname}].
36
-
37
-
endif::[]
38
-
ifndef::depth[]
39
-
40
-
IMPORTANT: {companyname} does not recommend bundling `tinymce` and `{packageName}` with a module loader. Bundling these packages can be complex and error prone.
41
-
42
-
To bundle {productname} using a module loader (such as Webpack, Rollup, or Browserify), import or require the `tinymce` package, followed by the `{packageName}` package, then the other required {productname}-related imports.
43
-
44
-
Example of bundling:
45
-
46
-
[source,js,subs="attributes+"]
47
-
----
48
-
/* Add the {packageName} wrapper to the bundle */
49
-
import { Editor } from '@tinymce/{packageName}';
50
-
/* For instructions on bundling TinyMCE, see the Bundling TinyMCE documentation. */
51
-
----
52
-
53
-
For instructions on bundling {productname}, see: xref:introduction-to-bundling-tinymce.adoc[Bundling {productname}].
54
-
55
-
endif::[]
14
+
For instructions on bundling {productname}, see: xref:introduction-to-bundling-tinymce.adoc[Bundling {productname}].
Copy file name to clipboardExpand all lines: modules/ROOT/partials/integrations/vue-quick-start.adoc
+35-32Lines changed: 35 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,17 @@
1
1
:packageName: tinymce-vue
2
2
3
-
The https://github.com/tinymce/tinymce-vue[Official {productname} Vue.js component] integrates {productname} into Vue.js projects. This procedure creates a https://cli.vuejs.org/guide/creating-a-project.html#vue-create[basic Vue.js application] containing a {productname} editor.
3
+
The link:https://github.com/tinymce/tinymce-vue[Official {productname} Vue.js component] integrates {productname} into Vue.js projects, providing a powerful WYSIWYG editor within the Vue ecosystem. This procedure creates a link:https://cli.vuejs.org/guide/creating-a-project.html#vue-create[basic Vue.js application] containing a {productname} editor.
4
4
5
5
Version 4 and later of the `+tinymce-vue+` package supports Vue.js 3.x, but does not support Vue.js 2.x. For Vue.js 2.x applications, use `+tinymce-vue+` version 3.
. Create a new Vue project named `tinymce-vue-demo` using the https://github.com/vuejs/create-vue[Create Vue Tool].
44
+
. Create a new Vue project named `tinymce-vue-demo` using the link:https://github.com/vuejs/create-vue[Create Vue Tool].
40
45
* From a command line or command prompt create a Vue.js 3.x project: `+tinymce-vue-demo+`.
41
46
+
42
47
[source,sh]
43
48
----
44
49
npm create vue@3
45
50
----
46
-
* If you need to create a Vue.js 2.x projects instead:
51
+
* If a Vue.js 2.x project is required instead use:
47
52
+
48
53
[source,sh]
49
54
----
50
55
npm create vue@2
51
56
----
52
57
53
-
NOTE: As per the https://vuejs.org/about/faq.html#what-s-the-difference-between-vue-2-and-vue-3[Vue FAQ], _Vue 2 will reach End of Life by the end of 2023_.
58
+
[NOTE]
59
+
As per the link:https://vuejs.org/about/faq.html#what-s-the-difference-between-vue-2-and-vue-3[Vue FAQ], _Vue 2 will reach End of Life by the end of 2023_.
54
60
55
61
* Follow the prompts and type `+tinymce-vue-demo+` as the project name.
56
62
. Change into the newly created directory.
@@ -61,43 +67,43 @@ cd tinymce-vue-demo
61
67
----
62
68
63
69
ifeval::["{productSource}" == "package-manager"]
64
-
. Install the `+tinymce+` and `+tinymce-vue+` packages and save them to your `+package.json+` with `+--save+`.
70
+
. Install the `+tinymce+` and `+tinymce-vue+` packages.
. {productname} can be self-hosted by either: xref:deploying-tinymce-independent[Deploying {productname} independent of the Vue.js application], or xref:bundle[Bundling {productname} with the Vue.js application].
167
+
. {productname} can be self-hosted by either:
168
+
** xref:deploying-tinymce-independent[Deploying {productname} independent of the Vue.js application],
* [[deploying-tinymce-independent]] Deploying {productname} independent of the Vue.js application. To use a {productname} instance that has been deployed independent of the Vue.js application, use an HTML `+<script>+` tag.
162
172
+
@@ -167,14 +177,7 @@ To use an independent deployment of {productname}, add a script to either the `<
167
177
<script src="/path/to/tinymce.min.js"></script>
168
178
----
169
179
+
170
-
To use an independent deployment of {productname} with the example create a Vue.js application, add the script to `/path/to/tinymce-vue-demo/public/index.html`.
171
-
172
-
* [[bundle]] Bundle {productname} with the Vue.js application using a module loader (such as Webpack).
To use an independent deployment of {productname} with the example create a Vue.js application, add the `+<script>+` to `/path/to/tinymce-vue-demo/public/index.html`.
178
181
endif::[]
179
182
180
183
. Test the application using the Node.js development server.
@@ -185,16 +188,16 @@ endif::[]
185
188
npm run dev
186
189
----
187
190
188
-
* To stop the development server, select on the command line or command prompt and press _Ctrl+C_.
191
+
* To stop the development server, select on the command line or command prompt and press `+Ctrl+C+`.
189
192
190
193
== Deploying the application to a HTTP server
191
194
192
-
The application will require further configuration before it can be deployed to a production environment. For information on configuring the application for deployment, see: https://vuejs.org/v2/guide/deployment.html[Vue.js - Production Deployment].
195
+
The application will require further configuration before it can be deployed to a production environment. For information on configuring the application for deployment, see: link:https://vuejs.org/v2/guide/deployment.html[Vue.js - Production Deployment].
193
196
194
197
== Next Steps
195
198
196
-
* For examples of the {productname} integration, see: https://tinymce.github.io/tinymce-vue/[the tinymce-vue storybook].
199
+
* For examples of the {productname} integration, see: link:https://tinymce.github.io/tinymce-vue/[the tinymce-vue storybook].
@@ -103,6 +112,7 @@ The editor accepts the following properties:
103
112
/>
104
113
----
105
114
115
+
[NOTE]
106
116
None of the configuration properties are *required* for `+tinymce-vue+` to work. Specify a {cloudname} API key using `+api-key+` to remove the `+This domain is not registered...+` warning message.
107
117
108
118
[[api-key]]
@@ -199,7 +209,7 @@ The `+disabled+` property can dynamically switch the editor between a "disabled"
199
209
[[id]]
200
210
=== `+id+`
201
211
202
-
An id for the editor. Used for retrieving the editor instance using the `+tinymce.get('ID')+` method.
212
+
An `id` for the editor. Used for retrieving the editor instance using the `+tinymce.get('ID')+` method.
203
213
204
214
*Type:* `+String+`
205
215
@@ -288,12 +298,13 @@ For a list of available {productname} events, see: xref:events.adoc#editor-core-
@@ -378,7 +389,7 @@ For information setting the toolbar for {productname}, see: xref:toolbar-configu
378
389
[[tinymce-script-src]]
379
390
=== `+tinymce-script-src+`
380
391
381
-
Use the `+tinymce-script-src+` prop to specify an external version of TinyMCE to lazy load.
392
+
Use the `+tinymce-script-src+` prop to specify an external version of {productname} to lazy load from.
382
393
383
394
*Type:* `+String+`
384
395
@@ -401,7 +412,7 @@ The `+v-model+` directive can be used to create a two-way data binding. For exam
401
412
<editor v-model="content" />
402
413
----
403
414
404
-
For information on `+v-model+` and form input bindings, see: https://vuejs.org/guide/essentials/forms.html[Vue.js documentation - Form Input Bindings].
415
+
For information on `+v-model+` and form input bindings, see: link:https://vuejs.org/guide/essentials/forms.html[Vue.js documentation - Form Input Bindings].
405
416
406
417
[[event-binding]]
407
418
== Event binding
@@ -417,7 +428,7 @@ For older versions of Vue (Vue 2) supported by v3.x, the syntax for event bindin
417
428
418
429
When the handler is called (*handlerFunction* in this example), it is called with two arguments:
0 commit comments