Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Implement #4 #14

Merged
merged 1 commit into from
Nov 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,12 @@ Simply-reactive is a [very small & dependency free](https://bundlephobia.com/pac
- [Selectors](#selector) are pieces of derived reactive state.
- [Effects](#effect) are side effects produced by changes to the reactive graph.

`Simply-reactive` also provides two reactive composites:
`Simply-reactive` also provides four reactive composites:

- [Groups](#group) are atoms containing collections of reactive primitives or other reactive composites.
- [Effect Groups](#effect-Group) are collections of effects used for enabeling and disabeling multiple effects at once.
- [Resources](#resource) are selectors specifically optimized for data fetching.
- [Query Atoms](#query-atom) are atoms with two way databindings to query search parameters.

### Atom

Expand Down Expand Up @@ -108,6 +110,27 @@ console.log(DoubleCountGroup.find(1).get()); // 4
console.log(DoubleCountGroup.find(2).get()); // 0
```

### Effect Group

Effect Groups are collections of effects used for enabeling and disabeling multiple effects at once.

```ts
const EffectGroup = createEffectGroup([
() => (document.getElementById('in-a').value = A.get()),
() => (document.getElementById('in-b').value = B.get()),
() => (document.getElementById('out-a').innerText = A.get()),
() => (document.getElementById('out-b').innerText = B.get()),
() => (document.getElementById('out-product').innerText = A.get() * B.get()),
]);

document.getElementById('in-a').addEventListener('change', (ev) => {
A.set(parseInt(ev.target.value, 10));
});
document.getElementById('in-b').addEventListener('change', (ev) => {
B.set(parseInt(ev.target.value, 10));
});
```

### Resource

Resources are selectors specifically optimized for data fetching.
Expand All @@ -122,3 +145,20 @@ console.log(`Data after first load ${await Data.get()}`);
Data.invalidate();
console.log(`Data after second load ${await Data.get()}`);
```

### Query Atom

Query Atoms are atoms with two way databindings to query search parameters.

```ts
const A = createQueryAtom({
key: 'a',
default: 0,
});

A.set(3);

// Reload page

A.get(); // 3
```
2 changes: 1 addition & 1 deletion demos/count.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { createAtom, createEffect, createSelector } from '../dist/api';
import { createAtom, createEffect, createSelector } from '../dist/api.node';

const Count = createAtom({
default: 0,
Expand Down
2 changes: 1 addition & 1 deletion demos/groups.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { createGroup, createAtom, createSelector } from '../dist/api';
import { createGroup, createAtom, createSelector } from '../dist/api.node';

const CountGroup = createGroup({
getDefault: () =>
Expand Down
45 changes: 30 additions & 15 deletions demos/browser.html → demos/web.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,41 +23,56 @@
<input id="in-b" />
</lable>

<button id="destroy-btn">Destroy</button>
<button id="restore-btn">Restore</button>
<br />
<button id="destroy-btn">Stop</button>
<button id="restore-btn">Start</button>

<br />
<div id="links"></div>
<a id="link-a" href="">Increment A</a>
<a id="link-b" href="">Increment B</a>

<script src="../cdn/simply-reactive.js"></script>
<script>
const { createAtom, createSelector, createEffectGroup } = simplyReactive;
const { createQueryAtom, createSelector, createEffectGroup } =
simplyReactive;

const A = createAtom({
const A = createQueryAtom({
key: 'a',
default: 2,
});

const B = createAtom({
const B = createQueryAtom({
key: 'b',
default: 3,
});

const Prod = createSelector({
get: () => A.get() * B.get(),
});

document.getElementById('in-a').value = A.get();
document.getElementById('in-a').addEventListener('change', (ev) => {
A.set(parseInt(ev.target.value, 10));
});

document.getElementById('in-b').value = B.get();
document.getElementById('in-b').addEventListener('change', (ev) => {
B.set(parseInt(ev.target.value, 10));
});

const Effect = createEffectGroup([
() => (document.getElementById('out-a').innerText = A.get()),
() => (document.getElementById('out-b').innerText = B.get()),
() => (document.getElementById('out-product').innerText = Prod.get()),
() => (document.getElementById('in-a').value = A.get()),
() => (document.getElementById('in-b').value = B.get()),
() => {
B.get(); // Subscribe to B
document.getElementById('link-a').href = A.urlWhenSet((v) => v + 1);
},
() => {
A.get(); // Subscribe to A
document.getElementById('link-b').href = B.urlWhenSet((v) => v + 1);
},
]);

document.getElementById('in-a').addEventListener('change', (ev) => {
A.set(parseInt(ev.target.value, 10));
});
document.getElementById('in-b').addEventListener('change', (ev) => {
B.set(parseInt(ev.target.value, 10));
});
document.getElementById('destroy-btn').addEventListener('click', () => {
Effect.destroy();
});
Expand Down
Loading