ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix: remove default types for textAlign extension, fix #1430

Browse Source 
There are no default types for TextAlign extension anymore. You have to configure by yourself. Usually something like:

```js
TextAlign.configure({
  types: ['heading', 'paragraph'],
})
```
This commit is contained in:
Philipp Kühn
2021-06-18 12:33:18 +02:00
parent 081b93bfae
commit b4e41afd17
4 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/demos/Examples/Formatting/index.vue
View File

@@ -63,7 +63,9 @@ export default {
this.editor = new Editor({
extensions: [
StarterKit,
TextAlign,
TextAlign.configure({
types: ['heading', 'paragraph'],
}),
Highlight,
],
content: `

4
docs/src/demos/Extensions/TextAlign/index.vue
View File

@@ -45,7 +45,9 @@ export default {
Paragraph,
Text,
Heading,
TextAlign,
TextAlign.configure({
types: ['heading', 'paragraph'],
}),
],
content: `
<h2>Heading</h2>

10
docs/src/docPages/api/extensions/text-align.md
View File

@@ -18,11 +18,11 @@ yarn add @tiptap/extension-text-align
```
## Settings
| Option | Type | Default | Description |
| ---------------- | -------- | ---------------------------------------- | -------------------------------------------------------------------- |
| types | `Array` | `['heading', 'paragraph']` | A list of nodes where the text align attribute should be applied to. |
| alignments | `Array` | `['left', 'center', 'right', 'justify']` | A list of available options for the text align attribute. |
| defaultAlignment | `String` | `'left'` | The default text align. |
| Option | Type | Default | Description |
| ---------------- | -------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| types | `Array` | `[]` | A list of nodes where the text align attribute should be applied to. Usually something like `['heading', 'paragraph']`.|
| alignments | `Array` | `['left', 'center', 'right', 'justify']` | A list of available options for the text align attribute. |
| defaultAlignment | `String` | `'left'` | The default text align. |
## Commands
| Command | Parameters | Description |

6
packages/extension-text-align/src/text-align.ts
View File

@@ -25,7 +25,7 @@ export const TextAlign = Extension.create<TextAlignOptions>({
name: 'textAlign',
defaultOptions: {
types: ['heading', 'paragraph'],
types: [],
alignments: ['left', 'center', 'right', 'justify'],
defaultAlignment: 'left',
},
@@ -60,10 +60,10 @@ export const TextAlign = Extension.create<TextAlignOptions>({
return false
}
return this.options.types.some(type => commands.updateAttributes(type, { textAlign: alignment }))
return this.options.types.every(type => commands.updateAttributes(type, { textAlign: alignment }))
},
unsetTextAlign: () => ({ commands }) => {
return this.options.types.some(type => commands.resetAttributes(type, 'textAlign'))
return this.options.types.every(type => commands.resetAttributes(type, 'textAlign'))
},
}
},