@aws/mynah-ui 4.26.0 → 4.26.1
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/dist/main.js +1 -1
- package/dist/main.js.map +1 -1
- package/dist/static.d.ts +8 -0
- package/docs/DATAMODEL.md +28 -0
- package/package.json +1 -1
- package/ui-tests/dist/main.js +1 -1
- package/ui-tests/dist/main.js.map +1 -1
package/dist/static.d.ts
CHANGED
|
@@ -126,6 +126,14 @@ export interface MynahUIDataModel {
|
|
|
126
126
|
* Tab content header details, only visibile when showTabHeaderDetails is set to 'true'
|
|
127
127
|
*/
|
|
128
128
|
tabHeaderDetails?: TabHeaderDetails | null;
|
|
129
|
+
/**
|
|
130
|
+
* A lightweight key-value store for essential tab-specific primitive metadata.
|
|
131
|
+
* Not intended for storing large amounts of data - use appropriate
|
|
132
|
+
* application state management for that purpose.
|
|
133
|
+
*/
|
|
134
|
+
tabMetadata?: {
|
|
135
|
+
[key: string]: string | boolean | number;
|
|
136
|
+
};
|
|
129
137
|
}
|
|
130
138
|
export interface MynahUITabStoreTab {
|
|
131
139
|
/**
|
package/docs/DATAMODEL.md
CHANGED
|
@@ -108,6 +108,12 @@ interface MynahUIDataModel {
|
|
|
108
108
|
* Tab content header details, only visibile when showTabHeaderDetails is set to 'true'
|
|
109
109
|
*/
|
|
110
110
|
tabHeaderDetails?: TabHeaderDetails | null;
|
|
111
|
+
/**
|
|
112
|
+
* A lightweight key-value store for essential tab-specific primitive metadata.
|
|
113
|
+
* Not intended for storing large amounts of data - use appropriate
|
|
114
|
+
* application state management for that purpose.
|
|
115
|
+
*/
|
|
116
|
+
tabMetadata?: { [key: string]: string | boolean | number };
|
|
111
117
|
}
|
|
112
118
|
```
|
|
113
119
|
|
|
@@ -909,6 +915,28 @@ mynahUI.updateStore('tab-1', {
|
|
|
909
915
|
|
|
910
916
|
---
|
|
911
917
|
|
|
918
|
+
### `tabMetaData` (default: `{}`)
|
|
919
|
+
|
|
920
|
+
A lightweight key-value store for essential tab-specific metadata. Not intended for storing large amounts of data - use appropriate application state management for that purpose.
|
|
921
|
+
|
|
922
|
+
```typescript
|
|
923
|
+
const mynahUI = new MynahUI({
|
|
924
|
+
tabs: {
|
|
925
|
+
'tab-1': {
|
|
926
|
+
...
|
|
927
|
+
}
|
|
928
|
+
}
|
|
929
|
+
});
|
|
930
|
+
|
|
931
|
+
mynahUI.updateStore('tab-1', {
|
|
932
|
+
tabMetaData: {
|
|
933
|
+
'test': 'hi'
|
|
934
|
+
}
|
|
935
|
+
})
|
|
936
|
+
```
|
|
937
|
+
|
|
938
|
+
---
|
|
939
|
+
|
|
912
940
|
### `chatItems` (default: `[]`)
|
|
913
941
|
|
|
914
942
|
This is holding the chat items. If you provide it through the `defaults` or inside a tab item in the initial `tabs` property in the [Constructor properties](./PROPERTIES.md) you can give the whole set.
|
package/package.json
CHANGED