❤
npm
Sign UpSign In

dendriform
TypeScript icon, indicating that this package has built-in type declarations

3.4.3 • Public • Published

dendriform

npm Master build Maturity: Early Days Coolness Reasonable

Build performant, reactive data-editing UIs for React.js. Succinct code, observable state, undo & redo included!

See the demos

Available on npm

import React, {useCallback} from 'react';
import {useDendriform, useInput} from 'dendriform';

function MyComponent(props) {

    // create a dendriform with initial state
    const form = useDendriform(() => ({
        name: 'Wappy',
        address: {
            street: 'Pump St'
        },
        pets: [
            {name: 'Spike'},
            {name: 'Spoke'}
        ]
    });

    // subscribe to form value changes
    form.useChange((value) => {
        console.log('form changed:', value);
    });

    // make callback to add a pet using .set() and immer drafts
    const addPet = useCallback(() => {
        form.branch('pets').set(draft => {
            draft.push({name: 'new pet'});
        });
    }, []);

    // render the form elements
    // - form.render() and form.renderAll() create optimised child components
    //   that only update when their form value changes.
    // - form.renderAll() automatically adds React keys to each element
    // - useInput() is a React hook that binds a form value to an input
    //   they are safe to use like this because they are always rendered
    //   these each add a 150ms debounce
    
    return <div>
        {form.render('name', nameForm => (
            <label>name <input {...useInput(nameForm, 150)} /></label>
        ))}

        {form.render(['address', 'street'], streetForm => (
            <label>street <input {...useInput(streetForm, 150)} /></label>
        ))}

        <fieldset>
            <legend>pets</legend>
            <ul>
                {form.renderAll('pets', petForm => <li>
                    {petForm.render('name', nameForm => (
                        <label>name <input {...useInput(nameForm, 150)} /></label>
                    ))}
                </li>)}
            </ul>
            <button onClick={addPet}>Add pet</button>
        </fieldset>
    </div>;
};

Demo

What does it do?

Dendriform is kind of like a very advanced useState() hook that:

It's not a traditional "web form" library that has fields, validation and a submit mechanism all ready to go, although you can certainly build that with dendriform (hint: see plugins). If you want a traditional web form for React then formik will likely suit your needs better. Dendriform is less specific and far more adaptable, to be used to make entire UIs where allowing the user to edit data is the goal. You get full control over the behaviour of the interface you create, with many of the common problems already solved, and none of the boilerplate.

In many ways it is similar to something like mobx-keystone, which provides a state tree whose parts are reactive and observable.

Installation

yarn add dendriform
// or
npm install --save dendriform

Usage and API

Plugins

Advanced usage

Creation

Create a new dendriform form using new Dendriform(), or by using the useDendriform() hook if you're inside a React component's render method. Pass it the initial value to put in the form, or a function that returns your initial value.

The useDendriform() hook on its own will never cause a stateful update to the component it's in; the hook just returns an unchanging reference to a Dendriform instance.

import {Dendriform, useDendriform} from 'dendriform';
// ...

const form = new Dendriform({name: 'Bill'});
// ...

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});
    // ...
}

If you're using Typescript you can pass type information in here.

type FormValue = {
    name?: string;
};

const form = new Dendriform<FormValue>({name: 'Bill'});
// ...

function MyComponent(props) {
    const form = useDendriform<FormValue>({name: 'Ben'});
    // ...
}

The value can be of any type, however only plain objects, arrays, ES6 classes and ES6 maps will be able to use branching to access and modify child values.

Values

Access your form's value using .value, or by using the .useValue() hook if you're inside a React component's render method. The .useValue() hook will cause a component to update whenever the value changes. Using the hook essentially allows your components to "opt in" to respond to specific value changes, which means that unnecessary component updates can be easily avoided, and is a large part of what makes Dendriform so performant.

const form = new Dendriform({name: 'Bill'});
const value = form.value;
// value is {name: 'Bill'}
// ...

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});
    const value = form.useValue();
    // value is {name: 'Ben'}
    // ...
}

You can instantiate forms outside of React, and access them and change them inside React components - they work in just the same way.

The only difference is that the lifespan of forms instantiated inside React components will be tied to the lifespan of the component instances they appear in.

const persistentForm = new Dendriform({name: 'Bill'});

function MyComponent(props) {
    const value = persistentForm.useValue();
    // value is {name: 'Bill'}
    // ...
}

Accessing values in callbacks is very easy compared to using vanilla React hooks; simply call form.value in your callback. As form is an unchanging reference to a form, you do not have to add extra dependencies to your useCallback() hook, and form.value will always return the current value, not a stale one.

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});

    const handleNameAlert = useCallback(() => {
        alert(form.value);
    }, []);

    return <button onClick={handleNameAlert}>
        Alert my name
    </button>;
}

Branching

Use .branch() to deeply access parts of your form's value. This returns another form, containing just the deep value.

const form = new Dendriform({name: 'Bill'});

const nameForm = form.branch('name');
const value = nameForm.value;
// value is 'Bill'
// ...

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});

    const nameForm = form.branch('name');
    const value = nameForm.useValue();
    // value is 'Ben'
    // ...
}

Demo

You can check if a form is branchable using .branchable. On a form containing a non-branchable value such as a string, number, undefined or null it will return false, or if the form is branchable it will return true.

new Dendriform(123).branchable; // returns false
new Dendriform({name: 'Bill'}).branchable; // returns true

You can still call .branch() on non-branchable forms - the returned form will be read-only and contain a value of undefined. While this may seem overly loose, it is to prevent the proliferation of safe-guarding code in userland, and is useful for situations where React components that render branched forms are still briefly mounted after a parent values changes from a branchable type to a non-branchable type.

