zinkee 0.1.43 → 0.1.44
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 +5 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -456,8 +456,8 @@ zinkee displays folders delete "Executive Dashboards"
|
|
|
456
456
|
### Creation flow
|
|
457
457
|
|
|
458
458
|
1. Create the display
|
|
459
|
-
2. Create context variables
|
|
460
|
-
3. Create widgets
|
|
459
|
+
2. Create context variables — optional; a display without variables shows every widget unfiltered
|
|
460
|
+
3. Create widgets, binding them to the variables through `variableMap` if the display has any
|
|
461
461
|
4. Set freeform layout positions
|
|
462
462
|
|
|
463
463
|
### Templates
|
|
@@ -492,11 +492,12 @@ Variables accept slugs for `--source-schema` and `--source-field`.
|
|
|
492
492
|
|
|
493
493
|
### Add widgets
|
|
494
494
|
|
|
495
|
-
|
|
495
|
+
A widget's `variableMap` maps display variables to fields in the widget's schema. It is optional: a
|
|
496
|
+
widget that binds no variable shows its whole table, bounded only by its own filters.
|
|
496
497
|
|
|
497
498
|
- **Same schema as variable**: bind to the same display field (e.g., `project-name`)
|
|
498
499
|
- **Different schema**: bind to the ReferenceField pointing to the variable's schema (e.g., `task-project`)
|
|
499
|
-
- **No filtering**: set to `null
|
|
500
|
+
- **No filtering**: set to `null`, or leave the variable out of the map
|
|
500
501
|
|
|
501
502
|
```bash
|
|
502
503
|
# Table widget (--field accepts slugs)
|