JavaScripting

The definitive source of the best
JavaScript libraries, frameworks, and plugins.


  • ×

    Modernizr is a JavaScript library that detects HTML5 and CSS3 features in the user’s browser.
    Filed under  › 

    • 🔾92%Overall
    • 23,705
    • 7.9 days
    • 🕩3039
    • 👥40

    Modernizr

    npm version Build Status Inline docs

    Modernizr is a JavaScript library that detects HTML5 and CSS3 features in the user’s browser.

    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 <html> element. This information allows you to progressively enhance your pages with a granular level of control over the experience.

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

    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 <html> 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:

    // Listen to a test, give it a callback
    Modernizr.on('testname', function( result ) {
      if (result) {
        console.log('The test passed!');
      }
      else {
        console.log('The test failed!');
      }
    });
    

    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:

    var modernizr = require("modernizr");
    

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

    var modernizr = require("modernizr");
    
    modernizr.build({}, function (result) {
      console.log(result); // the build
    });
    

    The first parameter takes a JSON object of options and feature-detects to include. See 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:

    ./bin/modernizr
    

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

    npm start
    //outputs to ./dist/modernizr-build.js
    

    Testing Modernizr

    To execute the tests on the console run:

    npm test
    

    License

    MIT License

    Show All