Branching multiple children

The .branchAll() methods can be used to branch all children at once, returning an array of branched forms.

const form = new Dendriform(['a','b','c']);

const elementForms = form.branchAll();
// elementForms.length is 3
// elementForms[0].value is 'a'

You can still call .branchAll() on non-branchable or non-iterable forms - it will return an empty array in this case.

Rendering

The .render() function allows you to branch off and render a deep value in a React component.

The .render() function's callback is rendered as its own component instance, so you are allowed to use hooks in it. It's optimised for performance and by default it only ever updates if a form value is being accessed with a .useValue() hook and the deep value changes; or it contains some changing state of its own. This keeps component updates to a minimum.

This act of 'opting-in' to reacting to data changes is similar to mobx, and is in contrast to React's default behaviour which is to make the developer 'opt-out' of component updates by using React.memo.

Sometimes using useState() you might need to raise the useState() hook further up the component heirarchy so that something higher up can set state. But this can then cause much larger parts of the React component heirarchy to be updated in response to those state changes, depending on how much use of React.memo you have.

With Dendriform, your state can be moved as high up the component heirarchy as you need, or even outside the component heirarchy, without accidentally causing larger parts of the React component heirarchy to update. And unlike redux, you don't have to also put your state into a centralised data store if it doesn't belong there.

function MyComponent(props) {
    // this component will never need to update, because 'form'
    // is an unchanging reference to a dendriform instance

    const form = useDendriform({name: 'Ben'});

    return <div>
        {form.render('name', nameForm => {
            // this component will update whenever 'name' changes,
            // and only because the useValue() hook is used.
            // the useValue() hook tells this component
            // to opt-in to 'name' changes

            const name = nameForm.useValue();
            return <div>My name is {name}</div>;
        })}
    </div>;
}

Demo

The .render() function can also be called without branching.

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});

    return <div>
        {form.render(form => {
            // the 'form' passed into this component is the same
            // as the 'form' belonging to the parent component

            const user = form.useValue();
            return <div>My name is {user.name}</div>;
        })}
    </div>;
}

The form passed into the render() callback is provided just for convenience of writing less code while branching and rendering. The following examples are equivalent. You can use whichever suits:

form.render('name', nameForm => {
    const name = nameForm.useValue();
    return <div>My name is {name}</div>;
});

form.render(form => {
    const name = form.branch('name').useValue();
    return <div>My name is {name}</div>;
});

form.render('name', nameForm => <div>My name is {nameForm.useValue()}</div>);

form.render(() => {
    const name = form.branch('name').useValue();

    // ^ this is essentially the same as example 2.
    // the 'form' being accessed is the form in the parent component
    // which is fine do to because forms are always
    // unchanging references that never go stale

    return <div>My name is {name}</div>;
});

As such, you can access updates to multiple forms in a single render() component.

function MyComponent(props) {
    const tableSize = useDendriform({
        height: 100,
        width: 200,
        depth: 300
    });

    return <div>
        {tableSize.render(tableSize => {
            const width = tableSize.branch('width').useValue();
            const depth = tableSize.branch('depth').useValue();
            return <div>
                table top area: {width * depth}
            </div>;
        })}
    </div>;
}

As the callback of .render() doesn't update in response to changes in the parent's props by default, you may sometimes need to force it to update using the last argument dependencies.

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});
    const [className] = useState('darkMode');

    return <div>
        {form.render('name', nameForm => {
            const name = nameForm.useValue();
            return <div className={className}>My name is {name}</div>;
        }, [className])}
    </div>;
}

Demo

You can still call .render() on non-branchable forms - the returned form will be read-only and contain a value of undefined. While this may seem overly loose, it is to prevent the proliferation of safe-guarding code in userland, and is useful for situations where React components that render branched forms are still briefly mounted after a parent values changes from a branchable type to a non-branchable type.

Rendering arrays and multiple children

The .renderAll() function works in the same way as .render(), but repeats for all elements in an array. React keying is taken care of for you.

See Array operations for convenient ways to let the user manipulate arrays of items.

function MyComponent(props) {
    const form = useDendriform({
        colours: [
            {colour: 'Red'},
            {colour: 'Green'},
            {colour: 'Blue'}
        ]
    });

    return <div>
        {form.renderAll('colours', colourForm => {
            const colour = colourForm.branch('colour').useValue();
            return <div>Colour: {colour}</div>;
        })}
    </div>;
}

Please note that if you are rendering an array that contains any primitive values (undefined, number, string) then the automatic keying will not be able to be as accurate as if you were to render an array of objects / arrays / class instances / sets / maps. This is because object references are used to track the movement of array elements through time, and primitive elements cannot be tracked in this way.

Array element forms can also opt-in to updates regarding their indexes using the .useIndex() hook.

If you'll be allowing users to re-order items in an array, then please note that you'll get better performance if array element components don't know about their indexes. If the .useIndex() hook is used, a element that has moved its position inside of its parent array will need to update, even if it is otherwise unchanged.

The .index property is available for usages outside of React.

function MyComponent(props) {
    const form = useDendriform({
        colours: ['Red', 'Green', 'Blue']
    });

    return <div>
        {form.renderAll('colours', colourForm => {
            const colour = colourForm.useValue();
            const index = colourForm.useIndex();

            return <div>Colour: {colour}, index: {index}</div>;
        })}
    </div>;
}

Branch and render functions can all accept arrays of properties to dive deeply into data structures.

const form = new Dendriform({
    pets: [
        {name: 'Spike'}
    ]
});

const petName = form.branch(['pets', 0, 'name']);
// petName.value is 'Spike'

