Skip to content

Latest commit

 

History

History
151 lines (93 loc) · 4.82 KB

README.md

File metadata and controls

151 lines (93 loc) · 4.82 KB
Raw

Umbrella JS test badge stats License MIT

Library Documentation | Migrating from jQuery guide

Covers your javascript needs for those rainy days. A <3kb performant jQuery-like library born from the question: You might not need jQuery, then what do you need?

You probably need awesome CSS (like Picnic CSS) and a lightweight, modern and performant javascript library. This does:

  • DOM traversal (selector, filter, find, each, etc.)
  • DOM editing (classes & attributes, html, before, etc.)
  • Event handling

A couple of simple examples:

// Simple events like jQuery
u("button").on('click', e => {
  alert("Hello world");
});

// Handle form submissions
u('form.login').handle('submit', async e => {
  const user = await fetch('/login', {
    method: 'POST', body: new FormData(e.target)
  }).then(res => res.json());
  window.href = '/user/' + user.id;
});

Getting started

There are few ways to use Umbrella JS:

Play with it

Instead of installing it, you can just play with it in JSFiddle:

Try on JSFiddle

Use a CDN

jsdelivr.com is an awesome OSS service that hosts many open source projects so you don't need to even download the code:

<script src="https://cdn.jsdelivr.net/npm/umbrellajs"></script>

Install with npm

Using npm is a front-end package manager that makes it super-easy to add a new package:

npm install umbrellajs

Module support

If you use a front-end module bundler like Webpack or Browserify, u is exposed as CommonJS exports. You can pull them in like so:

// ES Modules/Webpack/etc
import u from 'umbrellajs';

// Commonjs
var u = require('umbrellajs');

ES Module support

If you use an ES Module, u and ajax are exposed as ES Module exports. You can pull them in like so:

import u from 'umbrellajs/umbrella.esm.js'

Download it

If you like it or prefer to try it locally, just download umbrella.min.js:

Download Umbrella JS

Add it to your project:

<script src="umbrella.min.js"></script>

Support: IE11+

Current usage for IE 10- is under 1% for each version (8, 9, 10) so it's not Umbrella's mission to support this. However, those extra seconds gained from loading faster on mobile might be even bigger than that percentage. You should probably test it.

Known, wontfix IE10- bugs:

Alternatives

Author and License

Created and maintained by Francisco Presencia under the MIT license.

References