tiptap/docs/src/docPages/api/extensions/text-align.md

50 lines
2.2 KiB
Markdown
Raw Normal View History

# TextAlign
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-text-align.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-text-align)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-text-align.svg)](https://npmcharts.com/compare/@tiptap/extension-text-align?minimal=true)
2020-11-06 22:44:23 +08:00
This extension adds a text align attribute to a specified list of nodes. The attribute is used to align the text.
2020-10-23 21:23:40 +08:00
2021-04-08 22:06:58 +08:00
:::warning Firefox bug
`text-align: justify` doesn't work together with `white-space: pre-wrap` in Firefox, [thats a known issue](https://bugzilla.mozilla.org/show_bug.cgi?id=1253840).
:::
2020-10-23 21:23:40 +08:00
## Installation
```bash
2020-10-30 21:24:16 +08:00
# with npm
2020-10-23 21:23:40 +08:00
npm install @tiptap/extension-text-align
2020-10-30 21:24:16 +08:00
# with Yarn
2020-10-23 21:23:40 +08:00
yarn add @tiptap/extension-text-align
```
## Settings
2020-11-18 19:12:34 +08:00
| 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. |
## Commands
2020-11-06 22:44:23 +08:00
| Command | Parameters | Description |
| --------- | ---------- | ------------------------------------------ |
| textAlign | alignment | Set the text align to the specified value. |
## Keyboard shortcuts
2020-11-19 08:16:10 +08:00
### Windows/Linux
2020-11-06 22:44:23 +08:00
* `Ctrl` `Shift` `L` Left
* `Ctrl` `Shift` `E` Center
* `Ctrl` `Shift` `R` Right
* `Ctrl` `Shift` `J` Justify
2020-11-19 08:16:10 +08:00
### macOS
* `Cmd` `Shift` `L` Left
* `Cmd` `Shift` `E` Center
* `Cmd` `Shift` `R` Right
* `Cmd` `Shift` `J` Justify
2020-10-23 21:23:40 +08:00
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-text-align/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-text-align/)
2020-10-23 21:23:40 +08:00
## Usage
2020-11-06 22:44:23 +08:00
<demo name="Extensions/TextAlign" highlight="29" />