npmpackage.info

editorjs-header-with-anchor

Header Tool with anchor for Editor.js 2.0

2.6.0

MIT

JavaScript

30.17 kB

66,755 2.8

Installations

npm install editorjs-header-with-anchor

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.13.1

NPM Version

6.12.1 Score

65.3

Supply Chain

95.4

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

2

Closed

0

Merged

2

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 1 Contributors

Languages

JavaScript

CSS

JavaScript (92.32%)

CSS (7.68%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

Aleksst95

Download Statistics

Total Downloads

66,755

Last Day

144

Last Week

1,009

Last Month

4,435

Last Year

35,216

GitHub Statistics

MIT License

9 Stars

104 Commits

4 Forks

8 Branches

1 Contributors

Updated on Jan 07, 2023

Maintainers

Package Meta Information

Latest Version

2.6.0

Package Id

editorjs-header-with-anchor@2.6.0

Unpacked Size

30.17 kB

Size

11.59 kB

File Count

NPM Version

6.12.1

Node Version

12.13.1

Total Downloads

Cumulative downloads

Total Downloads

66,755

Last Day

-44.2%

144

Compared to previous day

Last Week

-14.4%

1,009

Compared to previous week

Last Month

63.3%

4,435

Compared to previous month

Last Year

142.5%

35,216

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@babel/core @babel/preset-env babel-loader css-loader raw-loader style-loader webpack webpack-cli

Heading Tool with anchor

Provides Headings Blocks with the ability to set an anchor text for the Editor.js. Forked by Header Tool

Screenshot

header-with-anchor

Installation

Install via NPM

Get the package

1npm i --save editorjs-header-with-anchor

Include module at your application

1const Header = require('editorjs-header-with-anchor');

Download to your project's source dir

Upload folder dist from repository
Add dist/bundle.js file to your page.

Usage

Add a new Tool to the tools property of the Editor.js initial config.

1var editor = EditorJS({
2  ...
3
4  tools: {
5    ...
6    header: Header,
7  },
8
9  ...
10});

Available characters: all Latin letters, digitals, dash, and underscore.

In the cyrToLat branch, you can find additional functionality: Cyrillic characters are replaced by Latin letters, for example, ш to sch.

In the maxLength branch, you can find additional functionality: If you want to set the maximum length of the header text, you need to set the checkHeaderLength parameter to TRUE in the config.

In the cyrToLat_with_maxLength branch, you can find additional features from branches cyrToLat and maxLength at the same time.

P.S. The anchor value is displayed next to the header block only when there is text in the header block.

Shortcut

You can insert this Block by a useful shortcut. Set it up with the tools[].shortcut property of the Editor's initial config.

1var editor = EditorJS({
2  ...
3
4  tools: {
5    ...
6    header: {
7      class: Header,
8      shortcut: 'CMD+SHIFT+H',
9    },
10  },
11
12  ...
13});

Config Params

All properties are optional.

Field	Type	Description
placeholder	`string`	header's placeholder string
levels	`number[]`	enabled heading levels
defaultLevel	`number`	default heading level
allowAnchor	`boolean`	Anchor enabling (default: `true`)
anchorLength	`number`	Anchor length (default: `50`)

1var editor = EditorJS({
2  ...
3
4  tools: {
5    ...
6    header: {
7      class: Header,
8      config: {
9        placeholder: 'Enter a header',
10        levels: [2, 3, 4],
11        defaultLevel: 3,
12        allowAnchor: true,
13        anchorLength: 100,
14      }
15    }
16  }
17
18  ...
19});

Output data

Field	Type	Description
text	`string`	header's text
level	`number`	level of header: 1 for H1, 2 for H2 ... 6 for H6
anchor	`string`	anchor's text

1{
2  "type": "header",
3  "data": {
4    "text": "Why Telegram is the best messenger",
5    "level": 2,
6    "anchor": "Anchor"
7  }
8}

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2025-02-17

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More