forked from remirror/remirror
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document remaining extensions (remirror#1141)
- Loading branch information
1 parent
5e0e70c
commit b2e577e
Showing
40 changed files
with
1,402 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
hide_title: true | ||
title: 'CodeBlockExtension' | ||
--- | ||
|
||
# `CodeBlockExtension` | ||
|
||
## Summary | ||
|
||
Adds code blocks to the editor. This differs to the `CodeExtension`, which provides code marks on inline text. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { CodeBlockExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-code-block` package. There are two ways of pulling it into your project. | ||
|
||
### Examples | ||
|
||
See [storybook](https://remirror.vercel.app/?path=/story/extensions-codeblock--basic) for examples. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
hide_title: true | ||
title: 'CollaborationExtension' | ||
--- | ||
|
||
# `CollaborationExtension` | ||
|
||
## Summary | ||
|
||
The collaboration extension adds collaborative functionality to your editor. | ||
|
||
Once a central server is created the collaboration extension is good. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { CollaborationExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-collaboration` package. There are two ways of pulling it into your project. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
hide_title: true | ||
title: 'ColumnsExtension' | ||
--- | ||
|
||
# `ColumnsExtension` | ||
|
||
## Summary | ||
|
||
Add column support to the nodes in your editor. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { ColumnsExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-columns` package. There are two ways of pulling it into your project. | ||
|
||
### Examples | ||
|
||
See [storybook](https://remirror.vercel.app/?path=/story/extensions-columns--basic) for examples. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
hide_title: true | ||
title: 'DropCursorExtension' | ||
--- | ||
|
||
# `DropCursorExtension` | ||
|
||
## Summary | ||
|
||
Shows a line indicator for where the drop target will be | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { DropCursorExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-drop-cursor` package. There are two ways of pulling it into your project. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
hide_title: true | ||
title: 'EmojiExtension' | ||
--- | ||
|
||
# `EmojiExtension` | ||
|
||
## Summary | ||
|
||
Adds emoji support to the editor. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { EmojiExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-emoji` package. There are two ways of pulling it into your project. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
hide_title: true | ||
title: 'EpicModeExtension' | ||
--- | ||
|
||
# `EpicModeExtension` | ||
|
||
## Summary | ||
|
||
Shows the editor in epic mode. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { EpicModeExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-epicmode` package. There are two ways of pulling it into your project. | ||
|
||
### Examples | ||
|
||
See [storybook](https://remirror.vercel.app/?path=/story/extensions-epicmode--basic) for examples. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
hide_title: true | ||
title: 'EventsExtension' | ||
--- | ||
|
||
# `EventsExtension` | ||
|
||
## Summary | ||
|
||
The events extension which listens to events which occur within the remirror editor. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { EventsExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-events` package. There are two ways of pulling it into your project. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
hide_title: true | ||
title: 'FileExtension' | ||
--- | ||
|
||
# `FileExtension` | ||
|
||
## Summary | ||
|
||
Adds a file node to the editor | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { FileExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-file` package. There are two ways of pulling it into your project. | ||
|
||
### Examples | ||
|
||
See [storybook](https://remirror.vercel.app/?path=/story/extensions-file--basic) for examples. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
hide_title: true | ||
title: 'GapCursorExtension' | ||
--- | ||
|
||
# `GapCursorExtension` | ||
|
||
## Summary | ||
|
||
this will capture clicks near and arrow-key-motion past places that don't have a normally selectable position nearby, and create a gap cursor selection for them. The cursor is drawn as an element with class `ProseMirror-gapcursor`. | ||
|
||
Make sure to import the styles: | ||
|
||
```ts | ||
import '@remirror/styles/extension-gap-cursor.css'; | ||
``` | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { GapCursorExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-gap-cursor` package. There are two ways of pulling it into your project. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
hide_title: true | ||
title: 'HardBreakExtension' | ||
--- | ||
|
||
# `HardBreakExtension` | ||
|
||
## Summary | ||
|
||
An extension which provides the functionality for inserting a `hardBreak` `<br />` tag into the editor. | ||
|
||
It will automatically exit when used inside a `codeClock`. To prevent problems occurring when the codeblock is the last node in the doc, you should add the `TrailingNodeExtension` which automatically appends a paragraph node to the last node. | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
This extension is installed for you when you install the main `remirror` package. | ||
|
||
You can use the imports in the following way. | ||
|
||
```ts | ||
import { HardBreakExtension } from 'remirror/extensions'; | ||
``` | ||
|
||
To install it directly you can use | ||
|
||
The extension is provided by the `@remirror/extension-hard-break` package. There are two ways of pulling it into your project. | ||
|
||
### Examples | ||
|
||
See [storybook](https://remirror.vercel.app/?path=/story/extensions-hard-break--basic) for examples. | ||
|
||
## API | ||
|
||
### Options | ||
|
||
### Commands | ||
|
||
### Helpers |
Oops, something went wrong.