馃幖Compo路sing Web Compo路nents
Branch: master
Clone or download
Swiip Merge pull request #10 from yannbertrand/patch-1
Update Firefox compatibility
Latest commit 63a0cd2 Oct 26, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples router Aug 21, 2018
src
.babelrc
.eslintrc
.gitignore add test coverage task, add tests on component, add tests on with-prop Aug 21, 2018
.travis.yml init travis build Jun 18, 2018
LICENSE.md initial commit Jun 18, 2018
README.md
index.js use explicit imports for direct browser module use Aug 21, 2018
package-lock.json add tests on most enhancers Aug 22, 2018
package.json
router.js router Aug 21, 2018

README.md

Compo

Travis Status

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

yarn add compo

Example

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

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>
  `),
);

API

component( name:String, ...enhancers:Array<(Component => Component)> ):void

Define a Custom Element with named name and enhanced by each enhancers.

  • name is directly passed to customElement.define() so you have to follow Web Components constraints such as a - in the name and only used once in the application.
  • enhancers are function taking in parameter a component class definition and returning a new one, most often my extending it. You can create your own but you can use all the with prefixed enhancers provided in the framework.
component(
  'my-component',
  withProp('my-prop')
);

withMarkup( (props => Markup) ):(Component => Component)

Define an enhancer which will render the Markup returned in the component and will re-render on every change detection.

You'll obtain an Markup object by using the html tagged template described bellow.

component(
  'my-component',
  withMarkup(() => html`<div>Hello World</div>`)
);

withStyle( (props => Style) ):(Component => Component)

Define an enhancer which will add a style block with the Style returned and will update the style on every change detection.

The Style object can be either a standard string or an object using the css tagged template described bellow.

component(
  'my-component',
  withStyle(() => css`:host { color: red; }`)
);

withProp( name ):(Component => Component)

Define an enhancer which will instrument and trigger an update on modification on the component property name.

component(
  'my-component',
  withProp('my-prop')
);

withHandler( name, (props => handler) ):(Component => Component)

Define an enhancer which will add a name property to the component with handler returned to be used in the markup.

component(
  'my-component',
  withHandler(() => event => console.log('my handler', event))
)

withConnected( (props => void) ):(Component => Component)

Define an enhancer which will run the function in parameter when the component is connected corresponding to the Custom Element standard connectedCallback function.

component(
  'my-component',
  withConnected(() => console.log('component connected'))
)

withStore( ((store, props) => object) ):(Component => Component)

Define an enhancer which will run the function in parameter at every store updates and assign all return object properties to the component object.

The store must be created beforehand by using createStore described bellow.

component(
  "my-component",
  withStore(({ getState, dispatch }) => {
    myData: getState().my.data,
    myAction: () => dispatch({ type: "MY_ACTION" })
  })
)

html

ES2015 tagged template allowing to create DOM templates with rich interpolations.

html`
  <my-component my-prop=${prop}>
    ${content}
  </my-component>
`

Known limitation: you currently can't use serveral interpolations in a single DOM node or property.

css

ES2015 tagged template allowing to create CSS content.

To be perfectly honest it does absolutely nothing right now! Still reserving the API can be good and it triggers syntax highlighting in many editors.

css`
  my-component {
    color: red;
  }
`

createStore( ((state, action) => state), initialState ): Store

Initialize the internal store with the reducer in argument.

In contrary to Redux, you don't always need to get the Store returned. It's automatically passed to the withStore enhancer.

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

Router API

withRouteEvent( ( url, props ) => void ):(Component => Component)

Allow the component to have a callback on every url changes.

component(
  'my-component',
  withRouteEvent((url) => console.log('new url', url))
)

withRouteAction( [ handlerName ] = 'go' ):(Component => Component)

Add a handlerName handler in the component which allow to trigger a routing to the url in parameter.

component(
  'my-component',
  withRouteAction('navigate'),
  withHandler(({ navigate }) => (event) => navigate("/my-route")),
)

Component compo-path

Built-in component allowing to insert a component depending on the current path.

  • path: the path which trigger the component.
  • component: the Web Component to use.
<my-container>
  <compo-path path=${"/my-route-1"} component=${"my-component-1"}></compo-path>
  <compo-path path=${"/my-route-2"} component=${"my-component-2"}></compo-path>
</my-container>

Examples

Counter

Most basic example exactly the same as above in this readme.

Try it in CodeSanbox: https://codesandbox.io/s/yv5y14o6pj

2048

Advanced example implementing the popular 2048 game.

Try it in CodeSanbox: https://codesandbox.io/s/k55w33zvkv

2048 compat

Same as 2048 but with polyfill loaded to be tested on other browsers than Chrome

Strangely doesn't work yet on CodeSanbox

Routing

Basic routing example using the integrated router

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

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's also working quite well on Firefox 63.0 without any flag.

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

Licence

Compo is MIT licensed. See LICENSE.