Show HN: Umbrella JS, a 2.5kb jQuery alternative

by franciscop • 8 years ago

132 75 8 years ago

franciscop13• 8 years ago

I submitted this 3 years back [1] when I was starting. But now I think it's finished and well polished, so I am resubmitting it. I am happy to say that I don't normally find bugs anymore and the bug reports have slowed down while adoption has skyrocketed [2] [3]

It follows loosely a subset of jQuery methods, but it adds some others where relevant for common JS patterns (.handle() == .on() + e.preventDefault()) and the existing ones are generally more flexible.

[1] https://news.ycombinator.com/item?id=10954191

[2] https://npm-stat.com/charts.html?package=umbrellajs&from=201...

[3] https://www.jsdelivr.com/package/npm/umbrellajs

brennebeck• 8 years ago

Looks interesting. How compatible with jquery is it? You say a subset, but is that an exact subset that would pass tests for those methods? Either way, well done!

sonofblah• 8 years ago

Is this criterion keeping you from using the framework right now?

franciscop13• 8 years ago

No, no method would pass all of the tests for said method in jQuery. I believe a part of those tests in jQuery are retroactive to settle the behavior of very edge undocumented cases, which might be different in Umbrella.js.

I did in fact try to improve the size of jQuery, but the tests are too coupled to the internal behavior of the methods, even if undocumented and (potentially) unintended initially. So it was very difficult even to change the most basic things, let alone change the internal structure of the whole method.

