react-faux-dom-roadcert-edition
v0.0.1
Published
DOM like data structure to be mutated by D3 et al, then rendered to React elements
Downloads
2
Readme
react-faux-dom
DOM like data structure to be mutated by D3 et al, then rendered to React elements.
// Create your element.
var el = ReactFauxDOM.createElement('div')
// Change stuff using actual DOM functions.
// Even perform CSS selections.
el.style.setProperty('color', 'red')
el.setAttribute('class', 'box')
// Render it to React elements.
return el.toReact()
// Yields: <div style='color: red;' className='box'></div>
There are also mixins available for convenience, giving you a clean API and animation support:
// inside componentWillMount
var faux = this.connectFauxDOM('div','chart');
d3.doingAnAdvancedAnimationFor3secs(faux);
this.animateFauxDOM(3500); // duration + margin
// inside render
return {this.state.chart};
ReactFauxDOM supports a wide range of DOM operations and will fool most libraries but it isn't exhaustive (the full DOM API is ludicrously large). It supports enough to work with D3 but will require you to fork and add to the project if you encounter something that's missing.
You can think of this as a bare bones jsdom that's built to bridge the gap between the declarative React and the imperative JavaScript world. We just need to expand it as we go along since jsdom is a huge project that solves different problems.
I'm trying to keep it light so as not to slow down your render function. I want efficient, declarative and stateless code, but I don't want to throw away previous tools to get there.
Usage
- Full documentation with current DOM API coverage
- An example static chart (source)
- An example animated chart using the mixin
- A simple example using state and events (source)
- d3-react-sparkline, a small component I built at Qubit
Development
# Fetch the dependencies
make bootstrap
# Test
make test
# Test continually
make test-watch
Author
Oliver Caldwell (@OliverCaldwell)
Unlicenced
Find the full unlicense in the UNLICENSE
file, but here's a snippet.
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
Do what you want. Learn as much as you can. Unlicense more software.