Skip to content

Commit

Permalink
docs: add links and plugins details
Browse files Browse the repository at this point in the history
  • Loading branch information
sibiraj-s committed Nov 29, 2020
1 parent b392b5f commit c59c232
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ yarn add ngx-editor

### Usage

**Note**: By default the editor comes with no features enabled. Refer the [demo](#demo) and [documentation](#documentation) for more details.
**Note**: By default the editor comes with bare minimal features enabled to reduce the size of the bundle. Refer the [demo](#demo) and [documentation](#documentation) for more details and examples.

Import `ngx-editor` module

Expand Down
11 changes: 11 additions & 0 deletions wiki/content/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Plugins

List of available plugins

- menu
- placeholder
- link

```js
import { menu, placeholder, link } from 'ngx-editor/plugins';
```
29 changes: 29 additions & 0 deletions wiki/content/working-with-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Links

To enable link support in menu

```ts
import { schema } from 'ngx-editor';
import { menu, placeholder } from 'ngx-editor/plugins';

NgxEditorModule.forRoot({
plugins: [
menu({
toolbar: [
['link'] // add this
]
],
});
```
To enable link tooltip inside the editor to when the selection has a link.
```ts
import { link } from 'ngx-editor/plugins';

NgxEditorModule.forRoot({
plugins: [
link(),
]
});
```
8 changes: 8 additions & 0 deletions wiki/summary.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,13 @@
{
"title": "Reactive Forms",
"file": "content/reactive-forms.md"
},
{
"title": "Working with links",
"file": "content/working-with-links.md"
},
{
"title": "Plugins",
"file": "content/plugins.md"
}
]

0 comments on commit c59c232

Please sign in to comment.