Dyo
![Dyo](https://dyo.js.org/assets/images/logo.svg)
A JavaScript library for building user interfaces.
![NPM](https://badgen.net/npm/v/dyo)
- Light — weight library with a small composable API surface that allows you to build simple and complex component based user interfaces.
- Declarative Efficiently renders just the right components in response to data, making your code more predictable and easier to reason about.
Installation
- Use a Direct Download:
<script src=dyo.js></script>
. - Use a CDN:
<script src=unpkg.com/dyo></script>
. - Use NPM:
npm install dyo --save
Documentation
Documentation can be find on the website.
See the Getting Started page for a quick overview.
The documentation is divided into several sections:
You can improve it by sending pull requests to this repository.
Examples
Several examples can be found on the website. Here's one to get started:
import {h, render} from 'dyo'
function Example (props) {
return h('h1', {}, 'Hello ', props.name)
}
render(h(Hello, {name: 'World'}), 'body')
This will render a heading element with the text content "Hello World" into the specified target(the body element).
Features
The following is an overview of the features afforded.
- rendering (Components, Fragments, Portals, Promises).
- components (Functions, Generators, AsyncGenerators).
- custom renderer interface and more.
Comparison
The library is much alike React, so it's only natural that a comparison of the differences is in order; Which if succesfull might manage to highlight why it exists.
Re-parenting
The createPortal
interface supports string selectors. This presents an array of different possibilities with regards to isomorphic target references.
In addition to this – re-parenting is baked into portals. That is when a portals container is changed, instead of unmounting its contents and re-mounting them to the newly designated container we can instead move its contents without replaying destruction unmount operations that may discard valuable interface and component state.
In co-ordination with custom renderers, portals afford the opportunity to create atomic branch specific custom renderers. Imagine isolated declarative canvas renderers within a document renderer.
Promises
Promises(or thenables) are first class values. This affords authors the ability to render promises, directly await promises within effects and events, and delay unmounting.
render(h(Promise.resolve('Hello'), {}, 'Loading...'))
function Example (props) {
useEffect(async () => {
return async () => {
return props.current.animate({}).finished
}
})
}
Callbacks
In an async world, public interfaces like render
are not guaranteed to complete synchronously if a subtree happens to have async dependencies within it. A consequence of this will see more use cases for the optional callback
arguments that this function accepts – in much the same way authors are afforded the ability to await on this central routine.
await render(h(Promise.resolve('Hello')))
console.log('Done')
Async Generators
In addition to the iterator protocol, supports for the async iterator protocol is baked in – every iteration is a step in the sequence of state transitions, modeled to afford authors the primitive to implement psuedo-synchronous designs from otherwise asynchronous application interfaces.
The following would first render Loading...
fetch the resource ./
then render the stringified response.
async function* Example (props) {
yield 'Loading...'
const data = await fetch('./')
yield h('pre', JSON.stringify(data))
}
License
Dyo is MIT licensed.