@manyducks.co/dolla 2.0.0-alpha.5 → 2.0.0-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +164 -514
- package/dist/index.d.ts +3 -3
- package/dist/index.js +223 -219
- package/dist/index.js.map +1 -1
- package/dist/jsx-dev-runtime.js +2 -2
- package/dist/jsx-runtime.js +2 -2
- package/dist/markup.d.ts +19 -11
- package/dist/modules/dolla.d.ts +7 -7
- package/dist/modules/language.d.ts +4 -4
- package/dist/modules/router.d.ts +4 -4
- package/dist/nodes/cond.d.ts +3 -3
- package/dist/nodes/html.d.ts +1 -1
- package/dist/nodes/observer.d.ts +4 -4
- package/dist/nodes/outlet.d.ts +3 -3
- package/dist/nodes/repeat.d.ts +9 -9
- package/dist/nodes/text.d.ts +3 -3
- package/dist/{passthrough-CtoBcpag.js → passthrough-BVaqqjam.js} +322 -301
- package/dist/passthrough-BVaqqjam.js.map +1 -0
- package/dist/state.d.ts +101 -0
- package/dist/types.d.ts +11 -11
- package/dist/view.d.ts +20 -5
- package/notes/context-vars.md +21 -0
- package/notes/readme-scratch.md +222 -0
- package/notes/route-middleware.md +42 -0
- package/notes/scratch.md +1 -1
- package/package.json +1 -1
- package/tests/{signals.test.js → state.test.js} +6 -6
- package/dist/passthrough-CtoBcpag.js.map +0 -1
- package/dist/signals.d.ts +0 -101
package/README.md
CHANGED
|
@@ -3,119 +3,112 @@
|
|
|
3
3
|

|
|
4
4
|