With Umbrella JS I'm trying to get to somewhere closer to native Javascript than jQuery. See for instance the arguments of any looping function (follows similar to the native arrays), or how things like .addClass(name) [1] are thin wrappers around .classList.add(name) (but quite more permissive/flexible). So it will follow closer to classList behavior than to whatever is defined in jQuery's tests, which is a win-win IMHO (since it also makes for a much smaller size, compare to jQuery's .addClass(name) [2]).

[1] https://github.com/franciscop/umbrella/blob/master/src/plugi...

[2] https://github.com/jquery/jquery/blob/master/src/attributes/...

pvorb5• 8 years ago

Nice that you're using npm-stat.com for checking adoption. I should use your library on the site.

franciscop13• 8 years ago

Thank for npm-stat! I use it a lot and love it, see my other repos from my website (in my profile).

Not sure how much sense it makes for Umbrella JS though, since traditionally it'd be used under a CDN but now with webpack it's treated as another dependency. Indeed, the CDN has remain constant-ish but the npm one has grown quite a bit in the last year.

Feel free to use Umbrella JS and ask me any question!

simonw2• 8 years ago

This looks pretty great - I really like the look of Picnic, the author's lightweight (10KB) bootstrap alternative as well: https://github.com/franciscop/picnic

franciscop13• 8 years ago

Thanks! I have two other libraries (besides Umbrella JS) that I really care about: Picnic CSS [1] and Server.js [2]. I'll be trying to do some cleaning in my spare time, but both of those require humongous amounts of work to get to the quality level of Umbrella JS.

[1] https://picnicss.com/

[2] https://serverjs.io/

pritambaral• 8 years ago

Two suggestions, both slightly pedantic:

1. I went by the name and typed picniccss.com instead of picnicss.com and it didn't work. picnic-es-es does sound weird in one's head too.

2. On the website, you say '10kb' but should probably use '10kB'. The small-b is conventionally used to indicate bits and the capital-b is used to indicate bytes.

throwawaysky92• 8 years ago

I don't want to be "that guy", but haven't most people moved on to something like Vue instead of manipulating the DOM directly? Every developer I've worked with learned the basics of Vue quickly (less than a day) and marveled at how great it was compared to manipulating the DOM through jQuery (or something similar like Umbrella JS). But sure, there are edge cases where jQuery and similar libs still serve a purpose.

simonw2• 8 years ago

Vue and React make sense for large SPA-style applications, but I often find myself wanting to drop a few lines of JavaScript onto a page to implement something simple without pulling in a massive framework dependency that requires a webpack compile step.

mmargerum• 8 years ago

You don’t have to use webpack with vue. Only if you want single file components. You literally just include in script line and you can use vue. No harder than jquery.

throwawaysky92• 8 years ago

jQuery is 84 KB minimized, while Vue is 85 KB. Not much of a difference (although, granted, Umbrella JS is notably smaller). You don't necessarily need Webpack for Vue, you can just include Vue in a script tag and write your code.

EB66• 8 years ago

Vue and React make sense for large SPA-style applications

Agreed, but I want to point out that modern, large SPA-style app architecture and jQuery are not necessarily mutually exclusive. jQuery might not work with React and Vue, but it can work alongside other frameworks just fine (yep, without manual DOM manipulations).

jQuery offers utility beyond ensuring your code runs the same across different browsers. For instance, I've yet to see another `replaceWith` as concise as what jQuery offers or DocumentFragment generation as expressive as this: `$("<div>hello world <span>foo bar</span></div>");` For those two examples, the alternatives listed on http://youmightnotneedjquery.com/ are either very verbose or do not mimic the full functionality offered by jQuery.

Where I work we've built an in-house JS framework inspired by React and Vue but that "plays nicely" with our jQuery legacy codebase. The framework evens uses jQuery at it's core for UI state management and DocumentFragment generation. Re-factoring our jQuery legacy code is a breeze when compared with re-writing it to conform to React or Vue standards. We write modular and consistent components with `this.props`-style state management, one-way data binding, and zero manual DOM manipulations while still using jQuery.

TLDR: jQuery offers utility beyond manual DOM manipulations and smoothing out browser differences. When used appropriately, it still has a place in modern JS component architecture.

gremlinsinc2• 8 years ago

Vue is VERY much an easy drop in for small things..I've totally started replacing it wherever I'd otherwise have used jquery... and I can't say I'm sorry I have. But all my projects use laravel on backend, and laravel has webpack/vue baked in so there's really nothing I need to configure for it to work, too much..a little tweaking in the app.js file..that's all.

pier252• 8 years ago

Neither Vue nor React are really frameworks, and both can be used with a script tag without a compile step.

CM30• 8 years ago

Not all of them. There are still plenty of sites that aren't SPAs, especially those built with CMS' like WordPress, Drupal and Joomla (or various forums, wikis, etc). In those cases, you don't want to have to redo the whole frontend in React or Vue, you just wanta simple way to manipulate DOM elements for things like a dropdown menu or modal or what not.

Something like this may work fine for that purpose. There are still thousands or millions of websites that don't act like an SPA/

goatlover• 8 years ago

There are still plenty of sites that aren't SPAs, especially those built with CMS' like WordPress, Drupal and Joomla (or various forums, wikis, etc)

It's as if those sites don't exist for the HN crowd, even though they make up the majority of the web.

waveforms• 8 years ago

According to this website [1] jQuery is still used by over 70% of websites. I have built production sites in extjs, Dojo, Angular, React etc. but nothing beats the fun of throwing up a quick website in jQuery and Bootstrap. Its even more fun with es6 now! I am looking forward to where jQuery and other DOM manipulation libraries go in the future. [1] https://w3techs.com/technologies/details/js-jquery/all/all

Secretmapper• 8 years ago

Spot on! I'm a ReactJS developer by trade, but when doing side projects, I still use jQuery from time to time, especially if the client is not that state-heavy. I know I can make do with fetch, querySelector/All and the like, but I'd rather take the convenience.

alangpierce2• 8 years ago

Just to balance the "70% of websites" number, I've worked on a number of websites where there was still some legacy jQuery floating around, but where all new development is expected to happen in a modern framework like React, and new code using jQuery would be unlikely to pass code review. Or, perhaps, where jQuery is legitimately used as part of the occasional escape hatch when you can't use React for some technical reason, but is discouraged and only used with careful scrutiny.

I suspect that if you refined it to "How many new websites in the last year use jQuery as their primary UI library?", the number would be much lower.

the_duke• 8 years ago

But why do you need jQuery for that? Browser APIs have gotten good enough that jQuery is not really needed anymore, imo.

franciscop13• 8 years ago

For the other points, the other comments are quite spot on.

Load speed:

Umbrella's 2.5kb loads well under the rule-of-thumb size of a single packet of 14kb [1], so you have to do a single roundtrip for that [2]. In this 3rd party test [3] it takes ~200ms to load the whole Umbrella JS. JQuery weights ~30x more kb, so there are several packets sent, which makes it load in ~2s in the same test.

Not to mention parsing and running all that extra JS.

Heck, I regularly bundle my whole JS in a single file and thanks to Umbrella JS tiny size the whole thing weights well under 14kb. It loads in a snap.

Edit: early send

[1] https://tylercipriani.com/blog/2016/09/25/the-14kb-in-the-tc...

[2] Excluding the TLS trip, which is common anyway.

[3] https://speakerdeck.com/mattclaffey/using-umbrella-js-for-mo...

jedisct1• 8 years ago

Wordpress.

Other than that, I don't see any reason to use jQuery (or something similar) in 2018.

ivanhoe• 8 years ago

it's definitely less used nowadays, partially because vue/react take care about a lot of work themselves, but also partially because virtual DOMs and component scopes make it complicated to work with DOM directly. I often run into little eye-candy things that jQ could take care of efficiently in a few lines of code, but because of everything else you end up building Animation components and HOCs instead that are in the end much more complex...

paradite2• 8 years ago

Slightly off topic, but I have this OCD that my brain hurts when I see people use wrong capitalization for products.

It is strongly influenced by jquery...

Please use jQuery instead, thank you.

anothergoogler• 8 years ago

Not only that, a code comment on the homepage refers to "ajax" rather than "AJAX". And would you believe that in the page copy, "JS" isn't in an <abbr> tag? The nerve of some people!

franciscop13• 8 years ago

English is my 3rd language so please forgive some typos and inaccuracies like these. I understand that these are similar for some people as when I see people using "their" when they mean "they're".

I agree it looks less professional, so I'll try fixing those. Is there any other bit that sounds off?

Edit: That should be fixed! Also a couple of missing `css` => `CSS`, `umbrella` => `Umbrella`, etc.

paradite2• 8 years ago

Thank you for the quick fix. And no, I don't go crazy over grammar or spelling (English is my second language as well). I think the website looks pretty cool and well written overall.

maxerickson• 8 years ago

The phrase you are looking for is "pet peeve".

alangpierce2• 8 years ago

+1. Using "OCD" casually to mean "things that annoy me when maybe they shouldn't" is a bit insensitive to people with real diagnosable OCD. Elements of OCD, like intrusive thoughts, are present in almost everyone, but usually the term "OCD" is reserved for cases where it has a significant negative impact on life.

https://en.wikipedia.org/wiki/Obsessive%E2%80%93compulsive_d...

wild_preference2• 8 years ago

My pet peeve is when people get mad when others don’t get a product’s branding 100% correct.

“Ugh, it’s ‘Lego’, not ‘legos’! ‘jQuery’, not ‘jquery’!”

IMO the world needs more people who don’t give a shit.

aphextron3• 8 years ago

Is anyone actually still using jQuery in a new project? I can’t think of a single good reason to do so.

dagoat• 8 years ago

You still need jQuery for Bootstrap

tenryuu• 8 years ago

I've always used bootstrap native, saved the extra request for jq

aphextron3• 8 years ago

Another great reason to never use Bootstrap

is_true• 8 years ago

It depends on what you need. You could use the grid without jquery

jister• 8 years ago

Sure, why not?!

krishanath2• 8 years ago

jQuery is a library of shortcuts. Everything you can do using jQuery you can do without jQuery, but that's like saying everything you can do in Excel you can do with just a Calculator app. Yes, it is possible, but why would you want to?

When you do things like drag & drop and interactive resize you have to query DOM to get position and sizes, and perform hit detection, and you have to manipulate DOM directly. jQuery is very convenient for these kinds of things.

aphextron3• 8 years ago

I know exactly what jQuery is. I’ve used it happily for years on many projects. However it is completely obsolete in 2018 for anyone that does not need to support IE8.

pier252• 8 years ago

I maintain a number of widgets with jQuery for an edtech app with drag and drop, works on mobile and desktop, etc.

I'm starting to rewrite those to Vue and I've found the main limitation is not the DOM access (since you can use refs) but the model logic. In Vue all data is made of primitives or dumb objects, you can't really use classes for reactive data.

octosphere• 8 years ago

jQuery is still very prevalent, especially on the legacy-web (those websites you rarely visit, but litter the web like a plague). Think e-commerce sites, Wordpress sites, spam blogs (splogs), e-book shops - they mostly use jQuery to sell you random crap you don't need, and jQuery was added on last minute to add some sheen to an otherwise plain site.

darol100• 8 years ago

From time to time, I need to make small interaction JS, which using React or Vue will be super overkill. Instead of using vanilla JS, I just use jQuery.

The biggest issue is that "small JS interaction" end up in an app. In that case, I will re-write in React.

vivab0rg• 8 years ago

As long as it is a Bootstrap dependency?

GuB-42• 8 years ago

How does it fare when it comes to browser compatibility?

IIRC, one of the main selling point of jQuery is compatibility with browsers like IE6.

franciscop13• 8 years ago

jQuery doesn't claim compatibility with IE6, they dropped it on jQuery 2.0 to IE8+: https://jquery.com/browser-support/

Umbrella JS supports Internet Explorer 11+, with some of the known bugs and wont-fix here: https://github.com/franciscop/umbrella#support-ie11

There is a polyfill to help here: https://github.com/franciscop/umbrella/blob/master/polyfill....

kristianp• 8 years ago

Thanks for those links. Also the latest jQuery now only supports Internet Explorer: 9+

paulie_a2• 8 years ago

Sidenote, everything and every web site should aggressively drop support for ie6.

pvorb5• 8 years ago

Why? If your website was IE6-compatible I'd salute you. Drpping support for legacy systems is something that's done too carelessly these days.

PS: I admit that it's hard to support IE6 when it's no longer supperted by MS itself.

bufferoverflow• 8 years ago

There are established tiny jQuery alternatives:

Zepto: https://github.com/madrobby/zepto

Cash: https://github.com/kenwheeler/cash

How is yours better?

franciscop13• 8 years ago

Zepto is intended as a full clone; objectives are quite different from Umbrella, so I don't see an overlap here since size is not such a priority. Using plugins? Zepto. Care about size a lot? Umbrella. Flexible methods? Umbrella.

About Cash, first Umbrella is about 0.5x the size. The version 1.0 of both were released the same year (Umbrella a bit later), so back then it was not established. Then, there are these differences (opinionated ofc):

Better documentation in Umbrella. As an example, let's see the .addClass() in Cash [1] and in Umbrella [2]. Umbrella has many input examples, a lot more flexibility in the arguments (functions, comma-separated, etc), practical explained examples and related methods. This holds true for every single method.

Better testing in Umbrella. Compare Cash tests [3] with Umbrella tests [4]; Cash has 663 LOC of testing while Umbrella has 2234 LOC, a 3.3x improvement. Not only that, but Umbrella has a public testing page so you can test it in any browser you want: https://umbrellajs.com/tests

Cleaner code in Umbrella. If you want to modify any method, it will be self-contained in `src/plugins/NAME/`. In there you will find the relevant documentation displayed from the readme.md, the relevant tests and the actual code. To modify Cash's addClass you'd have to chase down the code [5], the tests [6] and the documentation [1] while in Umbrella you'd only need to go to the plugin folder [7]

More methods in Cash. This is the one I've seen that seems nicer, since it supports many more methods. Still, Umbrella's objectives is to be the minimum useful set. .insert() is enough and there's no need for .insertBefore() IMHO, but that's just different opinions. Some people prefer to have the choice, so this one is for Cash.

Extra useful methods in Umbrella. .handle() is the common pair of .on() + e.preventDefault(). .size() returns an object with the size of the element like { width: 20, height: 20, top: 10, ... }.

Better methods in Umbrella. Examples: .append(), .prepend(), etc will clone events and values (if any) from the DOM. More functions accepted as arguments.

[1] Cash docs: https://github.com/kenwheeler/cash#fnaddclass-

[2] Umbrella docs: https://umbrellajs.com/documentation#addclass

[3] Cash tests: https://github.com/kenwheeler/cash/blob/master/test/index.js

[4] Umbrella tests: https://github.com/franciscop/umbrella/blob/master/docs/test...

[5] Cash addClass code: https://github.com/kenwheeler/cash/tree/master/src/attribute...

[6] Cash addClass tests: https://github.com/kenwheeler/cash/blob/master/test/index.js...

[7] Umbrella addClass folder: https://github.com/franciscop/umbrella/tree/master/src/plugi...

hughes2• 8 years ago

The fake scrollbar on the documentation page is infuriatingly nonfunctional.

franciscop13• 8 years ago

Uh? There is definitely no purposefully fake scrollbar, could you please share a screenshot and/or the device and browser you are using please? Ideally in Github as an issue: https://github.com/franciscop/umbrella/issues/new , but here is fine as well.

acqq• 8 years ago

I believe hughes means: "when you click on an entry of the documentation, e.g. '.wrap' in the "Contents" you see a scrolling animation instead of just the entry you'd like to read."

So not "scrollbar" but "scrolling" as the result of the click, on the documentation page:

https://umbrellajs.com/documentation

I'm one of those who have the problem with the animations in the UIs too. Believe or not some people get effectively a real sickness feeling just by looking at some specific movements, in my case that page manages to achieve that.

intellix• 8 years ago

Angular Ivy hello world is 2.5kb as well

franciscop13• 8 years ago

That is a very early, highly experimental minimal demo from what I found...

trumped• 8 years ago

oh good, maybe that will help reduce the general reliance on CDNs... (me dreaming)

Joyfield• 8 years ago

KB != kb.

Show HN: Umbrella JS, a 2.5kb jQuery alternative

Related Stories