Like with .render(), the .renderAll() function can also additionally accept an array of dependencies that will cause it to update in response to prop changes.

You can still call .renderAll() on non-branchable or non-iterable forms - it will return an empty array in this case.

Setting data

You can set data directly using .set(). This accepts the new value for the form. When called, changes will immediately be applied to the data in the form and any relevant .useValue() hooks and .render() methods will be scheduled to update by React.

const form = new Dendriform('Foo');
form.set('Bar');
// form.value will update to become 'Bar'

The usage is the same in a React component

function MyComponent(props) {
    const form = useDendriform('Foo');

    const name = form.useValue(); 

    const setToBar = useCallback(() => form.set('Bar'), []);

    return <div>
        Current name: {name}

        <button onClick={setToBar}>Set to Bar</button>
    </div>;
}

Demo

When .set() is called on a deep form, the deep value will be updated immutably within its parent data shape. It uses structural sharing, so other parts of the data shape that haven't changed will not be affected.

function MyComponent(props) {
    const form = useDendriform({name: 'Ben', age: 30});

    return <div>
        {form.render('name', nameForm => {
            const name = nameForm.useValue();
            const setToBill = useCallback(() => {
                nameForm.set('Bill');
            }, []);

            return <div>
                My name is {name}
                <button onClick={setToBill}>Set to Bill</button>
            </div>;
        })}
    </div>;

    // clicking 'Set to Bill' will cause the form to update
    // and form.value will become {name: 'Bill', age: 30}
}

The .set() function can also accept an Immer producer.

function MyComponent(props) {
    const form = useDendriform({count: 0});

    const countUp = useCallback(() => {
        form.set(draft => {
            draft.count++;
        });
    }, []);

    return <div>
        {form.render('count', countForm => {
            const count = countForm.useValue();
            return <div>Count: {count}</div>;
        })}

        <button onClick={countUp}>Count up</button>
    </div>;
}

The .set() function can also accept an options object as the second argument which can affect how the set is executed.

options.debounce

The .set() action can be debounced by passing a number of milliseconds.

function MyComponent(props) {
    const form = useDendriform(0);

    const countUpDebounced = useCallback(() => {
        form.set(count => count + 1, {debounce: 100});
    }, []);

    return <div>
        {form.render(form => {
            const count = form.useValue();
            return <div>Count: {count}</div>;
        })}

        <button onClick={countUpDebounced}>Count up</button>
    </div>;
}

Buffering

To call it multiple times in a row, use buffer() to begin buffering changes and done() to apply the changes. These will affect the entire form including all branches, so form.buffer() has the same effect as form.branch('example').buffer().

const form = new Dendriform(0);
form.buffer();
form.set(draft => draft + 1);
form.set(draft => draft + 1);
form.set(draft => draft + 1);
form.done();
// form.value will update to become 3

Read-only forms

You may want to allow subscribers to a form, while also preventing them from making any changes. For this use case the readonly() method returns a version of the form that cannot be set and cannot navigate history. Calls to set(), setParent(), undo(), redo() and go() will throw an error. Any forms branched off a readonly form will also be read-only.

const form = new Dendriform(0);
const readonlyForm = form.readonly();

// readonlyForm can have its .value and .useValue read
// can subscribe to changes with .onChange() etc. and can render,
// but calling .set(), .go() or any derivatives
// will cause an error to be thrown

readonlyForm.set(1); // throws error

Updating from props

The useDendriform hook can automatically update when props change. If a dependencies array is passed as an option, the dependencies are checked using Object.is() equality to determine if the form should update. If an update is required, the value function is called again and the form is set to the result.

Do not add any values from other dendriform forms as a dependency in this manner. Instead use onDerive and derive one form's changes into the other.

function MyComponent(props) {
    const {nameFromProps} = props;

    const form = useDendriform(
        () => ({
            name: nameFromProps
        }),
        {
            dependencies: [nameFromProps]
        }
    );

    return <div>
        {form.render('name', nameForm => {
            const name = nameForm.useValue();
            return <div>Name: {name}</div>;
        })}
    </div>;
}

Demo

If history is also used at the same time, changes in props will replace the current history item rather than create a new one, however is it unlikely that both history and changes in props are required in the same form because history indicates that the form is intended to be the master of its own state, and dependencies indicate that the form is intended to be a slave to props.

For more fine grained control, you may write your own code to handle changes based on props.

function MyComponent(props) {
    const {nameFromProps} = props;

    const form = useDendriform({name: nameFromProps});

    const lastNameFromProps = useRef(nameFromProps);
    if(!Object.is(lastNameFromProps, nameFromProps)) {
        form.set({name: nameFromProps});
    }
    lastNameFromProps.current = nameFromProps;

    return <div>
        {form.render('name', nameForm => {
            const name = nameForm.useValue();
            return <div>Name: {name}</div>;
        })}
    </div>;
}

ES6 classes

ES6 classes can be stored in a form and its properties can be accessed using branch methods.

class Person {
    firstName = '';
    lastName = '';
}

const person = new Person();
person.firstName = 'Billy';
person.lastName = 'Thump';

const form = new Dendriform(person);

// form.branch('firstName').value will be 'Billy'

But by default you will not be able to modify this value.

const form = new Dendriform(person);
form.branch('firstName').set('Janet');
// ^ throws an error

To modify a class property, your class must have the immerable property on it as immer's documentation describes.

You should import immerable from dendriform so you are guaranteed to get the immerable symbol from the version of immer that dendriform uses.

import {immerable} from 'dendriform';

class Person {
    firstName = '';
    lastName = '';
    [immerable] = true; // makes the class immerable
}

