Skip to content

art-emini/SpacerJS

Repository files navigation

SpacerJS

Manipulate the DOM easily


About

SpacerJS is a lightweight JavaScript library that enables you to manipulate elements and the DOM easily.

SpacerJS main file only comes in at ~25kb un-minified and ~9kb minified.

SpacerJS receives frequent updates.

Since SpacerJS is written in typescript, bugs are rare and SpacerJS can be compatible with older versions of Ecmascript. (coming soon)


Features

  1. Small package at ~9kb minified
  2. Over 55 different methods
  3. Smart selection
  4. Event listeners
  5. Trigger events
  6. Animating Elements
  7. Promises
  8. Setting Metadata
  9. ESM Module files minified and unminifed for your needs
  10. Add your own custom methods
  11. Hiding and Showing elements with set metadata
  12. Smart and compact on() event listener
  13. Adding and removing classes.
  14. Great Docs
  15. Easy to follow examples
  16. Testing Code
  17. And a lot more

Download

Github

  1. Download the latest release.
  2. And link the script tag with the defer attribute or at the bottom of the body tag.
  3. Done! Be sure to read the docs.

CDN

To get the ESModule version add .esm.js. Ex: https://cdn.jsdelivr.net/npm/spacerjs@2.1.0/build/Spacer.esm.min.js

Production

  1. Copy paste the following script tag in the body or with the defer attribute

    <script src="https://cdn.jsdelivr.net/npm/spacerjs@2.1.0/build/Spacer.min.js"></script>

  2. Done! Be sure to read the docs.

Development

  1. Copy paste the following script tag in the body or with the defer attribute

    <script src="https://cdn.jsdelivr.net/npm/spacerjs@2.1.0/build/Spacer.js"></script>

  2. Done! Be sure to read the docs.

NPM

  1. Run npm install spacerjs.
  2. Import it as a module OR link the script in the body or with the defer attribute.
  3. Done! Be sure to read the docs.

Developers

NPM Scripts


npm run minify

  • Minifies with uglify-js

Contributing

Requires a knowledge of NodeJS, TypeScript, and git.

  1. Read Code of Conduct.md & Contributing.md.
  2. Fork the repo.
  3. Make your edits and create a pull request with the appropriate labels.
  4. Your pull request will be reviewed and merged.



Maintained and created by: ksplatdev