Skip to content
A functional web component library
JavaScript HTML
Branch: master
Clone or download
Latest commit e8ac7ec Feb 15, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples fix Dec 17, 2016
src adding support for template back in Feb 15, 2017
.gitignore first commit Dec 11, 2016
.npmignore updating Feb 15, 2017
LICENSE
README.md Update README.md Dec 17, 2016
package.json adding support for template back in Feb 15, 2017
sigil.html add html Dec 17, 2016
sigil.min.js adding support for template back in Feb 15, 2017
webpack.config.js

README.md

Sigil.js logo

#Sigil.js Sigil.js is a view framework for the modern web. It features the following in one incredibly minimal package:

  • re-usable html elements using web components
  • virtual dom for super fast re-rendering using snabbadom
  • html templating language that allows bindings to attributes & properties with powerful expressions
  • pure functional view component style to reduce re-renderings
  • support for immutable flux based stores like Redux and Kamea

Installation

Simply reference the Web Component polyfill and Sigil from a CDN:

<script src="https://cdnjs.cloudflare.com/ajax/libs/webcomponentsjs/0.7.23/webcomponents-lite.min.js"></script>
<script src="https://unpkg.com/sigiljs@latest/sigil.min.js"></script>

Get started playing immediately at this jsfiddle

Or if referencing from a web component:

<link rel="import" href="https://unpkg.com/sigiljs@latest/sigil.html">

Hello World

Web Components allow us to create entirely new HTML components reusable anywhere on the web. Each component lives in its own file. Sigil helps us create these components in an easy and performant way. Let's start with something basic.

index.html

<script src="https://cdnjs.cloudflare.com/ajax/libs/webcomponentsjs/0.7.23/webcomponents-lite.min.js"></script>
<link rel="import" href="hello-world.html">
<hello-world></hello-world>

hello-world.html

<link rel="import" href="https://unpkg.com/sigiljs@latest/sigil.html">
<template id="hello-world">
  Hello World
</template>
<script>
  sigil("hello-world")
</script>

Notice the dependencies exist within the web component file itself, allowing your index.html to be nice and clean, and letting your web component express what it needs. Sigil will search for a template element with the same id as it's element name that will be used as the contents of the component.

Just like it takes time for a document to load, it takes a small amount of time for Web Components dependencies to be acquired and our custom elements fully created. We can know when the work is complete with the WebComponentsReady event:

index.html

<script>
  window.addEventListener('WebComponentsReady', function(e) {
    // imports are loaded and elements have been registered
  });
</script>

Attributes & Props

Custom elements are more interesting when bound to data. Sigil.js supports unidirectional binding of its defined properties and attributes. Both attributes and your defined props are reactive, meaning if you change them it will trigger a re-render of the component. Components by default are pure, meaning if you give them the exact same attributes or props no re-render will occur.

