<commit_before>= bespoke-cursor
<NAME> <https://github.com/mojavelinux>
// Settings:
:idprefix:
:idseparator: -
ifdef::env-github[:badges:]
// URIs:
:uri-raw-file-base: https://raw.githubusercontent.com/opendevise/bespoke-cursor/master

ifdef::badges[]
image:https://img.shields.io/npm/v/bespoke-cursor.svg[npm package, link=https://www.npmjs.com/package/bespoke-cursor]
image:https://img.shields.io/travis/opendevise/bespoke-cursor/master.svg[Build Status (Travis CI), link=https://travis-ci.org/opendevise/bespoke-cursor]
endif::[]

"You don’t want the mouse pointer to be hanging there on the slide, where you left it, like the gross house fly."
-- <NAME>

This plugin takes care of that problem for you.
After a configurable timeout (default: 1s), the mouse cursor will disappear, never to be heard from until you move the mouse again.

== Example

http://opendevise.github.io/bespoke-cursor[View the demo] online.

This repository includes a demo folder the shows this plugin in action.
To view it locally, you first need to clone this repository:

 $ git clone https://github.com/opendevise/bespoke-cursor && cd bespoke-cursor

Next, install the dependencies inside the project folder using npm:

 $ npm install

Finally, visit the file [path]_demo/index.html_ in your browser to see the plugin in action.

== Download

Download the {uri-raw-file-base}/dist/bespoke-cursor.min.js[production mode version] or the {uri-raw-file-base}/dist/bespoke-cursor.js[development mode version], or use a package manager.

=== npm

 $ npm install bespoke-cursor

=== Bower

 $ bower install bespoke-cursor

== Usage

This plugin is shipped in a https://github.com/umdjs/umd[UMD format], meaning it is available as a CommonJS/AMD module or as a browser global.

For example, when using CommonJS modules:

```js
var bespoke = require('bespoke'),
  cursor = require('bespoke-cursor');

bespoke.from('.deck', [
  cursor()
]);
```

When using a browser global:

```js
bespoke.from('.deck', [
  bespoke.plugins.cursor()
]);
```

== Credits

This plugin was built with https://github.com/markdalgleish/generator-bespokeplugin[generator-bespokeplugin].<commit_msg>document options<commit_after>= bespoke-cursor
<NAME> <https://github.com/mojavelinux>
// Settings:
:idprefix:
:idseparator: -
ifdef::env-github[:badges:]
// URIs:
:uri-raw-file-base: https://raw.githubusercontent.com/opendevise/bespoke-cursor/master

ifdef::badges[]
image:https://img.shields.io/npm/v/bespoke-cursor.svg[npm package, link=https://www.npmjs.com/package/bespoke-cursor]
image:https://img.shields.io/travis/opendevise/bespoke-cursor/master.svg[Build Status (Travis CI), link=https://travis-ci.org/opendevise/bespoke-cursor]
endif::[]

"You don’t want the mouse pointer hanging there on the slide, where you left it, like the gross house fly."
-- <NAME>

This plugin takes care of that problem for you.
After a configurable timeout (default: 1000ms), the mouse cursor will disappear, never to be heard from again until you move the mouse.

== Example

http://opendevise.github.io/bespoke-cursor[View the demo] online.

This repository includes a demo folder the shows this plugin in action.
To view it locally, you first need to clone this repository:

 $ git clone https://github.com/opendevise/bespoke-cursor && cd bespoke-cursor

Next, install the dependencies inside the project folder using npm:

 $ npm install

Finally, visit the file [path]_demo/index.html_ in your browser to see the plugin in action.

== Download

Download the {uri-raw-file-base}/dist/bespoke-cursor.min.js[production mode version] or the {uri-raw-file-base}/dist/bespoke-cursor.js[development mode version], or use a package manager.

=== npm

 $ npm install bespoke-cursor

=== Bower

 $ bower install bespoke-cursor

== Usage

This plugin is shipped in a https://github.com/umdjs/umd[UMD format], meaning it is available as a CommonJS/AMD module or as a browser global.

For example, when using CommonJS modules:

```js
var bespoke = require('bespoke'),
  cursor = require('bespoke-cursor');

bespoke.from('.deck', [
  cursor()
]);
```

When using a browser global:

```js
bespoke.from('.deck', [
  bespoke.plugins.cursor()
]);
```

=== Options

The following options are available when registering the bespoke-cursor plugin:

timeout _(type: integer, default: 1000)_::
The duration in milliseconds the cursor will remain visible after the last mouse movement.
After this time has elapsed, the cursor will disappear.

=== Options example

Here's an example showing the options in use:

```
bespoke.from('.deck', [
  cursor({timeout: 2000})
]);
```
{'fraction_non_alphanumeric': 0.12461873638344227, 'fraction_numerical': 0.002832244008714597, 'mean_word_length': 4.591961023142509, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 17, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1240864', 'n_tokens_mistral': 1505, 'n_tokens_neox': 1434, 'n_words': 461}