compo-lib

Compo

Compo is a JavaScript Web UI tiny library powering Web Components with a functional API and a Virtual DOM rendering.

You have to compo·se your compo·nents by enriching them with each feature through a central composing function. Markup and Style are considered as a feature you can add to your components.

Installation

npm install compo-lib

yarn add compo-lib

Example

import {
  html,
  css,
  createStore,
  component,
  withProp,
  withStore,
  withStyle,
  withMarkup,
} from 'compo-lib';

createStore((state, action) => {
  switch (action.type) {
    case 'ADD':
      return state + 1;
    case 'SUB':
      return state - 1;
    default:
      return state;
  }
}, 0);

component(
  'my-counter-label',
  withProp('value'),
  withStyle(
    ({ value }) => css`
      :host {
        color: ${value < 1 ? 'red' : 'black'};
      }
    `,
  ),
);

component(
  'my-counter',
  withStore(({ getState, dispatch }) => ({
    counter: getState(),
    add: () => dispatch({ type: 'ADD' }),
    sub: () => dispatch({ type: 'SUB' }),
  })),
  withMarkup(
    ({ counter, add, sub }) => html`
    <div>
      <my-counter-label value=${counter}>${counter}</my-counter-label>
      <button onclick=${add}>+</button>
      <button onclick=${sub}>-</button>
    </div>
  `,
  ),
);

Inspiration

Other frameworks

• React for the v-dom, applying changed by a diff mechanism.
• recompose for the composition API
• styled-components for the CSS as ad integrant part as a component definition
• Redux for the state management
• hyperapp for proving that you can build a complete framework with only a few bytes

Blogs

• https://medium.com/@deathmood/how-to-write-your-own-virtual-dom-ee74acc13060
• http://2ality.com/2014/07/jsx-template-strings.html
• https://gist.github.com/lygaret/a68220defa69174bdec5

Motivations

It started with the exploration of the Web Components and Shadow DOM APIs and followed by the willing to use v-dom concepts in this contexts.

Based upon that foundations, the objective was to have a functional API like recompose to power Web Components.

Minimalism and staying close and bounded to the standards.

Compatibility

Compo is not transpiled to old JavaScript and really based upon Web Components so it only works out of the box on recent Chrome. It works almost on Firefox but still needs a flag to be set.

It's planned to have a compatibility build using polyfills.

Licence

Compo is MIT licensed. See LICENSE.