snabbdom-valve/README.md

An interactive, physically based ball valve handle component implemented in snabbdom.

# snabbdom-valve

An interactive, physically based ball valve handle component implemented in snabbdom.

![alt text](example.png "screenshot")


## features

* renders with svg
* handle with spring modeled movement
* optional, subtle sound effect support for more impactful experience
* data oriented, functional design
* tiny! (~ 350 lines of code)


## usage

```javascript
import html  from 'snabby'
import valve from 'snabbdom-valve'


let currentVnode = document.querySelector('div') // where to inject the tabs panel

const model = valve.init({
    // optional sound effects
    // you can provide multiple items in an array and one will be chosen at run time.
    sounds: {
    	done: [ '/handle-done.wav' ],
    	click: [ '/click-1.wav' ]
    }
})


function _toggle (ev) {
    console.log('lever toggled! locked?:', ev.detail.locked)
}


function view (model, update) {
    return html`<div @on:toggle=${_toggle}>
        ${valve.view(model, update)}
    </div>`
}


function update () {
    const newVnode = view(model, update)
    currentVnode = html.update(currentVnode, newVnode)
}


update()
```


### cleanup

if you declare audio in the model, you should destroy the component when you're done with it, to free those resources.

```javascript
valve.destroy(model)
```


## TODO

* replace howler with native html5 audio? (Howler is kind of a large module)
* tighten up handle positioning within the SVG viewbox
* arrows indicating available handle motion?


## Notes Links and References

* https://burakkanber.com/blog/physics-in-javascript-car-suspension-part-1-spring-mass-damper/
* https://www.joshwcomeau.com/animation/a-friendly-introduction-to-spring-physics/
* https://freesound.org/
* https://easings.net/