Code Monkey home page Code Monkey logo

window-classlist's Introduction

ClassList

Not really an Element#classList polyfill. IE9 doesn’t have classList, and other browsers have incomplete implementations; hence, this module.

Usage

This module is intended for use in the browser via browserify. It can be installed via npm:

$ npm install classlist

And then used like so:

var ClassList = require('classlist')

var element = document.querySelector('.foo'),
    list = ClassList(element)

// Add a class:
list.add('bar')

// Remove another:
list.remove('baz')

// Toggle:
list.toggle('quux')

// Check for existence:
if (list.contains('bar')) {
    alert('Whee')
}

API

This module mostly tracks the offical API, but returns the context wherever possible; this allows you to do things like:

ClassList(element)
  .add('foo', 'bar')
  .remove('baz')
  .toggle('quux')

var list = new ClassList(element)

Note that using new is optional. Returns an array-like object of the element’s classes. This object has several handy methods; see below.

list.add(class1 [, class2 [, ... ]])

Adds one or more classes to the element originally used to construct the list. If the class is already present on the element, it is not added again. Returns the context to allow chaining.

list.remove(class1 [, class2 [, ... ]])

Removes one or more classes from the element. Returns the context to allow chaining.

list.toggle(class [, force ])

Toggles a class on the element; adds the class if it is not present, and removes it otherwise. When force is true, the class is always added; when false, the class is removed (i.e. .toggle(class, true) is equivalent to .add(class), and .toggle(class, false) is equivalent to .remove(class)). Returns the context to allow chaining.

list.contains(class)

Returns true if the element has the given class; false otherwise.

Browser support

ClassList should work in just about every browser, up to and including IE6. If it doesn’t, open an issue.

License

MIT.

window-classlist's People

Contributors

lucthev avatar

Watchers

James Cloos avatar Avaer Kazmer avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.