|
|
5
5
|
|
|
6
|
-
> WARNING: This package is in active development. It may contain serious bugs and
|
|
6
|
+
> WARNING: This package is in active development. It may contain serious bugs and docs may be outdated or inaccurate. Use at your own risk.
|
|
7
7
|
|
|
8
8
|
Dolla is a batteries-included JavaScript frontend framework covering the needs of moderate-to-complex single page apps:
|
|
9
9
|
|
|
10
|
-
- Reactive DOM updates (Signals
|
|
11
|
-
- Reusable components (
|
|
12
|
-
-
|
|
13
|
-
- HTTP client
|
|
14
|
-
-
|
|
10
|
+
- ⚡ Reactive DOM updates with [State](). Inspired by Signals, but with more explicit tracking.
|
|
11
|
+
- 📦 Reusable components with [Views](#section-views).
|
|
12
|
+
- 🔀 Built in [routing]() with nested routes and middleware support (check login status, preload data, etc).
|
|
13
|
+
- 🐕 Built in [HTTP]() client with middleware support (set auth headers, etc).
|
|
14
|
+
- 📍 Built in [localization]() system (store translated strings in JSON files and call the `t` function to get them).
|
|
15
|
+
- 🍳 Build system optional. Write views in JSX or use `html` tagged template literals.
|
|
15
16
|
|
|
16
17
|
Let's first get into some examples.
|
|
17
18
|
|
|
18
|
-
##
|
|
19
|
+
## State
|
|
19
20
|
|
|
20
|
-
###
|
|
21
|
+
### Basic State API
|
|
21
22
|
|
|
22
23
|
```jsx
|
|
23
|
-
import {
|
|
24
|
-
|
|
25
|
-
// Create a readable state and setter.
|
|
26
|
-
const [$count, setCount] = createSignal(0);
|
|
24
|
+
import { createState, toState, valueOf, derive } from "@manyducks.co/dolla";
|
|
27
25
|
|
|
28
|
-
|
|
29
|
-
const $doubled = derive([$$count], (count) => count * 2);
|
|
30
|
-
```
|
|
26
|
+
const [$count, setCount] = createState(72);
|
|
31
27
|
|
|
32
|
-
|
|
28
|
+
// Get value
|
|
29
|
+
$count.get(): // 72
|
|
33
30
|
|
|
34
|
-
|
|
35
|
-
|
|
31
|
+
// Replace the stored value with something else
|
|
32
|
+
setCount(300);
|
|
33
|
+
$count.get(); // 300
|
|
36
34
|
|
|
37
|
-
|
|
35
|
+
// You can also pass a function that takes the current value and returns a new one
|
|
36
|
+
setCount((current) => current + 1);
|
|
37
|
+
$count.get(); // 301
|
|
38
38
|
|
|
39
|
-
//
|
|
40
|
-
|
|
39
|
+
// Watch for changes to the value
|
|
40
|
+
const unwatch = $count.watch((value) => {
|
|
41
|
+
// This function is called immediately with the current value, then again each time the value changes.
|
|
42
|
+
});
|
|
43
|
+
unwatch(); // Stop watching for changes
|
|
41
44
|
|
|
42
|
-
//
|
|
43
|
-
const
|
|
44
|
-
const
|
|
45
|
+
// Returns the value of a state. If the value is not a state it is returned as is.
|
|
46
|
+
const count = valueOf($count);
|
|
47
|
+
const bool = valueOf(true);
|
|
45
48
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
+
// Creates a state from a value. If the value is already a state it is returned as is.
|
|
50
|
+
const $bool = toState(true);
|
|
51
|
+
const $anotherCount = toState($count);
|
|
49
52
|
|
|
50
|
-
|
|
53
|
+
// Derive a new state from one or more other states. Whenever $count changes, $doubled will follow.
|
|
54
|
+
const $doubled = derive([$count], (count) => count * 2);
|
|
55
|
+
const $sum = derive([$count, $doubled], (count, doubled) => count + doubled);
|
|
51
56
|
```
|
|
52
57
|
|
|
53
|
-
|
|
58
|
+
States also come in a settable variety that includes the setter on the same object. Sometimes you want to pass around a two-way binding and this is what SettableState is for.
|
|
54
59
|
|
|
55
60
|
```jsx
|
|
56
|
-
import {
|
|
57
|
-
|
|
58
|
-
const [$count, setCount] = createSignal(0);
|
|
59
|
-
const $doubled = derive([$count], (count) => count * 2);
|
|
60
|
-
|
|
61
|
-
setCount(1); // $count = 1, $doubled = 2
|
|
62
|
-
setCount(256); // $count = 256, $doubled = 512
|
|
63
|
-
setCount(-37); // $count = -37, $doubled = -74
|
|
64
|
-
```
|
|
61
|
+
import { createSettableState, fromSettable, toSettable } from "@manyducks.co/dolla";
|
|
65
62
|
|
|
66
|
-
|
|
63
|
+
// Settable states have their setter included.
|
|
64
|
+
const $$value = createSettableState("Test");
|
|
65
|
+
$$value.set("New Value");
|
|
67
66
|
|
|
68
|
-
|
|
69
|
-
|
|
67
|
+
// They can also be split into a State and Setter
|
|
68
|
+
const [$value, setValue] = fromSettableState($$value);
|
|
70
69
|
|
|
71
|
-
|
|
72
|
-
|
|
70
|
+
// And a State and Setter can be combined into a SettableState.
|
|
71
|
+
const $$otherValue = toSettableState($value, setValue);
|
|
73
72
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
return html`
|
|
79
|
-
<div>
|
|
80
|
-
<p>Clicks: ${$count}</p>
|
|
81
|
-
<button onclick=${increment}>Click here to increment</button>
|
|
82
|
-
</div>
|
|
83
|
-
`;
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
Dolla.mount(document.body, Counter);
|
|
73
|
+
// Or discard the setter and make it read-only using the good old toState function:
|
|
74
|
+
const $value = toState($$value);
|
|
87
75
|
```
|
|
88
76
|
|
|
89
|
-
|
|
77
|
+
You can also do weird proxy things like this:
|
|
90
78
|
|
|
91
|
-
```
|
|
92
|
-
|
|
79
|
+
```jsx
|
|
80
|
+
// Create an original place for the state to live
|
|
81
|
+
const [$value, setValue] = createState(5);
|
|
93
82
|
|
|
94
|
-
|
|
95
|
-
|
|
83
|
+
// Derive a state that doubles the value
|
|
84
|
+
const $doubled = derive([$value], (value) => value * 2);
|
|
96
85
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
86
|
+
// Create a setter that takes the doubled value and sets the original $value accordingly.
|
|
87
|
+
const setDoubled = createSetter($doubled, (next, current) => {
|
|
88
|
+
setValue(next / 2);
|
|
89
|
+
});
|
|
100
90
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
<p>Clicks: ${$count}</p>
|
|
104
|
-
<button onclick=${increment}>Click here to increment</button>
|
|
105
|
-
</div>
|
|
106
|
-
`;
|
|
107
|
-
}
|
|
91
|
+
// Bundle the derived state and setter into a SettableState to pass around.
|
|
92
|
+
const $$doubled = toSettableState($doubled, setDoubled);
|
|
108
93
|
|
|
109
|
-
|
|
94
|
+
// Setting the doubled state...
|
|
95
|
+
$$doubled.set(100);
|
|
96
|
+
|
|
97
|
+
// ... will be reflected everywhere.
|
|
98
|
+
$$doubled.get(); // 100
|
|
99
|
+
$doubled.get(); // 100
|
|
100
|
+
$value.get(); // 50
|
|
110
101
|
```
|
|
111
102
|
|
|
112
|
-
|
|
103
|
+
## Views [id="section-views"]
|
|
104
|
+
|
|
105
|
+
A basic view:
|
|
113
106
|
|
|
114
107
|
```js
|
|
115
|
-
import Dolla, {
|
|
108
|
+
import Dolla, { createState, html } from "@manyducks.co/dolla";
|
|
116
109
|
|
|
117
110
|
function Counter(props, ctx) {
|
|
118
|
-
const [$count, setCount] =
|
|
111
|
+
const [$count, setCount] = createState(0);
|
|
119
112
|
|
|
120
113
|
function increment() {
|
|
121
114
|
setCount((count) => count + 1);
|
|
@@ -124,25 +117,17 @@ function Counter(props, ctx) {
|
|
|
124
117
|
return html`
|
|
125
118
|
<div>
|
|
126
119
|
<p>Clicks: ${$count}</p>
|
|
127
|
-
<button onclick=${increment}
|
|
120
|
+
<button onclick=${increment}>+1</button>
|
|
128
121
|
</div>
|
|
129
122
|
`;
|
|
130
123
|
}
|
|
131
124
|
|
|
132
|
-
Dolla.language.setup({
|
|
133
|
-
initialLanguage: "en",
|
|
134
|
-
languages: [
|
|
135
|
-
{ name: "en", strings: { buttonLabel: "Click here to increment" } },
|
|
136
|
-
{ name: "ja", strings: { buttonLabel: "ここに押して増加する" } },
|
|
137
|
-
],
|
|
138
|
-
});
|
|
139
|
-
|
|
140
125
|
Dolla.mount(document.body, Counter);
|
|
141
126
|
```
|
|
142
127
|
|
|
143
128
|
If you've ever used React before (and chances are you have if you're interested in obscure frameworks like this one) this should look very familiar to you.
|
|
144
129
|
|
|
145
|
-
The biggest difference is that the Counter function runs only once when the component is mounted. All updates after that point are a direct result of
|
|
130
|
+
The biggest difference is that the Counter function runs only once when the component is mounted. All updates after that point are a direct result of `$count` being updated.
|
|
146
131
|
|
|
147
132
|
## Advanced Componentry
|
|
148
133
|
|
|
@@ -155,10 +140,10 @@ Component functions take two arguments; props and a `Context` object. Props are
|
|
|
155
140
|
Props are values passed down from parent components. These can be static values, signals, callbacks and anything else the child component needs to do its job.
|
|
156
141
|
|
|
157
142
|
```tsx
|
|
158
|
-
import { type
|
|
143
|
+
import { type State, type Context, html } from "@manyducks.co/dolla";
|
|
159
144
|
|
|
160
145
|
type HeadingProps = {
|
|
161
|
-
$text:
|
|
146
|
+
$text: State<string>;
|
|
162
147
|
};
|
|
163
148
|
|
|
164
149
|
function Heading(props: HeadingProps, c: Context) {
|
|
@@ -179,10 +164,10 @@ function Layout() {
|
|
|
179
164
|
### Context
|
|
180
165
|
|
|
181
166
|
```tsx
|
|
182
|
-
import { type
|
|
167
|
+
import { type State, type Context, html } from "@manyducks.co/dolla";
|
|
183
168
|
|
|
184
169
|
type HeadingProps = {
|
|
185
|
-
$text:
|
|
170
|
+
$text: State<string>;
|
|
186
171
|
};
|
|
187
172
|
|
|
188
173
|
function Heading(props: HeadingProps, c: Context) {
|
|
@@ -216,7 +201,7 @@ function Heading(props: HeadingProps, c: Context) {
|
|
|
216
201
|
c.info("Heading has just been unmounted. Good time to finalize teardown.");
|
|
217
202
|
});
|
|
218
203
|
|
|
219
|
-
//
|
|
204
|
+
// States can be watched by the component context.
|
|
220
205
|
// Watchers created this way are cleaned up automatically when the component unmounts.
|
|
221
206
|
|
|
222
207
|
c.watch(props.$text, (value) => {
|
|
@@ -284,17 +269,17 @@ $selected.get(); // "Bon"
|
|
|
284
269
|
Proxy
|
|
285
270
|
|
|
286
271
|
```jsx
|
|
287
|
-
import {
|
|
272
|
+
import { createState, createProxyState } from "@manyducks.co/dolla";
|
|
288
273
|
|
|
289
|
-
const [$names, setNames] =
|
|
290
|
-
const [$index, setIndex] =
|
|
274
|
+
const [$names, setNames] = createState(["Morg", "Ton", "Bon"]);
|
|
275
|
+
const [$index, setIndex] = createState(0);
|
|
291
276
|
|
|
292
|
-
const [$selected, setSelected] =
|
|
277
|
+
const [$selected, setSelected] = createProxyState([$names, $index], {
|
|
293
278
|
get(names, index) {
|
|
294
279
|
return names[index];
|
|
295
280
|
},
|
|
296
|
-
set(next) {
|
|
297
|
-
const index =
|
|
281
|
+
set(next, names, _) {
|
|
282
|
+
const index = names.indexOf(next);
|
|
298
283
|
if (index === -1) {
|
|
299
284
|
throw new Error("Name is not in the list!");
|
|
300
285
|
}
|
|
@@ -313,137 +298,6 @@ $selected.get(); // "Ton"
|
|
|
313
298
|
$index.get(); // 1
|
|
314
299
|
```
|
|
315
300
|
|
|
316
|
-
##
|
|
317
|
-
|
|
318
|
-
States come in two varieties, each with a constructor function and a TypeScript type to match. These are:
|
|
319
|
-
|
|
320
|
-
- `Readable<T>`, which has only a `.get()` method that returns the current value.
|
|
321
|
-
- `Writable<T>`, which extends `Readable<T>` and adds a couple methods:
|
|
322
|
-
- `.set(value: T)` to replace the stored value.
|
|
323
|
-
- `.update(callback: (current: T) => T)` which takes a function that receives the current value and returns a new one.
|
|
324
|
-
|
|
325
|
-
The constructor functions are `$` for `Readable` and `$$` for `Writable`. By convention, the names of each are prefixed with `$` or `$$` to indicate its type, making the data flow a lot easier to understand at a glance.
|
|
326
|
-
|
|
327
|
-
```js
|
|
328
|
-
import { signal } from "@manyducks.co/dolla";
|
|
329
|
-
|
|
330
|
-
// By convention, Writable names are prefixed with two dollar signs and Readable with one.
|
|
331
|
-
const [$number, setNumber] = signal(5);
|
|
332
|
-
|
|
333
|
-
// Returns the current value held by the Writable.
|
|
334
|
-
$number.get();
|
|
335
|
-
// Stores a new value to the Writable.
|
|
336
|
-
setNumber(12);
|
|
337
|
-
// Uses a callback to update the value. Takes the current value and returns the next.
|
|
338
|
-
setNumber((current) => current + 1);
|
|
339
|
-
|
|
340
|
-
// Derive a new state from an existing one.
|
|
341
|
-
const $doubled = derive([$number], (value) => value * 2);
|
|
342
|
-
$doubled.get(); // 26 ($number is 13)
|
|
343
|
-
|
|
344
|
-
// Derive one new state from the latest values of many other states.
|
|
345
|
-
const $many = derive([$number, $doubled], (num, doubled) => num + doubled);
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
Now how do we use it? For a real example, a simple greeter app. The user types their name into a text input and that value is reflected in a heading above the input. For this we will use the `writable` function to create a state container. That container can be slotted into our JSX as a text node or DOM property. Any changes to the value will now be reflected in the DOM.
|
|
349
|
-
|
|
350
|
-
```jsx
|
|
351
|
-
import { signal } from "@manyducks.co/dolla";
|
|
352
|
-
|
|
353
|
-
function Greeter() {
|
|
354
|
-
const [$name, setName] = signal("Valued Customer");
|
|
355
|
-
|
|
356
|
-
return (
|
|
357
|
-
<section>
|
|
358
|
-
<header>
|
|
359
|
-
<h1>Hello, {$name}!</h1>
|
|
360
|
-
</header>
|
|
361
|
-
|
|
362
|
-
<input
|
|
363
|
-
value={$name}
|
|
364
|
-
onChange={(e) => {
|
|
365
|
-
setName(e.target.value);
|
|
366
|
-
}}
|
|
367
|
-
/>
|
|
368
|
-
</section>
|
|
369
|
-
);
|
|
370
|
-
}
|
|
371
|
-
```
|
|
372
|
-
|
|
373
|
-
### Computed
|
|
374
|
-
|
|
375
|
-
Computed states take one or more Readables or Writables and produce a new value _computed_ from those.
|
|
376
|
-
|
|
377
|
-
```js
|
|
378
|
-
import { $, $$ } from "@manyducks.co/dolla";
|
|
379
|
-
|
|
380
|
-
const $$count = $$(100);
|
|
381
|
-
|
|
382
|
-
const $double = $($$count, (value) => value * 2);
|
|
383
|
-
```
|
|
384
|
-
|
|
385
|
-
In that example, `$$double` will always have a value derived from that of `$$count`.
|
|
386
|
-
|
|
387
|
-
Let's look at a more typical example where we're basically joining two pieces of data; a list of users and the ID of the selected user.
|
|
388
|
-
|
|
389
|
-
```js
|
|
390
|
-
import { $, $$ } from "@manyducks.co/dolla";
|
|
391
|
-
|
|
392
|
-
// Let's assume this list of users was fetched from an API somewhere.
|
|
393
|
-
const $$people = $$([
|
|
394
|
-
{
|
|
395
|
-
id: 1,
|
|
396
|
-
name: "Borb",
|
|
397
|
-
},
|
|
398
|
-
{
|
|
399
|
-
id: 2,
|
|
400
|
-
name: "Bex",
|
|
401
|
-
},
|
|
402
|
-
{
|
|
403
|
-
id: 3,
|
|
404
|
-
name: "Bleeblop",
|
|
405
|
-
},
|
|
406
|
-
]);
|
|
407
|
-
|
|
408
|
-
// Let's assume this ID was chosen from an input where the above users were displayed.
|
|
409
|
-
const $$selectedId = $$(2);
|
|
410
|
-
|
|
411
|
-
// Now we get the object of the person who is selected.
|
|
412
|
-
const $selectedPerson = $($$people, $$selectedId, (people, selectedId) => {
|
|
413
|
-
return people.find((person) => person.id === selectedId);
|
|
414
|
-
});
|
|
415
|
-
|
|
416
|
-
// Now we get a Readable of just that person's name. Say we're going to display it on the page somewhere.
|
|
417
|
-
const $personName = $($selectedPerson, (person) => person.name);
|
|
418
|
-
|
|
419
|
-
console.log($personName.get()); // "Bex"
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
Notice that the structure above composes a data pipeline; if any of the data changes, so do the computed values, but the relationship between the data remains the same. Now that we've defined these relationships, `$selectedPerson` is always the person pointed to by `$$selectedId`. `$personName` is always the name of `$selectedPerson`, etc.
|
|
423
|
-
|
|
424
|
-
### Unwrap
|
|
425
|
-
|
|
426
|
-
The `unwrap` function returns the current value of a Readable or Writable, or if passed a non-Readable value returns that exact value. This function is used to guarantee you have a plain value when you may be dealing with either a container or a plain value.
|
|
427
|
-
|
|
428
|
-
```js
|
|
429
|
-
import { $, $$, unwrap } from "@manyducks.co/dolla";
|
|
430
|
-
|
|
431
|
-
const $$number = $$(5);
|
|
432
|
-
|
|
433
|
-
unwrap($$number); // 5
|
|
434
|
-
unwrap($(5)); // 5
|
|
435
|
-
unwrap(5); // 5
|
|
436
|
-
```
|
|
437
|
-
|
|
438
|
-
### Advanced Use Cases
|
|
439
|
-
|
|
440
|
-
<details>
|
|
441
|
-
<summary><code>observe</code> and <code>proxy</code></summary>
|
|
442
|
-
|
|
443
|
-
> TO DO
|
|
444
|
-
|
|
445
|
-
</details>
|
|
446
|
-
|
|
447
301
|
## Views
|
|
448
302
|
|
|
449
303
|
Views are what most frameworks would call Components. Dolla calls them Views because they deal specifically with stuff the user sees, and because Dolla also has another type of component called Stores that share data between views. We will get into those later.
|
|
@@ -530,7 +384,7 @@ The `repeat` helper repeats a render function for each item in a list. The `keyF
|
|
|
530
384
|
|
|
531
385
|
```jsx
|
|
532
386
|
function RepeatedListView() {
|
|
533
|
-
const $items =
|
|
387
|
+
const $items = Dolla.toState(["Squirrel", "Chipmunk", "Groundhog"]);
|
|
534
388
|
|
|
535
389
|
return (
|
|
536
390
|
<ul>
|
|
@@ -559,7 +413,7 @@ function PortalView() {
|
|
|
559
413
|
);
|
|
560
414
|
|
|
561
415
|
// Content will be appended to `document.body` while this view is connected.
|
|
562
|
-
return portal(
|
|
416
|
+
return portal(document.body, content);
|
|
563
417
|
}
|
|
564
418
|
```
|
|
565
419
|
|
|
@@ -637,18 +491,6 @@ function ExampleView() {
|
|
|
637
491
|
}
|
|
638
492
|
```
|
|
639
493
|
|
|
640
|
-
#### Using Stores
|
|
641
|
-
|
|
642
|
-
```jsx
|
|
643
|
-
import { UserStore } from "../stores/UserStore.js";
|
|
644
|
-
|
|
645
|
-
function ExampleView(props, ctx) {
|
|
646
|
-
const { $name } = ctx.getStore(UserStore);
|
|
647
|
-
|
|
648
|
-
return <h1>Hello {$name}!</h1>;
|
|
649
|
-
}
|
|
650
|
-
```
|
|
651
|
-
|
|
652
494
|
#### Observing States
|
|
653
495
|
|
|
654
496
|
The `observe` function starts observing when the view is connected and stops when disconnected. This takes care of cleaning up observers so you don't have to worry about memory leaks.
|
|
@@ -665,239 +507,6 @@ function ExampleView(props, ctx) {
|
|
|
665
507
|
}
|
|
666
508
|
```
|
|
667
509
|
|
|
668
|
-
#### Example: Counter View
|
|
669
|
-
|
|
670
|
-
Putting it all together, we have a view that maintains a counter. The user sees the current count displayed, and below it three buttons; one to increment by 1, one to decrement by 1, and one to reset the value to 0.
|
|
671
|
-
|
|
672
|
-
```jsx
|
|
673
|
-
import { $$ } from "@manyducks.co/dolla";
|
|
674
|
-
|
|
675
|
-
function CounterView(props, ctx) {
|
|
676
|
-
const $$count = $$(0);
|
|
677
|
-
|
|
678
|
-
function increment() {
|
|
679
|
-
$$count.update((n) => n + 1);
|
|
680
|
-
}
|
|
681
|
-
|
|
682
|
-
function decrement() {
|
|
683
|
-
$$count.update((n) => n - 1);
|
|
684
|
-
}
|
|
685
|
-
|
|
686
|
-
function reset() {
|
|
687
|
-
$$count.set(0);
|
|
688
|
-
}
|
|
689
|
-
|
|
690
|
-
return (
|
|
691
|
-
<div>
|
|
692
|
-
<p>The count is {$$count}</p>
|
|
693
|
-
<div>
|
|
694
|
-
<button onClick={increment}>+1</button>
|
|
695
|
-
<button onClick={decrement}>-1</button>
|
|
696
|
-
<button onClick={reset}>Reset</button>
|
|
697
|
-
</div>
|
|
698
|
-
</div>
|
|
699
|
-
);
|
|
700
|
-
}
|
|
701
|
-
```
|
|
702
|
-
|
|
703
|
-
## Stores
|
|
704
|
-
|
|
705
|
-
A store is a function that returns a plain JavaScript object. If this store is registered on the app, a single instance of the store is shared across all views and stores in the app. If the store is registered using a `StoreScope`, a single instance of the store is shared amongst all child elements of that `StoreScope`.
|
|
706
|
-
|
|
707
|
-
Stores are accessed with the `getStore` function available on the context object in views and other stores.
|
|
708
|
-
|
|
709
|
-
Stores are helpful for managing persistent state that needs to be accessed in many places.
|
|
710
|
-
|
|
711
|
-
```js
|
|
712
|
-
import { App } from "@manyducks.co/dolla";
|
|
713
|
-
|
|
714
|
-
const app = App({
|
|
715
|
-
view: LayoutView,
|
|
716
|
-
stores: [MessageStore],
|
|
717
|
-
});
|
|
718
|
-
|
|
719
|
-
// We define a store that just exports a message.
|
|
720
|
-
function MessageStore() {
|
|
721
|
-
return {
|
|
722
|
-
message: "Hello from the message store!",
|
|
723
|
-
};
|
|
724
|
-
}
|
|
725
|
-
|
|
726
|
-
// All instances of MessageView will share just one instance of MessageStore.
|
|
727
|
-
function MessageView(props, ctx) {
|
|
728
|
-
const store = ctx.getStore(MessageStore);
|
|
729
|
-
|
|
730
|
-
return <p>{store.message}</p>;
|
|
731
|
-
}
|
|
732
|
-
|
|
733
|
-
// And a layout view with five MessageViews inside.
|
|
734
|
-
function LayoutView() {
|
|
735
|
-
return (
|
|
736
|
-
<div>
|
|
737
|
-
<h1>Title</h1>
|
|
738
|
-
<MessageView />
|
|
739
|
-
<MessageView />
|
|
740
|
-
<MessageView />
|
|
741
|
-
<MessageView />
|
|
742
|
-
<MessageView />
|
|
743
|
-
</div>
|
|
744
|
-
);
|
|
745
|
-
}
|
|
746
|
-
|
|
747
|
-
// Connect the app.
|
|
748
|
-
app.connect("#app");
|
|
749
|
-
```
|
|
750
|
-
|
|
751
|
-
The output:
|
|
752
|
-
|
|
753
|
-
```html
|
|
754
|
-
<div id="app">
|
|
755
|
-
<div>
|
|
756
|
-
<h1>Title</h1>
|
|
757
|
-
<p>Hello from the message store!</p>
|
|
758
|
-
<p>Hello from the message store!</p>
|
|
759
|
-
<p>Hello from the message store!</p>
|
|
760
|
-
<p>Hello from the message store!</p>
|
|
761
|
-
<p>Hello from the message store!</p>
|
|
762
|
-
</div>
|
|
763
|
-
</div>
|
|
764
|
-
```
|
|
765
|
-
|
|
766
|
-
### StoreScope
|
|
767
|
-
|
|
768
|
-
Stores relevant to only a part of the view tree can be scoped using a `StoreScope`.
|
|
769
|
-
|
|
770
|
-
```jsx
|
|
771
|
-
function ExampleStore() {
|
|
772
|
-
return { value: 5 };
|
|
773
|
-
}
|
|
774
|
-
|
|
775
|
-
function ExampleView(props, ctx) {
|
|
776
|
-
const store = ctx.getStore(ExampleStore);
|
|
777
|
-
|
|
778
|
-
return <div>{store.value}</div>;
|
|
779
|
-
}
|
|
780
|
-
|
|
781
|
-
function LayoutView() {
|
|
782
|
-
return (
|
|
783
|
-
<StoreScope stores={[ExampleStore]}>
|
|
784
|
-
<ExampleView />
|
|
785
|
-
</StoreScope>
|
|
786
|
-
);
|
|
787
|
-
}
|
|
788
|
-
```
|
|
789
|
-
|
|
790
|
-
## Apps and Routing
|
|
791
|
-
|
|
792
|
-
```jsx
|
|
793
|
-
import { App } from "@manyducks.co/dolla";
|
|
794
|
-
|
|
795
|
-
const app = App({
|
|
796
|
-
// Debug options control what gets printed from messages logged through view and store contexts.
|
|
797
|
-
debug: {
|
|
798
|
-
// A comma-separated list of filters. '*' means allow everything and '-dolla/*' means suppress messages with labels beginning with 'dolla/'.
|
|
799
|
-
filter: "*,-dolla/*",
|
|
800
|
-
|
|
801
|
-
// Never print ctx.info() messages
|
|
802
|
-
info: false,
|
|
803
|
-
|
|
804
|
-
// Only print ctx.log() and ctx.warn() messages in development mode
|
|
805
|
-
log: "development",
|
|
806
|
-
warn: "development",
|
|
807
|
-
|
|
808
|
-
// Always print ctx.error() messages
|
|
809
|
-
error: true,
|
|
810
|
-
},
|
|
811
|
-
|
|
812
|
-
mode: "development", // or "production" (enables additional debug features and logging in "development")
|
|
813
|
-
|
|
814
|
-
view: (_, ctx) => {
|
|
815
|
-
// Define a custom root view. By default this just renders any routes like so:
|
|
816
|
-
return ctx.outlet();
|
|
817
|
-
},
|
|
818
|
-
});
|
|
819
|
-
```
|
|
820
|
-
|
|
821
|
-
#### Routes and Outlets
|
|
822
|
-
|
|
823
|
-
The main view (defined with the app's `main` method) is the top-level view that will always be displayed while the app is connected.
|
|
824
|
-
|
|
825
|
-
```jsx
|
|
826
|
-
// Here is an app with a hypothetical main view with a layout and navigation:
|
|
827
|
-
const app = App({
|
|
828
|
-
view: (_, ctx) => {
|
|
829
|
-
return (
|
|
830
|
-
<div class="todo-layout">
|
|
831
|
-
<nav>
|
|
832
|
-
<ul>
|
|
833
|
-
<li>
|
|
834
|
-
<a href="/tasks">Tasks</a>
|
|
835
|
-
</li>
|
|
836
|
-
<li>
|
|
837
|
-
<a href="/completed">Completed</a>
|
|
838
|
-
</li>
|
|
839
|
-
</ul>
|
|
840
|
-
</nav>
|
|
841
|
-
{/*
|
|
842
|
-
* An outlet is where children of a view are shown.
|
|
843
|
-
* Because this is a main view, children in this case
|
|
844
|
-
* are the views that correspond to matched routes.
|
|
845
|
-
*/}
|
|
846
|
-
{ctx.outlet()}
|
|
847
|
-
</div>
|
|
848
|
-
);
|
|
849
|
-
},
|
|
850
|
-
|
|
851
|
-
stores: [
|
|
852
|
-
{
|
|
853
|
-
store: RouterStore,
|
|
854
|
-
options: {
|
|
855
|
-
hash: true, // Use hash-based routing (default false)
|
|
856
|
-
|
|
857
|
-
// Here are a couple of routes to be rendered into our layout:
|
|
858
|
-
routes: [
|
|
859
|
-
{ path: "/tasks", view: TasksView },
|
|
860
|
-
{ path: "/completed", view: CompletedView },
|
|
861
|
-
],
|
|
862
|
-
},
|
|
863
|
-
},
|
|
864
|
-
],
|
|
865
|
-
});
|
|
866
|
-
```
|
|
867
|
-
|
|
868
|
-
Routes can also be nested. Just like the main view and its routes, subroutes will be displayed in the outlet of their parent view.
|
|
869
|
-
|
|
870
|
-
```jsx
|
|
871
|
-
const app = App({
|
|
872
|
-
stores: [
|
|
873
|
-
{
|
|
874
|
-
store: RouterStore,
|
|
875
|
-
options: {
|
|
876
|
-
routes: [
|
|
877
|
-
{
|
|
878
|
-
path: "/tasks",
|
|
879
|
-
view: TasksView,
|
|
880
|
-
routes: [
|
|
881
|
-
{ path: "/", view: TaskListView },
|
|
882
|
-
|
|
883
|
-
// In routes, `{value}` is a dynamic value that matches anything,
|
|
884
|
-
// and `{#value}` is a dynamic value that matches a number.
|
|
885
|
-
{ path: "/{#id}", view: TaskDetailsView },
|
|
886
|
-
{ path: "/{#id}/edit", view: TaskEditView },
|
|
887
|
-
|
|
888
|
-
// If the route is any other than the ones defined above, redirect to the list.
|
|
889
|
-
// Redirects support './' and '../' style relative paths.
|
|
890
|
-
{ path: "*", redirect: "./" },
|
|
891
|
-
],
|
|
892
|
-
},
|
|
893
|
-
{ path: "/completed", view: CompletedView },
|
|
894
|
-
],
|
|
895
|
-
},
|
|
896
|
-
},
|
|
897
|
-
],
|
|
898
|
-
});
|
|
899
|
-
```
|
|
900
|
-
|
|
901
510
|
#### Routing
|
|
902
511
|
|
|
903
512
|
Dolla makes heavy use of client-side routing. You can define as many routes as you have views, and the URL
|
|
@@ -925,30 +534,23 @@ to your code (`router` store, `$params` readable). Below are some examples of pa
|
|
|
925
534
|
Now, here are some route examples in the context of an app:
|
|
926
535
|
|
|
927
536
|
```js
|
|
928
|
-
import
|
|
929
|
-
import { PersonDetails, ThingIndex, ThingDetails, ThingEdit, ThingDelete } from "./
|
|
537
|
+
import Dolla from "@manyducks.co/dolla";
|
|
538
|
+
import { PersonDetails, ThingIndex, ThingDetails, ThingEdit, ThingDelete } from "./views.js";
|
|
930
539
|
|
|
931
|
-
|
|
932
|
-
|
|
540
|
+
Dolla.router.setup({
|
|
541
|
+
routes: [
|
|
542
|
+
{ path: "/people/{name}", view: PersonDetails },
|
|
933
543
|
{
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
{ path: "/", view: ThingIndex }, // matches `/things`
|
|
945
|
-
{ path: "/{#id}", view: ThingDetails }, // matches `/things/{#id}`
|
|
946
|
-
{ path: "/{#id}/edit", view: ThingEdit }, // matches `/things/{#id}/edit`
|
|
947
|
-
{ path: "/{#id}/delete", view: ThingDelete }, // matches `/things/{#id}/delete`
|
|
948
|
-
],
|
|
949
|
-
},
|
|
950
|
-
],
|
|
951
|
-
},
|
|
544
|
+
// A `null` component with subroutes acts as a namespace for those subroutes.
|
|
545
|
+
// Passing a view instead of `null` results in subroutes being rendered inside that view wherever `ctx.outlet()` is called.
|
|
546
|
+
path: "/things",
|
|
547
|
+
view: null,
|
|
548
|
+
routes: [
|
|
549
|
+
{ path: "/", view: ThingIndex }, // matches `/things`
|
|
550
|
+
{ path: "/{#id}", view: ThingDetails }, // matches `/things/{#id}`
|
|
551
|
+
{ path: "/{#id}/edit", view: ThingEdit }, // matches `/things/{#id}/edit`
|
|
552
|
+
{ path: "/{#id}/delete", view: ThingDelete }, // matches `/things/{#id}/delete`
|
|
553
|
+
],
|
|
952
554
|
},
|
|
953
555
|
],
|
|
954
556
|
});
|
|
@@ -956,41 +558,89 @@ const app = App({
|
|
|
956
558
|
|
|
957
559
|
As you may have inferred from the code above, when the URL matches a pattern the corresponding view is displayed. If we
|
|
958
560
|
visit `/people/john`, we will see the `PersonDetails` view and the params will be `{ name: "john" }`. Params can be
|
|
959
|
-
accessed
|
|
561
|
+
accessed anywhere through `Dolla.router`.
|
|
960
562
|
|
|
961
563
|
```js
|
|
962
564
|
function PersonDetails(props, ctx) {
|
|
963
|
-
// `router` store allows you to work with the router from inside the app.
|
|
964
|
-
const router = ctx.getStore(RouterStore);
|
|
965
|
-
|
|
966
565
|
// Info about the current route is exported as a set of Readables. Query params are also Writable through $$query:
|
|
967
|
-
const { $path, $pattern, $params,
|
|
566
|
+
const { $path, $pattern, $params, $query } = Dolla.router;
|
|
968
567
|
|
|
969
|
-
//
|
|
970
|
-
|
|
568
|
+
Dolla.router.back(); // Step back in the history to the previous route, if any.
|
|
569
|
+
Dolla.router.back(2); // Hit the back button twice.
|
|
971
570
|
|
|
972
|
-
|
|
973
|
-
|
|
571
|
+
Dolla.router.forward(); // Step forward in the history to the next route, if any.
|
|
572
|
+
Dolla.router.forward(4); // Hit the forward button 4 times.
|
|
974
573
|
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
navigate("/things/152"); // Navigate to another path within the same app.
|
|
979
|
-
navigate("https://www.example.com/another/site"); // Navigate to another domain entirely.
|
|
574
|
+
Dolla.router.go("/things/152"); // Navigate to another path within the same app.
|
|
575
|
+
Dolla.router.go("https://www.example.com/another/site"); // Navigate to another domain entirely.
|
|
980
576
|
|
|
981
577
|
// Three ways to confirm with the user that they wish to navigate before actually doing it.
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
578
|
+
Dolla.router.go("/another/page", { prompt: true });
|
|
579
|
+
Dolla.router.go("/another/page", { prompt: "Are you sure you want to leave and go to /another/page?" });
|
|
580
|
+
Dolla.router.go("/another/page", { prompt: PromptView });
|
|
985
581
|
|
|
986
582
|
// Get the live value of `{name}` from the current path.
|
|
987
|
-
const $name =
|
|
583
|
+
const $name = Dolla.derive([$params], (p) => p.name);
|
|
988
584
|
|
|
989
585
|
// Render it into a <p> tag. The name portion will update if the URL changes.
|
|
990
586
|
return <p>The person is: {$name}</p>;
|
|
991
587
|
}
|
|
992
588
|
```
|
|
993
589
|
|
|
590
|
+
## HTTP Client
|
|
591
|
+
|
|
592
|
+
```js
|
|
593
|
+
// Middleware!
|
|
594
|
+
Dolla.http.use((request, next) => {
|
|
595
|
+
// Add auth header for all requests going to the API.
|
|
596
|
+
if (request.url.pathname.startsWith("/api")) {
|
|
597
|
+
request.headers.set("authorization", `Bearer ${authToken}`);
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
const response = await next();
|
|
601
|
+
|
|
602
|
+
// Could do something with the response here.
|
|
603
|
+
|
|
604
|
+
return response;
|
|
605
|
+
});
|
|
606
|
+
|
|
607
|
+
const exampleResponse = await Dolla.http.get("/api/example");
|
|
608
|
+
|
|
609
|
+
// Body is already parsed from JSON into an object.
|
|
610
|
+
exampleResponse.body.someValue;
|
|
611
|
+
```
|
|
612
|
+
|
|
613
|
+
## Localization
|
|
614
|
+
|
|
615
|
+
```js
|
|
616
|
+
import Dolla, { html, t } from "@manyducks.co/dolla";
|
|
617
|
+
|
|
618
|
+
function Counter(props, ctx) {
|
|
619
|
+
const [$count, setCount] = Dolla.createState(0);
|
|
620
|
+
|
|
621
|
+
function increment() {
|
|
622
|
+
setCount((count) => count + 1);
|
|
623
|
+
}
|
|
624
|
+
|
|
625
|
+
return html`
|
|
626
|
+
<div>
|
|
627
|
+
<p>Clicks: ${$count}</p>
|
|
628
|
+
<button onclick=${increment}>${t("buttonLabel")}</button>
|
|
629
|
+
</div>
|
|
630
|
+
`;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
Dolla.language.setup({
|
|
634
|
+
initialLanguage: "en",
|
|
635
|
+
languages: [
|
|
636
|
+
{ name: "en", strings: { buttonLabel: "Click here to increment" } },
|
|
637
|
+
{ name: "ja", strings: { buttonLabel: "ここに押して増加する" } },
|
|
638
|
+
],
|
|
639
|
+
});
|
|
640
|
+
|
|
641
|
+
Dolla.mount(document.body, Counter);
|
|
642
|
+
```
|
|
643
|
+
|
|
994
644
|
---
|
|
995
645
|
|
|
996
646
|
[🦆](https://www.manyducks.co)
|