mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-16 19:57:48 +08:00
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
---
|
|
description: Developers love to add some inline code to their texts.
|
|
icon: code-view
|
|
---
|
|
|
|
# Code
|
|
[](https://www.npmjs.com/package/@tiptap/extension-code)
|
|
[](https://npmcharts.com/compare/@tiptap/extension-code?minimal=true)
|
|
|
|
The Code extensions enables you to use the `<code>` HTML tag in the editor. If you paste in text with `<code>` tags it will rendered accordingly.
|
|
|
|
Type something with <code>\`back-ticks around\`</code> and it will magically transform to `inline code` while you type.
|
|
|
|
## Installation
|
|
```bash
|
|
# with npm
|
|
npm install @tiptap/extension-code
|
|
|
|
# with Yarn
|
|
yarn add @tiptap/extension-code
|
|
```
|
|
|
|
## Settings
|
|
|
|
### HTMLAttributes
|
|
Custom HTML attributes that should be added to the rendered HTML tag.
|
|
|
|
```js
|
|
Code.configure({
|
|
HTMLAttributes: {
|
|
class: 'my-custom-class',
|
|
},
|
|
})
|
|
```
|
|
|
|
## Commands
|
|
|
|
### setCode()
|
|
Mark text as inline code.
|
|
|
|
```js
|
|
editor.commands.setCode()
|
|
```
|
|
|
|
### toggleCode()
|
|
Toggle inline code mark.
|
|
|
|
```js
|
|
editor.commands.toggleCode()
|
|
```
|
|
|
|
### unsetCode()
|
|
Remove inline code mark.
|
|
|
|
```js
|
|
editor.commands.unsetCode()
|
|
```
|
|
|
|
## Keyboard shortcuts
|
|
| Command | Windows/Linux | macOS |
|
|
| ------------ | ------------------ | -------------- |
|
|
| toggleCode() | `Control` `E` | `Cmd` `E` |
|
|
|
|
## Source code
|
|
[packages/extension-code/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-code/)
|
|
|
|
## Usage
|
|
https://embed.tiptap.dev/preview/Marks/Code
|