const person = new Person();
person.firstName = 'Billy';
person.lastName = 'Thump';

const form = new Dendriform(person);
form.branch('firstName').set('Janet');

Demo

ES6 maps

ES6 maps can be stored in a form and its properties can be accessed using branch methods.

const usersById = new Map();
usersById.set(123, 'Harry');
usersById.set(456, 'Larry');

const form = new Dendriform(usersById);

// form.branch(123).value will be 'Harry'

But by default you will not be able to modify this value.

const form = new Dendriform(usersById);
form.branch(456).set('Janet');
// ^ throws an error

To modify a Maps value, support must be explicitly enabled by calling enableMapSet() as immer's documentation describes.

import {enableMapSet} from 'immer';

enableMapSet();

const usersById = new Map();
usersById.set(123, 'Harry');
usersById.set(456, 'Larry');

const form = new Dendriform(usersById);
form.branch(456).set('Janet');

Demo

ES6 sets

ES6 sets can be stored in a form and its properties can be accessed using branch methods.

const form = new Dendriform(new Set([1,2,3]));

// form.branch(1).value will be 1
// form.branch(3).value will be 3

You can only modify a set's value from the parent form, not from a branched form.

You must also explicitly enabled ES6 Set support by calling enableMapSet() as immer's documentation describes.

import {enableMapSet} from 'immer';

enableMapSet();

const form = new Dendriform(new Set([1,2,3]));

// works
form.set(draft => {
    draft.add(4);
});

Form inputs

You can easily bind parts of your data to form inputs using useInput() and useCheckbox(). The props they return can be spread onto form elements. A debounce value (milliseconds) can also be provided to useInput() to prevent too many updates happening in a short space of time.

Internally these function use React hooks, so also must follow React's rules of hooks.

import {useDendriform, useInput, useCheckbox} from 'dendriform';

function MyComponent(props) {

    const form = useDendriform(() => ({
        name: 'Bill',
        fruit: 'grapefruit',
        canSwim: true,
        comment: ''
    }));

    return <div>
        {form.render('name', nameForm => (
            <label>name: <input {...useInput(nameForm, 150)} /></label>
        ))}

        {form.render('fruit', fruitForm => (
            <label>
                select:
                <select {...useInput(fruitForm)}>
                    <option value="grapefruit">Grapefruit</option>
                    <option value="lime">Lime</option>
                    <option value="coconut">Coconut</option>
                    <option value="mango">Mango</option>
                </select>
            </label>
        ))}

        {form.render('canSwim', canSwimForm => (
            <label>
                can you swim?
                <input type="checkbox" {...useCheckbox(canSwimForm)} />
            </label>
        ))}

        {form.render('comment', commentForm => (
            <label>comment: <textarea {...useInput(commentForm)} /></label>
        ))}
    </div>;
};

Demo

You may also have form input components of your own whose onChange functions are called with the new value rather than a change event. The useProps hook can be spread onto these elements in a similar way to the useInput hook. These also support debouncing.

import {useDendriform, useProps} from 'dendriform';

function MyComponent(props) {

    const form = useDendriform([]);

    return <MySelectComponent {...useProps(form)} />;
};

This is equivalent to doing the following:

return <MySelectComponent 
    value={form.value}
    onChange={value => form.set(value)}
/>;

Subscribing to changes

You can subscribe to changes using .onChange, or by using the .useChange() hook if you're inside a React component's render method.

The .onChange() method returns an unsubscribe function you can call to stop listening to changes. The .useChange() hook automatically unsubscribes when the component unmounts, so it returns nothing.

const form = new Dendriform({name: 'Bill'});

const unsubscribe = form.onChange(newValue => {
    console.log('form value was updated:', newValue);
});

// call unsubscribe() to unsubscribe

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'});

    form.useChange(newValue => {
        console.log('form value was updated:', newValue);
    });

    // ...
}

Demo

As these functions can be called on any form instance, including branched form instances, you can selectively and independently listen to changes in parts of a form's data shape.

function MyComponent(props) {

    const form = useDendriform(() => ({
        firstName: 'Bill',
        lastName: 'Joe'
    }));

    useEffect(() => {
        const unsub1 = form
            .branch('firstName')
            .onChange(newName => {
                console.log('first name changed:', newName);
            });

        const unsub2 = form
            .branch('lastName')
            .onChange(newName => {
                console.log('last name changed:', newName);
            });

        return () => {
            unsub1();
            unsub2();
        };
    }, []);

    return <div>
        {form.render('firstName', firstNameForm => (
            <label>first name: <input {...useInput(firstNameForm, 150)} /></label>
        ))}

        {form.render('lastName', lastNameForm => (
            <label>last name: <input {...useInput(lastNameForm, 150)} /></label>
        ))}
    </div>;
};

Alternatively you can use the .useChange() React hook.

function MyComponent(props) {
    const form = useDendriform(() => ({
        firstName: 'Bill',
        lastName: 'Joe'
    }));

    form.branch('firstName').useChange(newName => {
        console.log('Subscribing to changes - first name changed:', newName);
    });

    form.branch('lastName').useChange(newName => {
        console.log('Subscribing to changes - last name changed:', newName);
    });

    return <div>
        {form.render('firstName', firstNameForm => (
            <label>first name: <input {...useInput(firstNameForm, 150)} /></label>
        ))}

        {form.render('lastName', lastNameForm => (
            <label>last name: <input {...useInput(lastNameForm, 150)} /></label>
        ))}
    </div>;
}

Callbacks passed into .onChange() are passed a second parameter, an object containing details of the change that took place.

.onChange((newName, details) => {
    ...
});

