@aws/mynah-ui 4.16.0 → 4.16.1

package/docs/DATAMODEL.md

@@ -1,10 +1,10 @@
 # MynahUI Data Model (with how the things appear on screen)
 
-There are few models for different items on the screen for mynah ui. Let's star from the top and go in detail one by one.
+There are a number of models for the various items on the screen for MynahUI. Let's start from the top and go in detail one-by-one.
 
 ## Tab Data Store
 
-All information you can set related with a tab. 
+All information you can set related to a tab. 
 
 ```typescript
 interface MynahUIDataModel {
@@ -61,6 +61,10 @@ interface MynahUIDataModel {
   */
   promptInputDisabledState?: boolean;
   /**
+  * Prompt input progress field
+  */
+  promptInputProgress?: ProgressField | null;
+  /**
   * List of chat item objects to be shown on the web suggestions search screen
   */
   chatItems?: ChatItem[];
@@ -440,6 +444,46 @@ mynahUI.updateStore('tab-1', {
 
 ---
 
+### `promptInputProgress`
+
+This determines whether the progress bar shows up, and what its styling and progress value is. The `value` should be a number representing the progress, and the `valueText` is the text that shows right next to the regular `text` to indicate the progress in the bar. A number of `actions` can be added to dispatch events. Different statuses are available, namely: `default` | `info` | `success` | `warning` | `error`.
+
+**In progress:**
+```typescript
+mynahUI.updateStore('tab-1', {
+  promptInputProgress: {
+    status: 'default',
+    text: 'Work in progress...',
+    value: -1,
+    actions: [{
+      id: 'cancel-running-task',
+      text: 'Cancel',
+      icon: MynahIcons.CANCEL,
+      disabled: false,
+    }]
+  }
+});
+```
+
+**Completed:**
+```typescript
+mynahUI.updateStore('tab-1', {
+  promptInputProgress: {
+    status: 'success',
+    text: 'Completed...',
+    valueText: '',
+    value: 100,
+    actions: []
+  }
+});
+```
+
+<p align="center">
+  <img src="./img/data-model/tabStore/progress.png" alt="mainTitle" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
+</p>
+
+---
+
 ### `selectedCodeSnippet`
 
 This is the attached code block text right under the prompt input field..
@@ -459,7 +503,7 @@ mynahUI.updateStore('tab-1', {
             'tab-1': {
                 isSelected: true,
                 .....`,
-})
+});
 ```
 
 <p align="center">

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aws/mynah-ui",
     "displayName": "AWS Mynah UI",
-    "version": "4.16.0",
+    "version": "4.16.1",
     "description": "AWS Toolkit VSCode and Intellij IDE Extension Mynah UI",
     "publisher": "Amazon Web Services",
     "license": "Apache License 2.0",
@@ -35,7 +35,7 @@
     "dependencies": {
         "escape-html": "^1.0.3",
         "just-clone": "^6.2.0",
-        "marked": "^12.0.2",
+        "marked": "^14.1.3",
         "prismjs": "1.29.0",
         "sanitize-html": "^2.12.1",
         "unescape-html": "^1.1.0"