mirror of
https://github.com/ueberdosis/tiptap.git
synced 2025-06-12 12:43:48 +08:00
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
# FontFamily
|
|
[](https://www.npmjs.com/package/@tiptap/extension-font-family)
|
|
[](https://npmcharts.com/compare/@tiptap/extension-font-family?minimal=true)
|
|
|
|
This extension enables you to set the font family in the editor. It uses the [`TextStyle`](/api/marks/text-style) mark, which renders a `<span>` tag. The font family is applied as inline style, for example `<span style="font-family: Arial">`.
|
|
|
|
## Installation
|
|
```bash
|
|
# with npm
|
|
npm install @tiptap/extension-text-style @tiptap/extension-font-family
|
|
|
|
# with Yarn
|
|
yarn add @tiptap/extension-text-style @tiptap/extension-font-family
|
|
```
|
|
|
|
This extension requires the [`TextStyle`](/api/marks/text-style) mark.
|
|
|
|
## Settings
|
|
|
|
### types
|
|
A list of marks to which the font family attribute should be applied to.
|
|
|
|
Default: `['textStyle']`
|
|
|
|
```js
|
|
FontFamily.configure({
|
|
types: ['textStyle'],
|
|
})
|
|
```
|
|
|
|
## Commands
|
|
|
|
### setFontFamily()
|
|
Applies the given font family as inline style.
|
|
|
|
```js
|
|
editor.commands.setFontFamily('Inter')
|
|
```
|
|
|
|
### unsetFontFamily()
|
|
Removes any font family.
|
|
|
|
```js
|
|
editor.commands.unsetFontFamily()
|
|
```
|
|
|
|
## Source code
|
|
[packages/extension-font-family/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-font-family/)
|
|
|
|
## Usage
|
|
<tiptap-demo name="Extensions/FontFamily"></tiptap-demo>
|