0.1.4 • Published 2 years ago
reveal.js-pointer v0.1.4
RevealJS pointer plugin (1.5KB gzipped)
Changes your mouse into a pointer when necessary. Demo ("q", 18px
, red
).
This plugin only works with RevealJS
v4.x
or higher.
No external dependencies, only 2.6KB | <1.5KB gzipped.
Installation
Copy dist/pointer.js
into plugins/pointer/pointer.js
and import script:
[...]
<script src="plugin/pointer/pointer.js"></script>
[...]
Copy dist/pointer.css
into plugins/pointer/pointer.css
and import style in <head></head>
:
[...]
<link rel="stylesheet" href="plugin/pointer/pointer.css" />
[...]
Add RevealPointer
into your plugins initialization:
plugins: [RevealPointer];
Config
You can configure pointer key and tail length in plugin config.
Reveal.initialize({
pointer: {
key: "q", // key to enable pointer, default "q", not case-sensitive
color: "red", // color of a cursor, default "red" any valid CSS color
opacity: 0.8, // opacity of cursor, default 0.8
pointerSize: 12, // pointer size in px, default 12
alwaysVisible: false, // should pointer mode be always visible? default "false"
tailLength: 10, // NOT IMPLEMENTED YET!!! how long the "tail" should be? default 10
}
})
List of available keys:
Developing
Make changes in src/plugin.js
and run:
npm run build
This is going to produce dist/pointer.js
with bundled iife file.