Skip to content

chriszarate/bookmarkleter

Repository files navigation

Bookmarkleter

Build status Test coverage NPM version

You have JavaScript. You need a bookmarklet. This does that.

Browser tool

Create bookmarklets in your browser with a simple copy and paste.

https://chriszarate.github.io/bookmarkleter/

NPM module

npm install --save bookmarkleter
const bookmarkleter = require( 'bookmarkleter' );
const bookmarklet = bookmarkleter( code, options );

Options

All options are Boolean flags.

  • urlencode (default true): URL-encode reserved characters: [space], %, ", <, >, #, @, &, ?

  • iife (default false): Wrap in an IIFE (anonymizing function) to prevent exposing variables to the page on which the bookmarklet is running.

  • mangleVars (default false): Mangle variable names and other tokens to further reduce size.

  • transpile (default false): Transpile for browsers using Babel.

  • jQuery (default false): Make sure a modern version (>= 1.7) of jQuery is available for your code.

Deprecated options

  • minify: Code is always minified (with comments removed) using babel-minify. Bookmarklets require minification to function correctly. Use mangleVars option for additional compactness.

License

This is free software. It is released to the public domain without warranty.

Thanks

Thanks to @jpillora and @alanhogan for updates and contributions.