hanchor
v1.0.9
Published
Autogenerate links to header tags from header text
Downloads
12
Maintainers
rdydnsReadme
hanchor
Autogenerate links to header tags from header text
Installation
$ npm install --save hanchorUsage
The quickest way to begin using hanchor is to include it in the <head> of your HTML document.
<head>
<script src="https://unpkg.com/[email protected]" />
</head><html>
...
<script type="text/javascript">
(function() {
hanchor.init('article');
})();
</script>
...
</html>API
hanchor(scope, [options])
scope
Type: stringor object, Default: 'body'
The DOM element that header linking is scoped to.
options.content
Type: string, Default: '#'
The content of the header tag link.
options.className
Type: string or false, Default: false
Class to be assigned to the header tag links.
options.position
Type: string, Default: 'beforeend'
Position the link 'beforebegin', 'afterbegin', 'beforeend' or 'afterend' in reference to the the header tag.
License
MIT © Rodney Dennis