<template id="hello-world">
  {{#greeting}} {{:person}}!
</template>
<script>
  sigil("hello-world",["person"]);
</script>

<hello-world greeting="Hola"></hello-world>

<script>
  window.addEventListener('WebComponentsReady', function(e) {
    document.querySelector("hello-world").person = "Richard";
  });
</script>

#Defaults Elements sometimes need a default value for a prop before they've received any external data.

<template id="hello-world">
  {{#greeting}} {{:person}}!
</template>
<script>
  sigil("hello-world",["person"],{
    defaults: {
      person: "Richard"
    }
  });
</script>
<hello-world greeting="Hola"></hello-world>

Methods

Methods can be easily added to your components by passing in additional options. They are usable both externally and internally.

<template id="hello-world">
  Hello {{getPerson()}}!
</template>
<script>
  sigil("hello-world",["person"],{
    methods: {
      getPerson: function(){
        return this.person;
      },
      setPerson: function(person) {
        this.person = person;
      }
    }
  })
</script>

<hello-world></hello-world>
<script>
  document.querySelector("hello-world").setPerson("Richard");
</script>

Lifecycle Hooks

Sigil offers a number of lifecycle hooks:

<template id="hello-world">
  Hello {{:name}}!
</template>
<script>
  sigil("hello-world",["name"],{
    lifecycle: {
      created: function() {
        //called when a new element is created
      },
      inserted: function() {
        //called when element is added to DOM
      },
      removed: function() {
        //called when element is removed from the DOM
      },
      attributeChanged: function(attrName, oldValue, newValue) {
        //called when attribute is changed
      },
      propertyChanged: function(propertyName, oldValue, newValue) {
        //called when defined property is changed
      },
      beforeUpdate: function() {
        //called right before virtual dom update of html
      },
      updated: function() {
        //called right after virtual dom update of html
      },
    }
  })
</script>

HTML Bindings

Sigil.js has only three types of html bindings it can perform.

  • Bindings prefixed with # will bind an expression to an html element's attribute
  • Bindings prefixed with : will bind an expression to an html element's defined property
  • Bindings prefixed with @ will bind an expression to an html element's event. This is discussed below.
<template id="hello-international">
  <hello-world #greeting="getGreeting('chinese')" :person="#name"></hello-world>
  <hello-world #greeting="getGreeting('spanish')" :person="#name"></hello-world>
  <hello-world #greeting="getGreeting('german')" :person="#name"></hello-world>
</template>
<script>
  sigil("hello-international",{
    methods:{
      getGreeting: function(language){
        if(language == "german")
          return "Guten tag";
        else if(language == "spanish")
          return "Hola";
        else if(language == "chinese")
          return "你好";
      }
    }
  });
</script>

<hello-international name="Richard"></hello-international>

Expressions

Sigil utilizes expessions in many areas. These bits of javascript are evaluated in the context of your component. Underneath the covers your expression get translated into real javascript. For example:

<div :foo=" :blah + #test + ' ' + getGreetings()[0]">

get translated to:

this.$evaluateProperty('blah') + this.$evaluateAttribute('test') + ' ' + this.getGreeting()[0]

Event Handling

Event listeners can be created to listen to any dom by creating a property prefixed with @. The event can be accessed using $event but is not required.

<template id="hello-chooser">
  <div @click="chooseGreeting($event)">
    <button>Hello</button>
    <button>Guten tag</button>
    <button>Hola</button>
  </div>
</template>
<script>
  sigil("hello-chooser",{
    methods:{
      chooseGreeting: function(e){
        console.log(e.target.innerHTML);
      }
    }
  });
</script>

Conditionals

Elements can be conditionally rendered based off a boolean expression.

<template id="hello-world">
  <div %if="langauge == 'english'">Hello World!</div>
  <div %if="langauge == 'german'">Hallo Welt</div>
  <div %if="langauge == 'chinese'">你好,世界</div>
</template>
<script>
  sigil("hello-world",["language"]);
</script>

<hello-world></hello-world>
<script>
  window.addEventListener('WebComponentsReady', function(e) {
    document.querySelector("hello-world").language = "chinese";
  });
</script>

Lists

Lists of elements can be rendered out from arrays.

<template id="hello-world">
  <div %for="person in :people'">Hello {{person}}!</div>
</template>
<script>
  sigil("hello-world",["people"]);
</script>
<hello-people></hello-people>
<script>
  window.addEventListener('WebComponentsReady', function(e) {
    document.querySelector("hello-people").people = ["Richard","Howard","Justin"];
  });
</script>

Built-in Functions

A number of built in functions make writing expressions easier to do.

$classNames( ... )

Exposes the utility library classNames as a function so you can write boolean-driven classnames more concisely.

<template id="hello-world">
  <button #class="$classNames('foo',{'big-font':#is-big})">Say Hello</button>
</template>
<script>
  sigil("hello-button")
</script>

<hello-button is-big="true"></hello-button>

$emit( name, data )

A function for emitting custom events from your function.

Parameters

  • name - the name of the custom event
  • data - the data you would like to set as the events detail
<template id="hello-button">
  <button @click="$emit('say-hello','Hello')">Say Hello</button>
</template>
<script>
  sigil("hello-button")
</script>

<hello-button></hello-button>
<script>
  window.addEventListener('WebComponentsReady', function(e) {
    document.querySelector("hello-button").addEventHandler("click",function(e){
      console.log(e.details);
    });
  });
</script>

$action( type, data )

A function for emitting actions as custom events. The action data is stored in detail in the following format:

{
  type: <name>
  data: <data>
}

Parameters

  • type - the type of the action
  • data - the data you would like to attach to the action
<template id="hello-button">
  <button @click="$action('say-hello','Hello')">Say Hello</button>
</template>
<script>
  sigil("hello-button")
</script>

<hello-button></hello-button>
<script>
  window.addEventListener('WebComponentsReady', function(e) {
    document.querySelector("hello-button").addEventHandler("action",function(e){
      var action = e.details;
      var type = action.type;
      var data = action.data;

      if( type === 'say-hello' ){
        console.log(data);
      }    
    });
  });
</script>

Middleware

Some times the default sigil component creator is not enough. You can create your own component creator with default features of your own.

<script>
  var store = new Store();

  var connectedComponent = sigil.use({
    methods: {
      $store: function(){
        return store;
      }
    }
  })
</script>

<template id="hello-world">
  {{$store()}}
</template>
<script>
  connectedComponent("hello-world")
</script>

Performance

Here are some great links for writing performant web applications with Web Components:

You can’t perform that action at this time.