A tiny script (<1KB) that automatically wraps and creates anchor links for headings that have an id. Anchor links (by default) use the browser URL hash to keep the links you've clicked.
linkjuice.init('.post__content', {
selectors: ['h2', 'h3'],
icon: '#'
});
Type: String Default: undefined
First argument is the target scope you want to bind to and search for heading tags.
Type: Array Default: ['h2', 'h3', 'h4', 'h5', 'h6']
Default heading tags to search for, omits <h1> by default as that's generally a page title.
Type: String Default: '#'
Default icon or text. This gets parsed to HTML so you can inject anything you like, such as <i class="my-icon"></i>.
Type: Function Default: A function which returns the heading content as a link, prepended with the icon string.
This function is used to customize how each heading tag contents are rewritten. It receives two parameters:
node: The Heading tag DOM Nodeicon: The value of options.iconIt should return a string which is the heading tag's rewritten content.
Example which returns the original heading text followed by a FontAwesome link icon:
const contentFn = (node) => `
${node.innerHTML}
<a href='#${node.id}' class='linkjuice'>
<i class='fa fa-link'></i>
</a>
`;
npm install linkjuice --save
Ensure you're using the files from the dist directory (contains compiled production-ready code). Ensure you place the script before the closing </body> tag.
<body>
<!-- html above -->
<script src="dist/linkjuice.js"></script>
<script>
// linkjuice module available
</script>
</body>
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Gulp.
The MIT License
Copyright (c) 2016 Todd Motto
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Automatically wraps and creates anchor links for headings
We found that linkjuice demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.