The detail object contains:

  • patches: HistoryItem - The dendriform patches and inverse patches describing this change.
    • Nodes are an internal object that keeps track of the existence of parts of the data shape.
  • prev.value - The previous value.
  • next.value - The new value.
  • go: number - if undo(), redo() or go() triggered this change, this will be the change to the history index. Otherwise (for example when a call to .set() triggered the change) it will be 0.
  • replace: boolean - a boolean stating whether this change was called with replace.
  • force: boolean - a boolean stating whether this change was called with force.
  • id: string - The id of the form that this change is occuring at.

onChange vs onDerive

The onChange and onDerive functions may initially appear to be very similar, but they have a few key differences.

  • onDerive is called once at initial call and every change afterward; onChange is called only at every change afterward.
  • onDerive is called during a change, so the data that it is called with may not be the same as the data after the change is complete; onChange is called after a change and all deriving is complete, so it only ever receives the "final" data.
  • onDerive may call functions that cause more derivations - any further changes triggered as a result of calling onDerive are included in the same history item and can be undone with a single call to undo(); onChange may also call other functions, but any subsequent would become a new history item.

If you always need one form to contain data corresponding to another form's data, use onDerive. If you want to fire side effects whenever a change has completed successfully, use onChange.

Array operations

Common array operations can be performed using array.

import {array} from 'dendriform';

const offsetElement = (form, offset) => {
    return form.setParent(index => array.move(index, index + offset));
};

function MyComponent(props) {

    const form = useDendriform({
        colours: ['Red', 'Green', 'Blue']
    });

    const coloursForm = form.branch('colours');
    const shift = useCallback(() => coloursForm.set(array.shift()), []);
    const pop = useCallback(() => coloursForm.set(array.pop()), []);
    const unshift = useCallback(() => coloursForm.set(array.unshift('Puce')), []);
    const push = useCallback(() => coloursForm.set(array.push('Puce')), []);
    const move = useCallback(() => coloursForm.set(array.move(-1,0)), []);

    return <div>
        {form.renderAll('colours', colourForm => {

            const remove = useCallback(() => colourForm.set(array.remove()), []);
            const moveDown = useCallback(() => offsetElement(colourForm, 1), []);
            const moveUp = useCallback(() => offsetElement(colourForm, -1), []);

            return <div>
                <label>colour: <input {...useInput(colourForm, 150)} /></label>

                <button onClick={remove}>remove</button>
                <button onClick={moveDown}>down</button>
                <button onClick={moveUp}>up</button>
            </div>;
        })}

        <button onClick={shift}>shift</button>
        <button onClick={pop}>pop</button>
        <button onClick={unshift}>unshift</button>
        <button onClick={push}>push</button>
        <button onClick={move}>move last to first</button>
    </div>;
}

Demo

History

Dendriform can keep track of the history of changes and supports undo and redo. Activate this by specifying the maximum number of undos you would like to allow in the options object when creating a form.

History items consist of immer patches that have been optimised, so they take up very little memory in comparison to full state snapshots.

const form = new Dendriform({name: 'Bill'}, {history: 50});
// ...

function MyComponent(props) {
    const form = useDendriform({name: 'Ben'}, {history: 50});
    // ...
}

History can be navigated by calling .undo() and .redo() on any form. It does not matter if you are calling these on the top level form or any branched form, the effect will be the same.

function MyComponent(props) {

    const form = useDendriform(() => ({name: 'Ben'}), {history: 100});

    return <div>
        {form.render('name', nameForm => (
            <label>name: <input {...useInput(nameForm, 150)} /></label>
        ))}

        {form.render(form => {
            const {canUndo, canRedo} = form.useHistory();
            // this function will only re-render if canUndo or canRedo changes
            return <>
                <button onClick={form.undo} disabled={!canUndo}>Undo</button>
                <button onClick={form.redo} disabled={!canRedo}>Redo</button>
            </>;
        })}
    </div>;
}

Demo

The .go() function can also be used to perform undo and redo operations.

form.go(-1); // equivalent to form.undo()
form.go(1); // equivalent to form.redo()
form.go(-3); // equivalent to form.undo() called 3 times in a row
form.go(0); // does nothing

You can find if the form is able to undo or redo using .history, or by using the .useHistory() hook if you're inside a React component's render method. These both return an object {canUndo: boolean, canRedo: boolean}. This can be used to disable undo and redo buttons.

function MyComponent(props) {

    const form = useDendriform(() => ({name: 'Ben'}), {history: 100});

    return <div>
        {form.render('name', nameForm => (
            <label>name: <input {...useInput(nameForm, 150)} /></label>
        ))}

        {form.render(form => {
            const {canUndo, canRedo} = form.useHistory();
            // this function will only re-render if canUndo or canRedo changes
            return <>
                <button onClick={form.undo} disable={!canUndo}>Undo</button>
                <button onClick={form.redo} disable={!canRedo}>Redo</button>
            </>;
        })}
    </div>;
};

You can also control how changes are grouped in the history stack.

The .replace() function can be used to prevent a new history item being created for the next .set().

const form = new Dendriform('a', {history: 50});

form.set('b');
// form will contain 'b' as a new history item
// if undo() is called, form will contain 'a' again

// ...after some time...

form.replace();
form.set('c');
// form will contain 'c' by updating the current history item
// if undo() is called, form will contain 'a' again

The .replace() function can also take a boolean for convenience.

form.replace(true);
// equivalent to form.replace();

form.replace(false);
// equivalent to not calling form.replace() at all

Buffering multiple changes also works with .replace().

const form = new Dendriform(1, {history: 50});

form.set(2);
// form will contain 2 as a new history item
// if undo() is called, form will contain 1 again

// ...after some time...

