2020-08-19 03:39:41 +08:00
|
|
|
|
# BulletList
|
2020-08-20 21:33:16 +08:00
|
|
|
|
This extension enables you to use the `<ul>` HTML tag in the editor.
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
|
|
|
|
::: warning Restrictions
|
2020-08-20 21:33:16 +08:00
|
|
|
|
It’s intended to be used with the `ListItem` extension.
|
2020-08-19 03:39:41 +08:00
|
|
|
|
:::
|
|
|
|
|
|
2020-08-20 21:33:16 +08:00
|
|
|
|
## Options
|
2020-09-10 16:21:24 +08:00
|
|
|
|
| Option | Type | Default | Description |
|
|
|
|
|
| ------ | ------ | ------- | -------------------------------------------- |
|
|
|
|
|
| class | string | – | Add a custom class to the rendered HTML tag. |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-08-20 21:33:16 +08:00
|
|
|
|
## Commands
|
2020-09-10 16:21:24 +08:00
|
|
|
|
| Command | Options | Description |
|
|
|
|
|
| ----------- | ------- | --------------------- |
|
|
|
|
|
| bullet_list | — | Toggle a bullet list. |
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-09-10 17:24:33 +08:00
|
|
|
|
## Keyboard shortcuts
|
2020-08-19 03:39:41 +08:00
|
|
|
|
* `Control` + `Shift` + `8`
|
|
|
|
|
|
2020-09-15 22:50:54 +08:00
|
|
|
|
## Source Code
|
|
|
|
|
[packages/extension-bullet-list/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-bullet-list/)
|
2020-08-19 03:39:41 +08:00
|
|
|
|
|
2020-09-15 22:50:54 +08:00
|
|
|
|
## Usage
|
|
|
|
|
<demo name="Extensions/BulletList" highlight="3-5,17-18,37-38" />
|