mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-28 23:59:25 +08:00
document text style and font family extensions (wip)
This commit is contained in:
parent
f28f33f140
commit
5ec6e8bfd7
5
docs/src/demos/Marks/TextStyle/index.spec.js
Normal file
5
docs/src/demos/Marks/TextStyle/index.spec.js
Normal file
@ -0,0 +1,5 @@
|
||||
context('/api/marks/text-style', () => {
|
||||
before(() => {
|
||||
cy.visit('/api/marks/text-style')
|
||||
})
|
||||
})
|
@ -1,18 +1,24 @@
|
||||
# FontFamily
|
||||
This extension enables you to set the font family in the editor.
|
||||
|
||||
## Installation
|
||||
::: warning Use with TextStyle
|
||||
This extension requires the [`TextStyle`](/api/nodes/text-style) mark.
|
||||
This extension requires the [`TextStyle`](/api/marks/text-style) mark.
|
||||
:::
|
||||
|
||||
```bash
|
||||
# with npm
|
||||
npm install @tiptap/extension-font-family
|
||||
npm install @tiptap/extension-text-style @tiptap/extension-font-family
|
||||
|
||||
# with Yarn
|
||||
yarn add @tiptap/extension-font-family
|
||||
yarn add @tiptap/extension-text-style @tiptap/extension-font-family
|
||||
```
|
||||
|
||||
## Settings
|
||||
| Option | Type | Default | Description |
|
||||
| ------ | ----- | ------------- | --------------------------------------------------------------------- |
|
||||
| types | array | ['textStyle'] | A list of marks where the font family attribute should be applied to. |
|
||||
|
||||
## Source code
|
||||
[packages/extension-font-family/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-font-family/)
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
# Text Style
|
||||
This mark renders a `<span>` HTML tag and enables you to add a list of styling related attributes, for example font-family, font-size, or font-color. The extension doesn’t add any styling attribute by default, but other extensions use it as the foundation, for example `FontFamily`.
|
||||
This mark renders a `<span>` HTML tag and enables you to add a list of styling related attributes, for example font-family, font-size, or font-color. The extension doesn’t add any styling attribute by default, but other extensions use it as the foundation, for example [`FontFamily`](/api/extensions/font-family).
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
|
@ -132,6 +132,7 @@
|
||||
link: /api/extensions/focus
|
||||
- title: FontFamily
|
||||
link: /api/extensions/font-family
|
||||
draft: true
|
||||
- title: Gapcursor
|
||||
link: /api/extensions/gapcursor
|
||||
- title: History
|
||||
|
Loading…
Reference in New Issue
Block a user