Skip to content

Commit

Permalink
Readme update.
Browse files Browse the repository at this point in the history
  • Loading branch information
kmewhort committed Jul 19, 2013
1 parent 496796b commit eb506b6
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
@@ -1,14 +1,12 @@
# Pointer Events Polyfill

Pointer Events Polyfill is a short javascript library to add support for the style attribute "pointer-events: none" to browsers without this feature (namely, MS IE).
Pointer Events Polyfill is a short javascript library which adds support for the style attribute "pointer-events: none" to browsers without this feature (namely, MS IE).

## Installation

Include any reasonable recent version of **jQuery** and **pointer_events_polyfill.js**.
Include any reasonable recent version of **jQuery** and **pointer\_events\_polyfill.js**.

## Usage

Basic usage:
## Basic usage:

$(document).ready(function(){
PointerEventsPolyfill.initialize({});
Expand All @@ -19,9 +17,10 @@ That's it! Any "pointer-events: none" attributes will now work seamlessly in IE.
## Options

You can also pass any of the following options into the *initialize* call:
* **selector**: CSS selector [default: '*']. You may wish to narrow this from '*' (all elements) in order to increase performance.
* **mouseEvents** Array of JS mouse events [default: ['click','dblclick','mousedown','mouseup']]. Note that the default excludes a few for performance reasons, but you can add them back in.
* **usePolyfillIf** function with a return of true to initialize Pointer Events Polyfill [default: simply check for IE<11]. You can specify your own browser-support testing function here (for example, you may wish to use feature detection with Modernizr instead of the default IE check).

* **selector**: CSS selector (default: \*). You may wish to narrow this from '*' (all elements) in order to increase performance.
* **mouseEvents**: Array of JS mouse events (default: ['click','dblclick','mousedown','mouseup']). Note that this default excludes a few mouse events for performance reasons, but you can add them back in.
* **usePolyfillIf**: Function with boolean return value (default: simple check for IE<11). Return *true* to apply Pointer Events Polyfill. You can specify your own browser-support test function here (for example, you may wish to use feature detection with Modernizr instead of the default IE check).

## License

Expand Down

0 comments on commit eb506b6

Please sign in to comment.