Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trinhtam/editorjs-hyperlink
Link with target & rel attribute for Editor.js
https://github.com/trinhtam/editorjs-hyperlink
Last synced: 26 days ago
JSON representation
Link with target & rel attribute for Editor.js
- Host: GitHub
- URL: https://github.com/trinhtam/editorjs-hyperlink
- Owner: trinhtam
- Created: 2020-11-08T19:04:48.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-21T04:41:07.000Z (about 1 year ago)
- Last Synced: 2024-05-19T14:30:47.354Z (7 months ago)
- Language: JavaScript
- Size: 354 KB
- Stars: 32
- Watchers: 5
- Forks: 30
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-editorjs - editorjs-hyperlink
README
![](https://badgen.net/badge/Editor.js/v2.0/blue)
# Hyperlink Tool
A tool link with target & rel attribute for [Editor.js](https://editorjs.io).
![Screen Shot 2020-11-08 at 23 51 36](https://user-images.githubusercontent.com/22043198/98481955-acee3900-2230-11eb-8b9d-a76439dc258e.png)
![Screen Shot 2020-11-08 at 23 51 43](https://user-images.githubusercontent.com/22043198/98481956-afe92980-2230-11eb-9a84-f22149befbc0.png)
![Screen Shot 2020-11-08 at 23 52 04](https://user-images.githubusercontent.com/22043198/98481957-b11a5680-2230-11eb-9356-5e956f1f8d35.png)
## Installation
### Get the package via NPM
```shell
npm i editorjs-hyperlink -D
```
### or via Yarn```shell
yarn add editorjs-hyperlink -D
```Include module at your application
```javascript
const Hyperlink = require('editorjs-hyperlink');
```## Usage
Add a new Tool to the `tools` property of the Editor.js initial config.```javascript
var editor = EditorJS({
...
tools: {
...hyperlink: {
class: Hyperlink,
config: {
shortcut: 'CMD+L',
target: '_blank',
rel: 'nofollow',
availableTargets: ['_blank', '_self'],
availableRels: ['author', 'noreferrer'],
validate: false,
}
},...
},...
i18n: {
toolNames: {
Hyperlink: 'Link'
},
tools: {
hyperlink: {
Save: 'Salvar',
'Select target': 'Seleziona destinazione',
'Select rel': 'Wählen rel'
}
}
}
...
});
```## Config Params (optional)
| Field | Type | Description |
| ------ | -------- | ---------------- |
| shortcut | `string` | Shortcut, defaults to 'CMD+L' |
| target | `string` | Defines a default target, defaults to null |
| rel | `string` | Defines a default rel, defaults to null |
| availableTargets | `string[]` | Available link targets, defaults to all targets.
If empty array is provided, the control will be hidden and the default value applied. |
| availableRels | `string[]` | Available link rels, defaults to all rels.
If empty array is provided, the control will be hidden and the default value applied. |
| validate | `boolean` | Defines if an URL should be validated on saving |## License
[MIT](https://tamit.info)