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/editor-icons.adoc
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,37 @@
2
2
:navtitle: Icons
3
3
:description: Configure the editor's toolbar button and menu item icons.
4
4
5
+
{productname} icons come from icon packs. {productname} includes both community and premium icon packs, but also allows integrators to add custom icons or override {productname} icons with their own.
6
+
7
+
The default icon pack is shipped with {productname} and does not require any configuration, though it must be imported when bundling for deployment:
8
+
9
+
[source,js]
10
+
----
11
+
import 'tinymce/icons/default';
12
+
----
13
+
14
+
Replacing the default icon can be done using the `+icons+` and `+icons_url+` settings.
15
+
16
+
== Available icon packs
17
+
18
+
{productname} includes both community and premium icon packs:
For information on which icon packs work best with which skins, see: xref:enhanced-skins-and-icon-packs.adoc#icon-pack-compatibility-matrix[Icon pack compatibility matrix].
24
+
25
+
== Custom icon packs
26
+
27
+
For information on creating custom icon packs, see: xref:creating-an-icon-pack.adoc[Create an icon pack for {productname}].
28
+
29
+
The value passed to `+icons+` must match the pack name defined either:
30
+
31
+
* Passed to `+tinymce.IconManager.add+` when registering the icon pack via JavaScript; or
32
+
* Specified in the `+package.json+` `+iconPackName+` field when creating the icon pack using the xref:creating-an-icon-pack.adoc#download-and-setup-the-icon-pack-template[Icon Pack Template].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/editor-skin.adoc
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,34 @@
2
2
:navtitle: Skins
3
3
:description: Configure the editor's overall appearance.
4
4
5
+
{productname} comes with several premium skins which change the look of the editor. These skins are an easy way to restyle {productname} to better suit applications.
6
+
7
+
[NOTE]
8
+
====
9
+
*Skins vs Content CSS:*
10
+
11
+
Skins change both the look of {productname}'s UI and the editable area. To change only the look of the editable area, use xref:add-css-options.adoc#content_css[`+content_css+`].
12
+
====
13
+
14
+
The default skin does not require any configuration, though it must be imported when bundling for deployment:
15
+
16
+
[source,js]
17
+
----
18
+
import 'tinymce/skins/ui/oxide/skin';
19
+
----
20
+
21
+
Replacing the default skin uses the `+skin+` and `+skin_url+` settings.
22
+
23
+
== Available skins
24
+
25
+
See xref:enhanced-skins-and-icon-packs.adoc[Enhanced Skins & Icon Packs] for a list of available skins and the icon packs which look best with each skin.
26
+
27
+
== Custom skins
28
+
29
+
Integrators can create and use their own skin files. For information on creating custom skins, see: xref:creating-a-skin.adoc[Create a skin for {productname}].
Copy file name to clipboardExpand all lines: modules/ROOT/pages/license-key.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
@@ -223,7 +223,7 @@ To obtain a new {productname} 8 license key (T8LK-prefixed):
223
223
Existing {productname} 7 license keys cannot be modified to work with {productname} 8 by adding the T8LK prefix. A new {productname} 8 license must be obtained through the proper channels listed above.
224
224
====
225
225
226
-
=== If im upgrading from TinyMCE 7 how do I get a TinyMCE 8 license key?
226
+
=== When upgrading from {productname} 7, what is the process for obtaining a {productname} 8 license key?
The *icons* option allows the editor icons to be extended or replaced using an icon pack. For information on creating icon packs, see: xref:creating-an-icon-pack.adoc[Create an icon pack for {productname}].
6
+
The *icons* option allows the editor icons to be extended or replaced using an icon pack. The icon pack is specified by name.
7
7
8
8
*Type:* `+String+`
9
9
endif::[]
10
10
11
11
On initialization, {productname} will try to load any icon pack specified by the *icons* option. The icons in the icon pack will be merged with xref:editor-icon-identifiers.adoc[{productname}'s default icons] and icons in the icon pack will overwrite the default icons with the same identifier.
12
12
13
-
{productname} loads icon packs from the path `+TINYMCE_BASE/icons/${iconPackName}/icons.js+`; where:
14
-
15
-
* `+TINYMCE_BASE+` is the {productname} root directory (the directory containing `+tinymce.min.js+`).
16
-
* `+${iconPackName}+` is the name of the icon pack.
17
-
18
-
== Available icon packs
19
-
20
-
{productname} includes both community and premium icon packs:
The *icons_url* option allows the editor icons to be extended or replaced using an icon pack. For information on creating icon packs, see: xref:creating-an-icon-pack.adoc[Create an icon pack for {productname}].
7
-
endif::[]
6
+
The *icons_url* option allows integrators to specify a non-default location to load icon packs from. This is useful when {productname} and the icon pack are loaded from different locations. For example: When loading {productname} from {cloudname}, the icon pack can be loaded from a different web server.
8
7
9
-
On initialization, {productname} will try to load any icon pack specified by the *icons_url* option. The icons in the icon pack will be merged with xref:editor-icon-identifiers.adoc[{productname}'s default icons] and icons in the icon pack will overwrite the default icons with the same identifier.
8
+
*Type:* `+String+`
9
+
endif::[]
10
10
11
-
`+icons_url+` is used to specify the location of an icon pack when {productname} and the icon pack are loaded from different locations. For example: When loading {productname} from {cloudname}, the icon pack can be loaded from a different web server.
11
+
On initialization, {productname} will try to load any icon pack specified by the *icons* option from the location specified by *icons_url*. The icons in the icon pack will be merged with xref:editor-icon-identifiers.adoc[{productname}'s default icons] and icons in the icon pack will overwrite the default icons with the same identifier.
12
12
13
13
[IMPORTANT]
14
14
====
@@ -30,7 +30,6 @@ tinymce.init({
30
30
});
31
31
----
32
32
33
-
The `icons` value must match the pack name defined in your `package.json` `iconPackName` field.
34
33
====
35
34
36
35
== Usage
@@ -39,6 +38,7 @@ To use a {productname} icon pack from a separate location:
39
38
40
39
. Ensure the icon pack is available at the specified URL.
41
40
. Add the `+icons_url+` option to `+tinymce.init+`.
41
+
. Specify the icon pack name using the `+icons+` setting.
42
42
43
43
ifeval::[{customIconPack} == true]
44
44
For custom icon packs:
@@ -92,7 +92,6 @@ tinymce.init({
92
92
93
93
endif::[]
94
94
ifeval::[{customIconPack} != true]
95
-
*Type:* `+String+`
96
95
97
96
=== Example: using `+icons_url+`
98
97
@@ -113,13 +112,13 @@ tinymce.init({
113
112
114
113
=== Example: loading premium icons from `+tinymce-premium+` (NPM)
115
114
116
-
When installing the `+tinymce-premium+` NPM package, premium icon packs are stored in `+node_modules/tinymce-premium/icons/+`. Configure `+icons_url+` to point at the desired icon pack file. For example:
115
+
When installing the `+tinymce-premium+` NPM package, premium icon packs are stored in `+node_modules/tinymce-premium/icons/+`. Configure `+icons_url+` to point at the desired icon pack file. The path is relative to where {productname} is loaded from. For example:
This option allows you to specify the skin that {productname} should use, or `+false+` to not load a skin. The default skin included with {productname} is named "oxide".
4
+
This option specifies the skin that {productname} should use, or `+false+` to not load a skin. The default skin included with {productname} is named "oxide".
5
5
6
6
*Type:* `+String+` or `+Boolean+`
7
7
8
8
*Default value:* `+'oxide'+`
9
9
10
10
*Possible values:* the name of a skin or `+false+`
11
11
12
-
The name of the skin should match the name of the folder within the skins directory of {productname}. If the specified skin is not found, {productname} will not load.
12
+
The name of the skin should match the name of the folder within the `+skins/ui+` directory of {productname}. If the specified skin is not found, {productname} will not load.
13
13
14
14
[source,js]
15
15
----
16
16
tinymce.init({
17
-
selector: 'textarea', // change this value according to your HTML
18
-
skin: 'oxide'
17
+
selector: 'textarea', // change this value according to the HTML
18
+
skin: 'fabric'
19
19
});
20
20
----
21
21
22
-
If you would like to create your own skin, please see the guide xref:creating-a-skin.adoc[here].
22
+
For information on creating custom skins, see: xref:creating-a-skin.adoc[Create a skin for {productname}].
Copy file name to clipboardExpand all lines: modules/ROOT/partials/configuration/skin_url.adoc
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,30 +1,31 @@
1
1
[[skin_url]]
2
2
== `+skin_url+`
3
3
4
-
If you are using {productname} skins, this option enables you to specify the location of the skin directory. This is useful if you are loading {productname} from one URL, for example a CDN, while loading a skin on, say, a local server.
4
+
This option specifies the location of the skin directory. This is useful when loading {productname} and the skin files from different locations.
5
+
6
+
When using `+skin_url+`, the `+skin+` option is not required. The `+skin_url+` option points directly to the skin directory location.
5
7
6
8
*Type:* `+String+`
7
9
8
10
=== Example: using `+skin_url+`
9
11
10
-
[source,js,subs="attributes+"]
12
+
[source,js]
11
13
----
12
14
tinymce.init({
13
-
selector: 'textarea', // change this value according to your HTML
14
-
skin_url: '/css/my{prodnamecode}skin'
15
+
selector: 'textarea', // change this value according to the HTML
16
+
skin_url: '/css/mytinymceskin' // change this to point to the folder of skin files
15
17
});
16
18
----
17
19
18
20
=== Example: loading premium skins from `+tinymce-premium+` (NPM)
19
21
20
-
When installing the `+tinymce-premium+` NPM package, premium skins are stored in `+node_modules/tinymce-premium/skins/+`. Configure `+skin_url+` to point at the desired skin directory. For example:
22
+
When installing the `+tinymce-premium+` NPM package, premium skins are stored in `+node_modules/tinymce-premium/skins/ui/+`. Configure the `+skin_url+` to point at the desired skin directory. For example:
There are two options for replacing the icons in {productname}: `+icons+` and `+icons_url+`.
1
+
There are two options related to replacing the icons in {productname}: `+icons+` and `+icons_url+`.
2
2
3
-
* Use the `+icons+` option when icon packs are in the default location (for {cloudname} deployments, ZIP bundles, or when using NPM packages with bundling or file layering).
4
-
* Use the `+icons_url+` option to specify a custom path to icon packs, which is useful for custom icon packs or when using NPM packages without bundling.
3
+
* `+icons+` specifies *which* icon pack to use.
4
+
* `+icons_url+` specifies *where* to find that icon pack if it is not in the **default location**.
5
+
6
+
If only `+icons+` is configured, {productname} will try to load the specified icon pack from `+TINYMCE_BASE/icons/${iconPackName}/icons.js+`; where:
7
+
8
+
* `+TINYMCE_BASE+` is the {productname} root directory (the directory containing `+tinymce.min.js+`).
9
+
* `+${iconPackName}+` is the name of the icon pack.
10
+
11
+
To load icon packs from another location, integrators must specify that location using `+icons_url+`.
12
+
13
+
* When using {productname} from {cloudname}, ZIP bundles, or NPM packages with bundling or file layering, only `+icons+` should be required.
14
+
* When using custom icon packs or using NPM packages without bundling, `+icons_url+` will likely also be required.
0 commit comments