simple-anchor
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

🔗 Simple Anchor

CI npm MIT License

A JavaScript utility for adding deep anchor links (like these) to existing page content. Zero dependencies and only ~1kB gzipped!

Changes from AnchorJS

  • Styling of .anchorjs-link elements is completely on you. The non-optional and hefty base styles of AnchorJS have been removed for a slimmer module. (This includes the default 🔗 icon.)
  • Element IDs are also left to you — this package will not generate an element's ID automatically if one is not already set (eg. <h2 id="installation">Installation</h2>). Elements without one are automatically ignored.

Otherwise, the AnchorJS docs still serve as a good reference.

Usage

Browser

<script src="https://unpkg.com/simple-anchor/dist/simple-anchor.min.js"></script>
<script>
  var anchor = new SimpleAnchor();
  anchors.add({
   icon: '#'
  });
</script>

Node

npm install simple-anchor
# or...
yarn add simple-anchor
import SimpleAnchor from 'simple-anchor';
// or...
// const SimpleAnchor = require('simple-anchor');

const anchors = new SimpleAnchor();
anchors.add({
   icon: '#'
});

Since AnchorJS's default CSS has been removed as mentioned above, it's up to you to style the .anchorjs-link element.

Examples

License

MIT

Package Sidebar

Install

npm i simple-anchor

Weekly Downloads

0

Version

1.0.3

License

MIT

Unpacked Size

32 kB

Total Files

10

Last publish

Collaborators

  • jakejarvis