Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunesimonsen/dependable-view
View layer for @dependable/state
https://github.com/sunesimonsen/dependable-view
Last synced: 1 day ago
JSON representation
View layer for @dependable/state
- Host: GitHub
- URL: https://github.com/sunesimonsen/dependable-view
- Owner: sunesimonsen
- License: mit
- Created: 2022-06-15T20:59:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T18:15:38.000Z (2 days ago)
- Last Synced: 2024-10-01T18:40:06.866Z (2 days ago)
- Language: JavaScript
- Size: 80.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @dependable/view
[](https://github.com/sunesimonsen/dependable-view/actions?query=workflow%3ACI+branch%3Amain)
[](https://unpkg.com/@dependable/view/dist/dependable-view-h.esm.min.js)
[](https://unpkg.com/@dependable/view/dist/dependable-view-vdom.esm.min.js)
A small VDOM based view layer for [@dependable/state](https://github.com/sunesimonsen/dependable-state)
- Easy learning curve
- Tiny, less than 3KB
- Depends only on [@dependable/state](https://github.com/sunesimonsen/dependable-state)
- Allows multiple versions of the library in the page
- Batches updates
[API documentation](https://dependable-view-api.surge.sh/modules/index.html)
## Install
```sh
# npm
npm install --save @dependable/view
# yarn
yarn add @dependable/view
```
## Usage
Let's make a silly todo list to see how things work:
```js
import { render, html } from "@dependable/view";
import { observable, computed } from "@dependable/state";
// The todo state
const todos = observable([]);
const todoCount = computed(() => todos().length);
// Observable for the input text
const text = observable("");
const setText = (e) => text(e.target.value);
// Add the current todo text to the list
const addTodo = () => {
todos([...todos(), text()]);
text("");
};
class TodoInput {
render() {
return html``;
}
}
class TodoList {
render() {
return html`
Add Todo
<${TodoInput} />
Add
- ${text} `)}
${todos().map((text) => html`
Number of todos: ${todoCount()}
`;
}
}
render(html`<${TodoList} />`);
```
As you can see, we can model the global application state outside of components.
This separates the logic from the views and allows for easier testing for the
logic.
The render methods just uses the observables and computeds and is re-rendered with they change.
## Acknowledgements
The VDOM is heavily inspired by https://preactjs.com/
## License
MIT License
Copyright (c) 2022 Sune Simonsen [email protected]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.