form.replace();
form.buffer();
form.set(num => num + 1);
form.set(num => num + 1);
form.done();

// form will contain 4 by updating the current history item
// if undo() is called, form will contain 1 again

The .buffer() function can also be called again while buffering to add subsequent changes to a new history item. The changes still will not be applied until .done() is called.

const form = new Dendriform('a', {history: 50});

// calling .set() multiple times in the same update
form.buffer();
form.set('b');
form.set('c');
form.done();

// form will contain 'c'
// if undo is called, form will contain 'a' again

// calling .set() multiple times in the same update
form.buffer();
form.set('b');
form.buffer();
form.set('c');
form.done();

// form will contain 'c'
// if undo is called, form will contain 'b'
// if undo is called a second time, form will contain 'a'

Demo

Drag and drop

Drag and drop can be implemented easily with libraries such as react-beautiful-dnd, because dendriform takes care of the unique keying of array elements for you.

import {DragDropContext, Droppable, Draggable} from 'react-beautiful-dnd';

const dndReorder = (result) => (draft) => {
    if(!result.destination) return;

    const startIndex = result.source.index;
    const endIndex = result.destination.index;
    if(endIndex === startIndex) return;

    const [removed] = draft.splice(startIndex, 1);
    draft.splice(endIndex, 0, removed);
};

function DragAndDrop() {

    const form = useDendriform({
        colours: [
            {colour: 'Red'},
            {colour: 'Green'},
            {colour: 'Blue'}
        ]
    });

    const onDragEnd = useCallback(result => {
        form.branch('colours').set(dndReorder(result));
    }, []);

    const onAdd = useCallback(() => {
        form.branch('colours').set(array.push('Puce'));
    }, []);

    return <div>
        <DragDropContext onDragEnd={onDragEnd}>
            <Droppable droppableId="list">
                {provided => (
                    <div ref={provided.innerRef} {...provided.droppableProps}>
                        <DragAndDropList form={form.branch('colours')} />
                        {provided.placeholder}
                    </div>
                )}
            </Droppable>
        </DragDropContext>

        <button onClick={push}>add new</button>
    </div>;
}

