robloach/jquery-once

Act on jQuery elements only once.

2.3.0 2024-01-04 22:13 UTC

Requires

• components/jquery: *

MIT, GPL-2.0

README

Act on jQuery elements only once.

Filters out all elements that had the same filter applied on them before. It can be used to ensure that a function is only applied once to an element.

Install

Usage

See the API documentation for more information on how to use jQuery Once.

// The following will change the color of each paragraph to red, just once
// for the "changecolor" key.
$('p').once('changecolor').css('color', 'red');

// .once() will return a set of elements that yet to have the once ID
// associated with them. You can return to the original collection set by
// using .end().
$('p')
  .once("changecolorblue")
    .css("color", "blue")
  .end()
  .css("color", "red");

// To execute a function on the once set, you can use jQuery's each().
$('div.calendar').once().each(function() {
  // Since there is no once ID provided here, the key will be "once".
});

Development

1. Ensure you are using node >= 4:

node --version

1. Install dependencies through npm:

npm install

1. Check coding style standard, and automated testing:

npm test

1. Build jquery.once.min.js with:

npm run build

1. Update API documentation:

npm run docs

1. Tag and publish the new versions to npm with Semantic Versioning:

git add -A
git commit -m "2.3.0"
git tag 2.3.0
git push origin 2.3.0
npm publish

Change Log

Discover the change history by heading on over to the CHANGELOG.md file.

License

Dual licensed under:

• GPL-2.0
• the incredibly permissive MIT license

Copyright © Rob Loach