reveal.js-pointer

v0.1.4

Published

2 years ago

Mouse pointer for RevealJS lib

Downloads

107

0High
0Medium
0Low

burnpiro

reveal revealjs pointer

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:

["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "backspace", "tab", "enter", "shift", "ctrl", "alt", "pausebreak", "capslock", "esc", "space", "pageup", "pagedown", "end", "home", "leftarrow", "uparrow", "rightarrow", "downarrow", "insert", "delete", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "leftwindowkey", "rightwindowkey", "selectkey", "numpad0", "numpad1", "numpad2", "numpad3", "numpad4", "numpad5", "numpad6", "numpad7", "numpad8", "numpad9", "multiply", "add", "subtract", "decimalpoint", "divide", "f1", "f2", "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", "f11", "f12", "numlock", "scrolllock", "semicolon", "equalsign", "comma", "dash", "period", "forwardslash", "graveaccent", "openbracket", "backslash", "closebracket", "singlequote"]

Developing

Make changes in src/plugin.js and run:

npm run build

This is going to produce dist/pointer.js with bundled iife file.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

RevealJS pointer plugin (1.5KB gzipped)

Installation

Config

Developing