@mittwald/flow-react-components 1.4.0-next.8 → 1.4.0-next.9
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/USAGE.md
CHANGED
|
@@ -31,14 +31,40 @@ Start with these:
|
|
|
31
31
|
- `/raw/foundations/structure/layout.md` and
|
|
32
32
|
`/raw/foundations/structure/spacing.md` — how layout and spacing are meant to
|
|
33
33
|
be composed
|
|
34
|
-
-
|
|
35
|
-
`/raw/templates/seiten/uebersichtsseite.md`,
|
|
36
|
-
`/raw/templates/seiten/detailseite.md` — the recurring flows
|
|
34
|
+
- the templates — see [Start from a template](#start-from-a-template)
|
|
37
35
|
- `/raw/foundations/content-guidelines/error-handling.md` — preventing and
|
|
38
36
|
presenting errors
|
|
39
37
|
- `/raw/foundations/content-guidelines/sprach-guide.md` — UI wording
|
|
40
38
|
- `/raw/get-started/versioning.md` — what you may depend on
|
|
41
39
|
|
|
40
|
+
## Start from a template
|
|
41
|
+
|
|
42
|
+
**Building a new app, page or flow: pick the matching template before you lay
|
|
43
|
+
out anything.** Pick the app shell first, then the page template, then the
|
|
44
|
+
overlays and building blocks inside it. Fetch the template's page and start from
|
|
45
|
+
its example code. Deviate only when the user explicitly asks for a different
|
|
46
|
+
layout. This applies to quick prototypes too — a prototype that invents its own
|
|
47
|
+
frame shows nothing about how the real thing will look.
|
|
48
|
+
|
|
49
|
+
| You are building… | Start from |
|
|
50
|
+
| ----------------------------------------------------------- | ----------------------------------------------- |
|
|
51
|
+
| An app with a few equal areas on one navigation level | `/raw/templates/app-shells/simple-app.md` |
|
|
52
|
+
| An app with several navigation levels (typical for mStudio) | `/raw/templates/app-shells/complex-app.md` |
|
|
53
|
+
| A single task without navigation (sign-up, order, setup) | `/raw/templates/app-shells/focus-task.md` |
|
|
54
|
+
| A list of many similar objects to pick from | `/raw/templates/seiten/uebersichtsseite.md` |
|
|
55
|
+
| One object to inspect and edit | `/raw/templates/seiten/detailseite.md` |
|
|
56
|
+
| Several topics at a glance | `/raw/templates/seiten/dashboard.md` |
|
|
57
|
+
| Creating, editing or configuring an object in an overlay | `/raw/templates/overlays/anlegen-bearbeiten.md` |
|
|
58
|
+
| Showing details, logs or previews in an overlay | `/raw/templates/overlays/anzeigen.md` |
|
|
59
|
+
| Confirming a destructive or costly action | `/raw/templates/overlays/bestaetigen.md` |
|
|
60
|
+
| An overlay whose inputs depend on a preceding choice | `/raw/templates/overlays/mehrere-schritte.md` |
|
|
61
|
+
| A form | `/raw/templates/bausteine/formular.md` |
|
|
62
|
+
| Uploading several files at once | `/raw/templates/bausteine/multi-upload.md` |
|
|
63
|
+
| Choosing a repeat interval (e.g. a cronjob) | `/raw/templates/bausteine/zeitintervalle.md` |
|
|
64
|
+
|
|
65
|
+
Nothing fits? Say so and compose from the closest template, rather than
|
|
66
|
+
designing a layout from scratch.
|
|
67
|
+
|
|
42
68
|
## Setup
|
|
43
69
|
|
|
44
70
|
```shell
|