Modernizr

Modernizr is a JavaScript library that detects HTML5 and CSS3 features in t...

Browser compatibility
Modernizr/Modernizrmodernizr

README

Modernizr

  
Modernizr is a JavaScript library that detects HTML5 and CSS3 features in the user’s browser.
   npm version Build Status codecov Inline docs


- Read this file in Portuguese-BR here
- Read this file in Indonesian here
- Read this file in Spanish here
- Read this file in Swedish here
- Read this file in Tamil here

- Our Website is outdated and broken, please DO NOT use it (https://modernizr.com) but rather build your modernizr version from npm.
- Documentation
- Integration tests
- Unit tests

Modernizr tests which native CSS3 and HTML5 features are available in the current UA and makes the results available to you in two ways: as properties on a global `Modernizr` object, and as classes on the `` element. This information allows you to progressively enhance your pages with a granular level of control over the experience.

Breaking changes with v4


- Dropped support for node versions <= 10, please upgrade to at least version 12

- Following tests got renamed:
  
  - class to es6class to keep in line with the rest of the es-tests

- Following tests got moved in subdirectories:

  - cookies, indexeddb, indexedblob, quota-management-api, userdata moved into the storage subdirectory
  - audio moved into the audio subdirectory
  - battery moved into the battery subdirectory
  - canvas, canvastext moved into the canvas subdirectory
  - customevent, eventlistener, forcetouch, hashchange, pointerevents, proximity moved into the event subdirectory
  - exiforientation moved into the image subdirectory
  - capture, fileinput, fileinputdirectory, formatattribute, input, inputnumber-l10n, inputsearchevent, inputtypes, placeholder, requestautocomplete, validation moved into the input subdirectory
  - svg moved into the svg subdirectory
  - webgl moved into the webgl subdirectory
    
- Following tests got removed:
  
  - touchevents: discussion
  - unicode: discussion
  - templatestrings: duplicate of the es6 detect stringtemplate
  - contains: duplicate of the es6 detect es6string
  - datalistelem: A dupe of Modernizr.input.list

New Asynchronous Event Listeners


Often times people want to know when an asynchronous test is done so they can allow their application to react to it.
In the past, you've had to rely on watching properties or `` classes. Only events on **asynchronous** tests are
supported. Synchronous tests should be handled synchronously to improve speed and to maintain consistency.

The new API looks like this:

  1. ``` js
  2. // Listen to a test, give it a callback
  3. Modernizr.on('testname', function( result ) {
  4.   if (result) {
  5.     console.log('The test passed!');
  6.   }
  7.   else {
  8.     console.log('The test failed!');
  9.   }
  10. });
  11. ```

We guarantee that we'll only invoke your function once (per time that you call on). We are currently not exposing
a method for exposing the trigger functionality. Instead, if you'd like to have control over async tests, use the
src/addTest feature, and any test that you set will automatically expose and trigger the on functionality.

Getting Started


- Clone or download the repository
- Install project dependencies with npm install

Building Modernizr


From javascript


Modernizr can be used programmatically via npm:

  1. ``` js
  2. var modernizr = require("modernizr");
  3. ```

A build method is exposed for generating custom Modernizr builds. Example:

  1. ``` js
  2. var modernizr = require("modernizr");

  4. modernizr.build({}, function (result) {
  5.   console.log(result); // the build
  6. });
  7. ```

The first parameter takes a JSON object of options and feature-detects to include. See [lib/config-all.json](lib/config-all.json) for all available options.

The second parameter is a function invoked on task completion.

From the command-line


We also provide a command line interface for building modernizr.
To see all available options run:

  1. ``` sh
  2. ./bin/modernizr
  3. ```

Or to generate everything in 'config-all.json' run this with npm:

  1. ``` sh
  2. npm start
  3. //outputs to ./dist/modernizr-build.js
  4. ```

Testing Modernizr


To execute the tests using mocha-headless-chrome on the console run:

  1. ``` sh
  2. npm test
  3. ```

You can also run tests in the browser of your choice with this command:

  1. ``` sh
  2. npm run serve-gh-pages
  3. ```

and navigating to these two URLs:

  1. ``` sh
  2. http://localhost:8080/test/unit.html
  3. http://localhost:8080/test/integration.html
  4. ```

Code of Conduct


This project adheres to the Open Code of Conduct.
By participating, you are expected to honor this code.


License


MIT License