function DragAndDropList(props) {
    return props.form.renderAll(eachForm => {

        const id = \`$\{eachForm.id}\`;
        const index = eachForm.useIndex();
        const remove = useCallback(() => eachForm.set(array.remove()), []);

        return <Draggable key={id} draggableId={id} index={index}>
            {provided => <div
                ref={provided.innerRef}
                {...provided.draggableProps}
                {...provided.dragHandleProps}
            >
                <label>colour: <input {...useInput(eachForm.branch('colour'), 150)} /></label>
                <button onClick={remove}>remove</button>
            </div>}
        </Draggable>;
    });
}

Demo

Plugins

Dendriform has a plugin system that allows modular resuable functionality to be applied to forms, such as adding a submit action to a form.

Plugin instances become available on all branched forms under form.plugins. Some plugin methods can return data relevant to the branched form that the plugin is called from.

const plugins = {
    foo: new MyPlugin()
};

const form = new Dendriform({bar: 123}, {plugins});
// form.plugins.foo is the MyPlugin instance
// form.branch('foo').plugins.foo is also the MyPlugin instance

If you are passing plugins to the useDendriform hook, plugins must be a function that returns a plugins object.

function MyComponent() {
    const plugins = () => ({
        foo: new MyPlugin()
    });

    const form = useDendriform({bar: 123}, {plugins});
    // ...
}

PluginSubmit

Adds a submit action to a form. The onSubmit callback will be called when a form is submitted. If any errors occur as a result of calling onSubmit, the form will roll back and allow it to be submitted again.

The onSubmit function passes the same details object as onChange does, so it's possible to use diff() with this to find what has changed between submissions. Please note that as of v2.2.0 using diff in onSubmit works with all data types except for diffing arrays.

import {PluginSubmit} from 'dendriform';

type SubmitValue = {
    firstName: string;
    lastName: string;
};

type SubmitPlugins = {
    submit: PluginSubmit<SubmitValue,string>;
};

const plugin: SubmitPlugins = {
    submit: new PluginSubmit<SubmitValue,SubmitPlugins>({
        onSubmit: async (newValue: SubmitValue, details): void => {
            // trigger save action here
            // any errors will be eligible for resubmission
            // diff(details) can be used in here to diff changes since last submit
        },
        onError: (error: any): string|undefined => {
            // optional function, will be called if an error occurs in onSubmit
            // anything returned will be stored in state in form.plugins.submit.error
            // the error state is cleared on next submit
        }
    })
};

const form = new Dendriform(value, {plugins});

// form plugin can be found form.plugins.submit
// form can be submitted by calling:
form.plugins.submit.submit();

// get whether the form has changed value i.e. is dirty
form.plugins.submit.dirty.value;
form.plugins.submit.dirty.useValue();

// get whether the form has changed value at a path
form.branch('foo').plugins.submit.dirty;

PluginSubmit has the following properties and methods.

  • submit(): void - submits the form if there are changes, calling onSubmit. If the value of the form has not changed then this has no effect.
  • previous: Dendriform<V> - a dendriform containing the inital value / the value of the previous submit at the current branch.
  • submitting: Dendriform<boolean> - a dendriform containing a boolean stating if the plugin is currently waiting for an async onSubmit call to complete.
  • submitting: Dendriform<E|undefined> - a dendriform containing the most recent result of onError. This is changed to undefined on submit.
  • dirty.value: boolean - a boolean indicating if the value at the current branch is dirty i.e. has changed.
  • dirty.useValue(): boolean - a React hook returning a boolean indicating if the value at the current branch is dirty i.e. has changed.

Advanced usage

Diffing changes

Dendriform can produce diffs of changes in .onChange and .onDerive callbacks. It does this shallowly, only looking at how the child values / elements of the newValue has changed.

import {diff} from 'dendriform';

const form = new Dendriform({
    a: 1,
    b: 2,
    c: 3
});

form.onChange((newValue, details) => {
    const [added, removed, updated] = diff(details);
    
    // - added will be an array of {key: string, value: number} objects
    //   that have been added by the change
    // - removed will be an array of {key: string, value: number} objects
    //   that have been removed by the change
    // - updated will be an array of {key: string, value: number} objects
    //   that have been updated by the change
});

// if form was to be set to the following

form.set({
    b: 2,
    c: 33,
    d: 44
});

// then diff() will return
// added: [{key: 'd', value: 44}]
// removed: [{key: 'a', value: 1}]
// updated: [{key: 'c', value: 33}]

Deriving data

When a change occurs, you can derive additional data in your form using .onDerive, or by using the .useDerive() hook if you're inside a React component's render method. Each derive function is called once immediately, and then once per change after that. When a change occurs, all derive callbacks are called in the order they were attached, after which .onChange(), .useChange() and .useValue() are updated with the final value.

The .onDerive() method returns an unsubscribe function you can call to stop deriving. The .useDerive() hook automatically unsubscribes when the component unmounts, so it returns nothing.

const form = new Dendriform({
    a: 1,
    b: 2,
    sum: 0
});

const unsubscribe = form.onDerive(newValue => {
    form.branch('sum').set(newValue.a + newValue.b);
});

// now form.value is {a:1, b:2, sum:3}

// call unsubscribe() to unsubscribe
function MyComponent(props) {
    const form = useDendriform({a: 1, b: 2, sum: 0});

    form.useDerive(newValue => {
        form.branch('sum').set(newValue.a + newValue.b);
    });

    // if form.branch('a').set(2); is called
    // the deriver function will be called
    // and form.value will contain {a:2, b:2, sum:4}
}

Demo

It is also possible and often preferrable to make changes in other forms in .onDerive()'s callback.

Here we can see that deriving data can be useful for implementing validation.

const form = new Dendriform({name: 'Bill'});
const validState = new Dendriform({
    nameError: '',
    valid: true
});

form.onDerive(newValue => {
    const valid = newValue.name.trim().length > 0;
    const nameError = valid ? '' : 'Name must not be blank';
    validState.branch('valid').set(valid);
    validState.branch('nameError').set(nameError);
});

Demo

Callbacks passed into .onDerive() are passed a second parameter, an object containing details of the change that took place.

.onDerive((newName, details) => {
    ...
});

The detail object contains:

  • patches: HistoryItem - The dendriform patches and inverse patches describing this change.
    • Nodes are an internal object that keeps track of the existence of parts of the data shape.
  • prev.value - The previous value.
  • next.value - The new value.
  • go: number - if undo(), redo() or go() triggered this change, this will be the change to the history index. Otherwise (for example when a call to .set() triggered the change) it will be 0.
  • replace: boolean - a boolean stating whether this change was called with replace.
  • force: boolean - a boolean stating whether this change was called with force.
  • id: string - The id of the form that this derive is occuring at.

onChange vs onDerive

The onChange and onDerive functions may initially appear to be very similar, but they have a few key differences.

  • onDerive is called once at initial call and every change afterward; onChange is called only at every change afterward.
  • onDerive is called during a change, so the data that it is called with may not be the same as the data after the change is complete; onChange is called after a change and all deriving is complete, so it only ever receives the "final" data.
  • onDerive may call functions that cause more derivations - any further changes triggered as a result of calling onDerive are included in the same history item and can be undone with a single call to undo(); onChange may also call other functions, but any subsequent would become a new history item.

If you always need one form to contain data corresponding to another form's data, use onDerive. If you want to fire side effects whenever a change has completed successfully, use onChange.

Two-way deriving

You can also derive in both directions. Here a numberForm and a stringForm are created, and changes to one are derived into the other without causing an infinite loop.

const numberForm = new Dendriform(10);
const stringForm = new Dendriform('');

// add first deriver
numberForm.onDerive(value => {
    stringForm.set(`${value}`);
});

// at this point stringForm.value is now '10'

// add second deriver
stringForm.onDerive(({val}) => {
    numberForm.set(Number(val));
});

// now set number, string will derive
numberForm.set(20);
// numberForm.value === 20
// stringForm.value === '20'

// now set string, number will derive
stringForm.set('30');
// numberForm.value === 30
// stringForm.value === '30'

Demo

Synchronising form history

You can use any number of forms to store your editable state so you can keep related data grouped logically together. However you might also want several separate forms to move through history together, so calling .undo() on one will also undo the changes that have occurred in multiple forms. The syncHistory utility can do this.

Synchronised forms must have the same maximum number of history items configured, and syncHistory must be called before any of the affected forms have any changes made to them.

import {syncHistory} from 'dendriform';

const nameForm = new Dendriform({name: 'Bill'}, {history: 100});
const addressForm = new Dendriform({street: 'Cool St'}, {history: 100});

syncHistory(nameForm, addressForm);

// if nameForm.undo() is called, addressForm.undo() is also called, and vice versa
// if nameForm.redo() is called, addressForm.redo() is also called, and vice versa
// if nameForm.go() is called, addressForm.go() is also called, and vice versa

Multiple forms can be synced together through multiple calls fo syncHistory, so it's possible to append forms to a groups of already-synchronised forms.

import {syncHistory} from 'dendriform';

const nameForm = new Dendriform('Noof', {history: 100});
const addressForm = new Dendriform('12 Foo St', {history: 100});
const suburbForm = new Dendriform('Suburbtown', {history: 100});

syncHistory(nameForm, addressForm, suburbForm);

// later, but before any changes are made to any affected forms, other forms can be synchronised

const colourForm = new Dendriform('Blue', {history: 100});

syncHistory(suburbForm, colourForm);

// now nameForm, addressForm, suburbForm and colourForm will be synchronised through history

Demo

Inside of a React component you can use the useHistorySync() hook to achieve the same result.

import {useHistorySync} from 'dendriform';

function MyComponent(props) {
    const personForm = useDendriform(() => ({name: 'Bill'}), {history: 100});
    const addressForm = useDendriform(() => ({street: 'Cool St'}), {history: 100});

    useHistorySync(personForm, addressForm);

    return <div>
        {personForm.render('name', nameForm => (
            <label>name: <input {...useInput(nameForm, 150)} /></label>
        ))}

        {addressForm.render('street', streetForm => (
            <label>street: <input {...useInput(streetForm, 150)} /></label>
        ))}

        {personForm.render(personForm => {
            const {canUndo, canRedo} = personForm.useHistory();
            return <div>
                <button onClick={personForm.undo} disabled={!canUndo}>Undo</button>
                <button onClick={personForm.redo} disabled={!canRedo}>Redo</button>
            </div>;
        })}
    </div>;
}

Cancel changes based on constraints

Forms can have constraints applied to prevent invalid data from being set. An .onDerive() / .useDerive() callback may optionally throw a cancel() to cancel and revert the change that is being currently applied.

import {cancel} from 'dendriform';

const form = new Dendriform(1);

form.onDerive((value) => {
    if(value === 2) {
        throw cancel('Two not allowed');
    }
});

// calling form.set(2) will not result in any change

The .onDerive() callback can be written to obey a force flag, which can be passed into .set().

const form = new Dendriform(1);

form.onDerive((value, {force}) => {
    if(value === 2 && !force) {
        throw cancel('Two not allowed');
    }
});

// calling form.set(2) will not result in any change
// calling form.set(2, {force: true}) will result in a change

You can provide a callback function to be called whenever a change is cancelled using .onCancel, or by using the .useCancel() hook if you're inside a React component's render method.

const form = new Dendriform(1);

form.onDerive((value) => {
    if(value === 2) {
        throw cancel('Two not allowed');
    }
});

form.onCancel((reason) => {
    console.warn(reason);
})

// calling form.set(2) will not result in any change
// and 'Two not allowed' will be logged to the console

The cancel feature can be used to set up data integrity constraints between forms. If a form changes and derives data into other forms, then any other form that updates as a result can trigger the entire change to be cancelled using cancel(). This is a powerful feature that can allow you to set up foreign key constraints between forms.

Demo

Lazy derive

Warning: the {LazyDerive} API is experimental and may be replaced or removed in future.

The LazyDerive class can be used when derivations are heavy or asynchronous, and it makes more sense to only perform these derivations lazily, i.e. when something asks for the derived data. The derivation is cached until any of its dependencies change, at which point the cache is cleared. If it has any current subscribers using lazyDeriver.onChange() or lazyDeriver.useValue() then a new derivation will start immediately.

A LazyDerive can be created using new LazyDerive, or by using the useLazyDerive() hook if you're inside a React component's render method. The deriver function is passed as the first argument to the constructor or hook, and an array of dependencies are passed as the second argument. Dependencies must be Dendriform instances or LazyDerive instances. This allows LazyDerives to derive from each other.

To access the value, use lazyDerive.value, This returns a promise that will resolve when the derivation is complete, or resolve immediately if the derivation is already cached.

Unlike Dendriform there is no restrictions to the data type that LazyDerive can contain.

import {LazyDerive} from 'dendriform';

const name = new Dendriform('Bob');
const age = new Dendriform(12);

const lazyImage = new LazyDerive(async () => {
    return await renderLargeImage(`I am ${name.value} and I am ${age.value}`);
}, [name, age]);

// or useLazyDerive(async () => ..., [name, age]) in a React component

// later something may call the image
await lazyImage.value;

// or in React a component may always want to render the result
function MyComponent(props) {
    const src = lazyImage.useValue();
    return src && <img src={src} />;
}

The useValue() hook may optionally be passed a boolean indicating whether the previous value should be rendered if a new derivation is taking place. This defaults to false, meaning that the result of lazyDerive.useValue() will change to undefined as soon as a new derivation begins.

The status of the derivation can be accessed from lazyDerive.status. This is a Dendriform that contains an object with the following keys:

  • deriving: boolean - true if the derivation is in progress.
  • derived: boolean - true if a derivation has completed.

As this is a Dendriform, all the normal Dendriform usage patterns can be used (i.e. lazyDerive.status.branch('deriving').useValue()).

The lazyDerive.unsubscribe() function should be called when a LazyDerive is no longer needed to prevent memory leaks.

Etymology

"Dendriform" means "tree shaped", referencing the tree-like manner in which you can traverse and render the parts of a deep data shape.

Demos

Demos can be found on dendriform.xyz.

Development

This library is written and maintained by Damien Clarke. All online library discussion happens over on Github.

I hope this library helps solve some data-editing user interface problems for you. 🎉

Readme

Keywords

none

Package Sidebar

Install

npm i dendriform

Repository

github.com/dxinteractive/dendriform

Homepage

github.com/dxinteractive/dendriform#readme

Weekly Downloads

24

Version

3.4.3

License

MIT

Unpacked Size

660 kB

Total Files

40

Last publish

Collaborators

  • dxinteractive
Try on RunKit
Report malware