@ -6,9 +6,9 @@ description: Matches special patterns in the text and applies formats or execute
keywords: textpattern textpattern_patterns format cmd
---
This plugin matches special patterns in the text and applies formats, replaces text, or executes commands on these patterns.
The Text Pattern plugin matches special patterns in the text and applies formats, replaces text, or executes commands on these patterns.
The default pattern is similar to markdown syntax, so you can type `# text` to produce a header or `**text**` to make text **bold**.
The default pattern is similar to markdown syntax, so the user can type `# text` to produce a header or `**text**` to make text **bold**.
**Type:** `String`
@ -27,9 +27,110 @@ This setting affects the execution of the `textpattern` plugin. Text patterns th
### `textpattern_patterns`
This option lets you configure the text patterns that get matched by the `textpattern` plugin. By default, it has basic markdown patterns.
This option allows configuring the text patterns that get matched by the `textpattern` plugin. By default, it has basic markdown patterns.
There are three types of patterns: `inline`, `block`, and `replacement` patterns. Inline patterns have a `start` and an `end` text pattern whereas the block and replacement patterns only have a `start`. A user can specify the formats to be applied to the selection, commands to be executed, or text to be replaced.
> Note: Formats and commands must be already registered with the editor. See the [formats]({{ site.baseurl }}/configure/content-formatting/#formats) and [commands]({{ site.baseurl }}/api/tinymce/tinymce.editorcommands/) documentation for more information.
**Default Value:**
```js
[
{start: '*', end: '*', format: 'italic'},
{start: '**', end: '**', format: 'bold'},
{start: '#', format: 'h1'},
{start: '##', format: 'h2'},
{start: '###', format: 'h3'},
{start: '####', format: 'h4'},
{start: '#####', format: 'h5'},
{start: '######', format: 'h6'},
{start: '1. ', cmd: 'InsertOrderedList'},
{start: '* ', cmd: 'InsertUnorderedList'},
{start: '- ', cmd: 'InsertUnorderedList' }
]
```
#### Inline patterns
Inline patterns must have the following:
* A `start` and an `end`.
* A `format` or a `cmd`.
* If `cmd` is specified, an optional `value` property is allowed.
This allows for patterns to be used to either apply a format or execute a command, optionally with the given value.
> Note: Inline patterns are executed on either pressing the **spacebar** or the **Enter** key.
##### Example
```js
tinymce.init({
selector: "textarea", // change this value according to your HTML
* `{start: '*', end: '*', format: 'italic'}` - Entering text between`*` and then pressing the **spacebar** will result in the `italic` format being applied to the text between the `*` symbols.
* `{start: '**', end: '**', format: 'bold'}` - Entering text between`**` and then pressing the **spacebar** will result in the `bold` format being applied.
* `{start: '~', end: '~', cmd: 'createLink', value: 'https://tiny.cloud'}` - This executes `editor.execCommand('createLink', false, 'https://tiny.cloud')`, which will wrap the text between the `~` symbols in a link that points to `https://tiny.cloud`.
#### Block patterns
Block patterns must have the following:
* A `start`
* A `format` or a `cmd`
* If `cmd` is specified, an optional `value` property is allowed.
The block patterns do not have an `end` property. This allows for patterns to be used to either apply a block format or execute a command, optionally, with the given value.
> Note: Block patterns are only executed on **Enter**, **not** on pressing the **spacebar**.
##### Example
```js
tinymce.init({
selector: "textarea", // change this value according to your HTML
* `{start: '#', format: 'h1'}` - Typing `#`, some text, and then pressing `Enter` will convert the text to a `h1` heading.
* Typing `1. `, some text, and then pressing `Enter` will convert the text into an ordered list, with the original text as the first list item, and the new line as the second list item. Since we have specified `value`, this pattern will execute `editor.execCommand('InsertOrderedList', false, { 'list-style-type': 'decimal'})`.
#### Replacements patterns
Replacement patterns must have the following:
* A `start`.
* A `replacement`, which takes a string that can be text or HTML.
Whether a replacement pattern inserts a block or inline element depends on what the `replacement` string is.
> Note: Replacement patterns are executed on either pressing the **spacebar** or the **Enter** key.
There are three types of patterns: inline, block, and replacement patterns. Inline patterns have a start and end whereas the block- and replacement-based patterns only have a start. You can specify formats to be applied to the selection, commands to be executed, or text to be replaced.
##### Example
@ -38,18 +139,18 @@ tinymce.init({
selector: "textarea", // change this value according to your HTML
Shikha
7 years ago