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/partials/integrations/angular-tech-ref.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,7 +107,7 @@ The editor accepts the following properties:
107
107
></editor>
108
108
----
109
109
110
-
None of the configuration properties are *required* for `+tinymce-angular+` to work. Specify a {cloudname} API key using `+apiKey+` to remove the `+This domain is not registered...+` warning message.
110
+
None of the configuration properties are *required* for `+tinymce-angular+` to work. Specify a {cloudname} API key using `+apiKey+` to remove the "A valid API key is required to continue using TinyMCE. Please alert the admin to check the current API key. Click here to learn more." warning message.
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}].
IMPORTANT: {companyname} does not recommend bundling `tinymce` and `{packageName}` with a module loader. Bundling these packages can be complex and error prone.
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
----
57
+
+
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_.
52
60
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_.
54
-
61
+
+
55
62
* Follow the prompts and type `+tinymce-vue-demo+` as the project name.
56
63
. Change into the newly created directory.
57
64
+
@@ -61,47 +68,47 @@ cd tinymce-vue-demo
61
68
----
62
69
63
70
ifeval::["{productSource}" == "package-manager"]
64
-
. Install the `+tinymce+` and `+tinymce-vue+` packages and save them to your `+package.json+` with `+--save+`.
71
+
. 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].
* [[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
248
+
@@ -167,14 +253,7 @@ To use an independent deployment of {productname}, add a script to either the `<
167
253
<script src="/path/to/tinymce.min.js"></script>
168
254
----
169
255
+
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
257
endif::[]
179
258
180
259
. Test the application using the Node.js development server.
@@ -185,16 +264,16 @@ endif::[]
185
264
npm run dev
186
265
----
187
266
188
-
* To stop the development server, select on the command line or command prompt and press _Ctrl+C_.
267
+
* To stop the development server, select on the command line or command prompt and press `+Ctrl+C+`.
189
268
190
269
== Deploying the application to a HTTP server
191
270
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].
271
+
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
272
194
273
== Next Steps
195
274
196
-
* For examples of the {productname} integration, see: https://tinymce.github.io/tinymce-vue/[the tinymce-vue storybook].
275
+
* For examples of the {productname} integration, see: link:https://tinymce.github.io/tinymce-vue/[the tinymce-vue storybook].
0 commit comments