hyperscript-normalize-args v1.0.0

hyperscript-normalize-args

A hyperscript helper to normalize component arguments, for easier creation of reusable components

Why?

We want a flexible API to our users but an easy to use and consistent API internally.

This helper enables your hyperscript component to be called in a lot of ways:

// selector
component('.class#id');
// selector, props
component('.class.class2', {disabled: true});
// selector, props, child/-ren
component('.class', {title: 'Lorem ipsum'}, 'Hello world');
// selector, child/-ren
component('.class', ['Hello', 'world']);
// props, child/-ren
component({checked: true}, otherComponent('Hello world'));
// child/-ren
component([p('Lorem ipsum'), p('Dolor sit')]);

And you can code against a consistent API in your component no matter what!
You'll always get a props object as first argument and a children array as the second argument.

See module usage for examples.

Installation

Install hyperscript-normalize-args using npm:

npm install --save hyperscript-normalize-args

Usage

Module usage

With Cycle.js, virtual-dom or hyperscript

import {button} from '@cycle/dom';
import classNames from 'classnames';
import normalize from 'hyperscript-normalize-args';

const n = normalize(); // no options => DOM mode

// Creating a `myButton` component, which wraps `button` and always add "my-button" as css class
const myButton = n((props, children) => {
	const {
		className,
		...attrs
	} = props;
	return button({...attrs, className: classNames(className, 'my-button')}, children);
});

// myButton can now be used in multiple ways:

myButton('#the-button');
// props = {id: 'the-button'}
// children = []
myButton('#the-button.a-class', {className: 'btn'}, 'Click me');
// props = {id: 'the-button', className: 'a-class btn'}
// children = ['Click me']
myButton('Click me');
// props = {}
// children = ['Click me']

With snabbdom

import h from 'snabbdom/h';
import hh from 'hyperscript-helpers';
import classNames from 'classnames';
import normalize from 'hyperscript-normalize-args';

const {button} = hh(h);
const n = normalize({snabbdom: true}); // snabbdom mode

// Creating a `myButton` component, which wraps `button` and always add "my-button" as css class
const myButton = n((props, children) => {
	const {
		className,
		props: prop,
		...attrs
	} = props;
	return button({...attrs, props: {...prop, className: classNames(className, 'my-button')}}, children);
});

// myButton can now be used in multiple ways:

myButton('#the-button');
// props = {props: {id: 'the-button'}}
// children = []
myButton('#the-button.a-class', {props: {className: 'btn'}}, 'Click me');
// props = {props: {id: 'the-button', className: 'a-class btn'}}
// children = ['Click me']
myButton('Click me');
// props = {}
// children = ['Click me']

With hyperscript-string

import h from 'hyperscript-string';
import hh from 'hyperscript-helpers';
import classNames from 'classnames';
import normalize from 'hyperscript-normalize-args';

const {button} = hh(h);
const n = normalize({dom: false}); // no dom mode, i.e. string mode

// Creating a `myButton` component, which wraps `button` and always add "my-button" as css class
const myButton = n((props, children) => {
	const {
		class: className,
		...attrs
	} = props;
	return button({...attrs, class: classNames(className, 'my-button')}, children);
});

// myButton can now be used in multiple ways:

myButton('#the-button');
// props = {id: 'the-button'}
// children = []
myButton('#the-button.a-class', {class: 'btn'}, 'Click me');
// props = {id: 'the-button', class: 'a-class btn'}
// children = ['Click me']
myButton('Click me');
// props = {}
// children = ['Click me']

Related packages

• hyperscript - Create HyperText with JavaScript, on client or server.
• hyperscript-helpers - Terse syntax for hyperscript
• hyperscript-string - Create HTML strings with JavaScript
• snabbdom - A virtual DOM library with focus on simplicity, modularity, powerful features and performance.
• virtual-dom - A batched diff-based DOM rendering strategy
• @cycle/dom - The standard DOM Driver for Cycle.js, based on virtual-dom, and other helpers

API

normalize([options])

Returns: function, a normalize function. See examples above.

options.dom

Type: Boolean
Default: true

The mode to use with Cycle.js, hyperscript or virtual-dom.

When explicitly set to false it is good to use with hyperscript-string.

options.snabbdom

Type: Boolean
Default: false

The mode to use with snabbdom.

License

MIT © Joakim Carlstein