mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-13 09:29:01 +08:00
33 lines
1.6 KiB
Markdown
33 lines
1.6 KiB
Markdown
# FontFamily
|
|
[![Version](https://img.shields.io/npm/v/@tiptap/extension-font-family.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-font-family)
|
|
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-font-family.svg)](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
|
|
| Option | Type | Default | Description |
|
|
| ------ | ------- | --------------- | ------------------------------------------------------------------------ |
|
|
| types | `Array` | `['textStyle']` | A list of marks to which the font family attribute should be applied to. |
|
|
|
|
## Commands
|
|
| Command | Parameters | Description |
|
|
| ---------- | ---------- | --------------------------------------------- |
|
|
| fontFamily | fontFamily | Applies the given font family as inline style |
|
|
|
|
## 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>
|