@myrmidon/gve-core 3.0.3 → 5.0.1

package/README.md

@@ -61,9 +61,52 @@ The snapshot editor is the top-level component in the library and orchestrates t
 - ▶️ `snapshot` (`Snapshot`): the snapshot to edit.
 - ▶️ `batchOps` (`string`): the batch operations text to set for the editor.
 - ▶️ `noSave` (`boolean`): true to disable saving.
+- ▶️ `featureDefs` (`FeatureDefinitions`): preset feature definitions, if any.
+- ▶️ `elementFeatureDefs` (`FeatureDefinitions`): preset feature definitions for graphical elements, if any.
+- ▶️ `diplomaticFeatureDefs` (`FeatureDefinitions`): preset diplomatic feature definitions, if any.
 - 🔥 `snapshotChange` (`Snapshot`): emitted when the user saves the edited snapshot.
 - 🔥 `snapshotCancel` (`void`): emitted when the user cancels the snapshot editing.
 
+As for **feature definitions**, the `FeatureDefinitions` interface can be provided with this model:
+
+- `names` (`LabeledId[]`): list of features, each having an ID and a label:
+  - `id` (string)
+  - `label` (string)
+- `values` (`FeatureMap`, a dictionary of `LabeledId[]` keyed by feature name): used for features from closed sets, it lists the possible values for each feature name. In this dictionary, the key is the feature name, and the value is an array of labeled IDs representing the allowed values for that feature.
+
+💡 Example: in this example we have 2 features, _color_ (ID=`clr`) and _size_ (ID=`sz`). The _size_ feature has unconstrained values, while the _color_ feature is limited to _red_ (ID=`r`), _green_ (ID=`g`), and _blue_ (ID=`b`):
+
+```ts
+{
+  names: [
+    {
+      id: 'clr',
+      label: 'color',
+    },
+    {
+      id: 'sz',
+      label: 'size',
+    },
+  ],
+  values: {
+    clr: [
+      {
+        id: 'r',
+        label: 'red',
+      },
+      {
+        id: 'g',
+        label: 'green',
+      },
+      {
+        id: 'b',
+        label: 'blue',
+      },
+    ],
+  }
+}
+```
+
 The only data directly handled by the component are:
 
 - size and style;