Repository files navigation

Chat on gitter

import{Slim}from'slim-js';import{tag,template}from'slim-js/decorators';@tag('my-awesome-element')@template(`<button @click="this.inc()"> + </button><span>{{this.count}}</span><button @click="this.dec()"> - </button>`)classextendsSlim{count=0;inc(){this.count++}dec(){this.count--}}

Slim is an ultra fast, native and elegant library forWeb Components development

Super fast. It leverages the native browser's API to manipulate DOM using templates, with custom directives. Imagine vue or angular's strctured templates combined with react's ease of use - combined, faster and lighter.

It's native. It has no black magic, no compilers and no external dependencies. It aims for fast performance, low CPU usage, using the native HTMLElement class inheritence and CustomElementsRegistry.

It works anywhere. You can combine slim.js in any other framework, combine any framework into slim.js app or any other combination.

You can write fully functional classes with complex code, or create pure "render-only" components without writing a single function.

Opt-in/Opt-out anything. The core is super small(2927 bytes gzipped), every directive is a self-contained module. Opt-in if you like. Pick your preferences for using (or not) shadow-dom. Work directly with properties on the element or create a view-model layer.

It's super easy to learn. Anything in your template that is wrapped with bars (example:<div>{{ this.user.name }}</div> ) is the actual code running. And it runs only when the used properties change. Changes affects only the specific DOM nodes that are bound. It means you can manipulate DOM manually without bothering the core, and vice-versa. No virtual dom engine or anything like that.

It just works. The library is written in javascript, and it hasindex.d.ts to support strongly-typed projects. It also provides access to it's internals, if you want to hack things out.

Directives are middlewares that executes code on your template whenever you have attributes in your markup. For example, if you opt-in for theproperty-directive, any attribute that starts with a period (i.e.<some-element .user="{{this.user}}"></some-element>) will trigger the property-directive into action:this.user will project as auser property intosome-element. Another example is theforeach-directive: You can map arrays or iterables to repeating elements. For example

<ul><li*foreach="{{this.users.slice(0, 50)}}"><imgsrc="{{item.picture}}"/><spanclass="user-name">{{item.name}}</span></li></ul>

slim.js provides the following out-of-the-box directives:

• custom-code (default)<form disabled="{{this.isFormReady(this.data)}}">...</form> or<div>Welcome, {{this.user.name}}!</div>
• property<img .src="{{this.imageSource}}">
• events<input @change="this.handleInputChange(event)">
• if<div *if="{{!this.isLoaded}}">Loading...</div>
• foreach<li *foreach="{{this.someArray}}">{{item.value}}</li>
• reference<form #ref="myForm">...</form> will create a property targeting the DOM element
• repeat (optional, faster, with lazy memory release)<li *repeat>

All the directives (excluding custom-code) areoptional - each is a standalone module. Choose the directives you use, or write your own!

You can hook into any slim.js component's lifecycle using plugins. You plugin will be notified for step of the lifecycle, so you can add you own custom code or change things on-the-go.

Well, slim.js is an exception. Your custom code is memoized, and every piece of in-template code is created only once, can be even shared accross components. The core is very small and efficient, and releasing bound nodes is done progressively as background-tasks, keeping the user interface responsive as first priority. Modern browsers supportsrequestIdleCallback, so if supported, the removed elements will be released slowly and progressively.

Yes, and No. It's a very thin, fast, and extensible core library for writing custom-elements, powered by optional plugins and directives. You have the power to decide. It adds the firepower of a framework to your web-components, using the browser's native capabilities — as defined by W3C standards.

• HTML markup with custom inlined code.
• Reactive components: If a property is in the template, it becomes reactive. The core wraps it with a getter and setter function (and keeping your original one intact, if exists). No need to declare, it's derived from the tempalte.
• Data binding: data changes triggers changes in the rendered HTML.
• Directive system: Register your own directives.
• Plugins: Add global lifecycle hooks for every slim.js component.
• It feels like a framework (in a good way), but without the limits of a classic framework. It works everywhere, you can pick your own framework.
• Low-footprint: it's less than 3KB gzipped. Directives are optional.
• Single file for core functionality, and you're good to go.
• No dependencies, everything is based on native browsers' API. Choose your own tools.
• (Optional) Decorators for ES7/Next syntax, via Babel included.
• Works with mixins from other component libraries, such as Polymer, out of the box.

• ES6
• Web Components V1
• No transpiling or compilation required

Use native (or bundlers) import statements, load from the CDN, or use the non-module (commonJS) file.

• Developer's Guide

The official website is built with Slim.js (with source maps). Check out the source code, see it for yourself.

Version 3 introduced the plugins.

Version 4 introduced the es modules.

Version 5 has new engine, directive system and plugin system.

import{Slim}from'slim-js';

<scriptsrc="slim-js/dist/index.legacy.js"></script>

Access a globalSlim object.

<scripttype="module"src="slim-js/dist/index.js"></script>

USE THE PLATFORM