@aws/mynah-ui 4.24.0 → 4.25.0

package/dist/static.d.ts

@@ -30,6 +30,14 @@ export interface MynahUIDataModel {
      * Tab title
      * */
     tabTitle?: string;
+    /**
+     * Tab icon
+     * */
+    tabIcon?: MynahIcons | MynahIconsType | null;
+    /**
+     * is tab pinned
+     * */
+    pinned?: boolean;
     /**
      * Tab title
      * */
@@ -101,7 +109,7 @@ export interface MynahUIDataModel {
     /**
     * List of chat item objects to be shown on the web suggestions search screen
     */
-    chatItems?: ChatItem[];
+    chatItems?: Array<ChatItem | InformationItemGroup>;
     /**
      * Attached code under the prompt input field
      */
@@ -201,6 +209,20 @@ export declare enum ChatItemType {
     ANSWER_PART = "answer-part",
     CODE_RESULT = "code-result"
 }
+export interface InformationItemGroup {
+    title?: string;
+    icon?: MynahIcons | MynahIconsType;
+    children: InformationItem[];
+}
+export interface InformationItem {
+    messageId?: string;
+    icon?: MynahIcons | MynahIconsType;
+    title?: string;
+    description?: string;
+    actions?: ChatItemButton[];
+    active?: boolean;
+    clickable?: boolean;
+}
 export type Status = 'info' | 'success' | 'warning' | 'error';
 export interface ProgressField {
     /**

package/docs/DATAMODEL.md

@@ -12,6 +12,14 @@ interface MynahUIDataModel {
    * Tab title
    * */
   tabTitle?: string;
+  /**
+   * Tab icon
+   * */
+  tabIcon?: MynahIcons | MynahIconsType | null;
+  /**
+   * is tab pinned
+   * */
+  pinned?: boolean;
   /**
    * Tab title
    * */
@@ -83,7 +91,7 @@ interface MynahUIDataModel {
   /**
   * List of chat item objects to be shown on the web suggestions search screen
   */
-  chatItems?: ChatItem[];
+  chatItems?: Array<ChatItem | InformationItemGroup>;
   /**
    * Attached code under the prompt input field
    */
@@ -124,6 +132,57 @@ mynahUI.updateStore('tab-1', {
 })
 ```
 
+### `tabIcon` (default: undefined)
+Basically it is an icon you can give to the tab.
+
+```typescript
+const mynahUI = new MynahUI({
+    tabs: {
+        'tab-1': {
+            ...
+        }
+    }
+});
+
+mynahUI.updateStore('tab-1', {
+    tabTitle: '',
+    tabIcon: MynahIcons.MENU,
+    pinned: true
+})
+```
+
+### 
+
+<p align="center">
+  <img src="./img/data-model/tabStore/pinnedTab.png" alt="pinnedTab" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
+</p>
+
+
+### `pinned` (default: `false`)
+You can pin the tabs to the beginning. But when you pin a tab, end user cannot close them anymore. It will disable the middle mouse click to close a tab and remove the close button too. The tab will be basically pinned.
+
+```typescript
+const mynahUI = new MynahUI({
+    tabs: {
+        'tab-1': {
+            ...
+        }
+    }
+});
+
+mynahUI.updateStore('tab-1', {
+    tabTitle: '',
+    tabIcon: MynahIcons.MENU,
+    pinned: true
+})
+```
+
+### 
+
+<p align="center">
+  <img src="./img/data-model/tabStore/pinnedTab.png" alt="pinnedTab" style="max-width:500px; width:100%;border: 1px solid #e0e0e0;">
+</p>
+
 ### `tabBackground` (default: `false`)
 Shows or hides the gradient background on the tab.
 
@@ -856,6 +915,8 @@ This is holding the chat items. If you provide it through the `defaults` or insi
 
 **BUT** if you will set it through `updateStore` it will append the items in the list to the current chatItems list. In case if you need to update the list with a new one manually on runtime, you need to send an empty list first and than send the desired new list.
 
+ChatItems will either be of type `ChatItem` or `InformationItemGroup`. An `InformationItemGroup` can hold one or more `InformationItem` objects. This means that if you would like to just access the ChatItems in a tab, you should filter out the InformationItemGroups first.
+
 ```typescript
 const mynahUI = new MynahUI({
     tabs: {
@@ -2756,4 +2817,28 @@ export interface ChatPrompt {
   command?: string;
   context?: string[];
 }
+```
+
+---
+
+# `InformationItem`
+
+Information items can be rendered in an `InformationItemGroup` within the `chatItems?` array. These items are full width information displays, with an optional icon on the left, and room for a title, description, and a list of actions.
+
+```typescript
+export interface InformationItemGroup {
+  title?: string;
+  icon?: MynahIcons | MynahIconsType;
+  children: InformationItem[];
+}
+
+export interface InformationItem {
+  messageId?: string;
+  icon?: MynahIcons | MynahIconsType;
+  title?: string;
+  description?: string;
+  actions?: ChatItemButton[];
+  active?: boolean;
+  clickable?: boolean;
+}
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@aws/mynah-ui",
     "displayName": "AWS Mynah UI",
-    "version": "4.24.0",
+    "version": "4.25.0",
     "description": "AWS Toolkit VSCode and Intellij IDE Extension Mynah UI",
     "publisher": "Amazon Web Services",
     "license": "Apache License 2.0",