@oracle/oraclejet-core-pack 16.1.3 → 17.0.0

package/oj-c/MenuButton.json

@@ -40,7 +40,7 @@
     ],
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "ojmodule": "menu-button"
   },
@@ -55,7 +55,7 @@
     "description": "Text to show in the button.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "defaultvalue": "\"\"",
     "type": {
@@ -75,7 +75,7 @@
     "description": "Suffix appended to menu label to indicate last selection.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "type": {
       "names": [
@@ -94,7 +94,7 @@
     "description": "Text to show in the tooltip. This overrides the default tooltip that renders the label when in icon mode.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "type": {
       "names": [
@@ -113,7 +113,7 @@
     "description": "<table>\n<tr><th>Type</th><th>Def</th></tr>\n<tr><td>MenuSeparator</td><td>{ type: 'separator'}</td></tr>\n<tr><td>MenuItem</td><td>{\ntype?: 'item';\nlabel: string;\nkey: string;\ndisabled?: boolean;\nonAction?: () => void;\nstartIcon?: MenuIcon;\nendIcon?: MenuIcon;\nvariant?: 'standard' | 'destructive';\n};</td></tr>\n<tr><td>MenuSubMenu</td><td>{\ntype: 'submenu';\nlabel?: string;\ndisabled?: boolean;\nstartIcon?: string;\nitems?: Array&lt;MenuItems&gt;;\n};</td></tr>\n<tr><td>MenuSelectSingle</td><td>{\ntype: 'selectsingle';\nkey?: string;\nitems?: Array&lt;MenuSelectItem&gt;;\n};</td></tr>\n<tr><td>MenuSelectMultiple</td><td>{\ntype: 'selectmultiple';\nkey?: string;\nitems?: Array&lt;MenuSelectItem&gt;;\n};</td></tr>\n<tr><td>MenuIcon</td><td>{\ntype?: 'class';\n    class: string;\n  }\n| {\n    type: 'img';\n   src: string;\n  };</td></tr>\n<tr><td>MenuSelectItem</td><td>{\nlabel: string;\ndisabled?: boolean;\nendIcon?: MenuIcon;\nvalue: string;\n}</td></tr>\n</table>",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "defaultvalue": "[]",
     "type": {
@@ -141,20 +141,13 @@
     "description": "An array containing key/value objects for menu selection groups.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "type": {
       "names": [
         "object"
       ]
-    },
-    "tstype": [
-      {
-        "target": "Type",
-        "value": "Readonly<Record<string, MenuSelection>>",
-        "jsdocOverride": true
-      }
-    ]
+    }
   },
   {
     "memberof": "oj-c.MenuButton",
@@ -167,7 +160,7 @@
     "description": "Display just the label, the icons, or all. Label is used as tooltip and should be set in all cases.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "ojvalues": [
       {
@@ -221,7 +214,7 @@
     "description": "Specifies that the button element should be disabled.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "defaultvalue": false,
     "type": {
@@ -241,9 +234,19 @@
     "description": "Size of button",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "ojvalues": [
+      {
+        "name": "xs",
+        "description": "Display an extra small button.  Only suppported for component developers with ghost chroming in icon display mode.",
+        "displayName": "Extra Small",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
       {
         "name": "sm",
         "description": "Display a small button.",
@@ -278,6 +281,7 @@
     "defaultvalue": "\"md\"",
     "type": {
       "names": [
+        "\"xs\"",
         "\"sm\"",
         "\"md\"",
         "\"lg\""
@@ -295,20 +299,13 @@
     "description": "Specifies that the button style width",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "type": {
       "names": [
         "number|string"
       ]
-    },
-    "tstype": [
-      {
-        "target": "Type",
-        "value": "Size",
-        "jsdocOverride": true
-      }
-    ]
+    }
   },
   {
     "memberof": "oj-c.MenuButton",
@@ -321,9 +318,19 @@
     "description": "Indicates in what states the button has chromings in background and border.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "ojvalues": [
+      {
+        "name": "ghost",
+        "description": "Ghost buttons are the least prominent variation. Ghost buttons are useful for performing low-priority tasks, such as manipulating the UI.",
+        "displayName": "Ghost",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
       {
         "name": "borderless",
         "description": "Borderless buttons are a more prominent variation. Borderless buttons are useful for supplemental actions that require minimal emphasis.",
@@ -359,6 +366,7 @@
     "type": {
       "names": [
         "\"solid\"",
+        "\"ghost\"",
         "\"borderless\"",
         "\"outlined\""
       ]
@@ -374,7 +382,7 @@
     "ojhidden": true,
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "returns": [
@@ -397,7 +405,7 @@
     "ojhidden": true,
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "returns": [
@@ -419,7 +427,7 @@
     "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "params": [
@@ -453,7 +461,7 @@
     "description": "Retrieves the value of a property or a subproperty.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "params": [
@@ -482,7 +490,7 @@
     "description": "Performs a batch set of properties.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "params": [
@@ -511,13 +519,13 @@
     "description": "Triggered when a menu item is clicked, whether by keyboard, mouse, or touch events. Detail indicates which menu item was clicked.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "properties": [
       {
         "name": "key",
-        "optional": true,
+        "optional": false,
         "type": {
           "names": [
             "string"
@@ -535,7 +543,7 @@
     "description": "The startIcon slot is the button's start icon. The oj-c-menu-button element accepts DOM nodes as children with the startIcon slot.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "ojchild": false,
@@ -550,7 +558,7 @@
     "description": "The endIcon slot is the button's end icon. The oj-c-menu-button element accepts DOM nodes as children with the endIcon slot.",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "scope": "instance",
     "ojchild": false,
@@ -565,7 +573,7 @@
     "memberof": "oj-c.MenuButton",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "ojfragment": true
   },
@@ -578,7 +586,7 @@
     "memberof": "oj-c.MenuButton",
     "meta": {
       "filename": "menu-button.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/menu-button"
+      "path": "web/components/oj-c/menu-button"
     },
     "ojfragment": true
   }

package/oj-c/MessageBanner.json

@@ -60,7 +60,7 @@
     ],
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "ojmodule": "message-banner"
   },
@@ -75,7 +75,7 @@
     "description": "<p>Data for the Message Banner component. This data is used for rendering each banner message.\nThis is a required attribute. If an application needs to initialize the component with\nno initial messages, it would need to provide an empty DataProvider. When the application\nwants to show messages, it can then add new data to the existing DataProvider.\nSee <a href=\"MutableArrayDataProvider.html\">MutableArrayDataProvider</a> for more details.</p>\n\n<p>When specifying a DataProvider for the data attribute, you need to provide the keyAttributes\nfor the DataProvider. The oj-c-message-banner component expects a single attribute of type\nstring or number as the key of the DataProvider. When the data is updated this key attribute\nwill be used to determine whether a new message is being added or an existing message is being\nupdated. This is required for performing necessary animations. When the application replaces\nthe DataProvider, the component assumes that all the messages are newly added irrespective of their\nkeys and performs animation accordingly.</p>",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "type": {
       "names": [
@@ -101,7 +101,7 @@
     "description": "A Banner message can have a different look and feel. For example, when using page-level\nmessaging the messages need to be rendered from edge to edge without any outline. On the other\nhand, when they are being used in a section of a page or a dialog, they need to be rendered\nwith an outline. This attribute can be used to specify where the component is being used so that\nit will render the messages accordingly.",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "ojvalues": [
       {
@@ -141,10 +141,11 @@
     "longname": "oj-c.MessageBanner#detailTemplateValue",
     "optional": true,
     "scope": "instance",
-    "description": "Applications can use this property to provide the name of a template or a function that\nreturns the name of a template to use for rendering the detail content.\n\nWhen a template name is provided as a value for this property, the corresponding template\nwill be used for rendering the detail content for all the messages. If applications want\nto use a different template for different messages, they can provide a function that\nreturns a template name instead.\n\nThe provided function should accept an object of type MessageBannerTemplateValueParameters\nand return a key to a template for rendering the corresponding message's detail content.\nThe value returned from this function should be a key to one of the dynamic template slots\nprovided. If the returned value is not one of the keys of the provided dynamic template slots,\nthe component will throw an Error.\n\nIf the function returns undefined, the component then will perform default rendering\nof the detail content using the detail property of the corresponding message.\n\nIf an application specifies both detail and a valid detail-template-value, the detail-template-value\nwill take precedence and the corresponding template will be used for rendering the detail content.",
+    "description": "Applications can use this property to provide the name of a template or a function that\nreturns the name of a template to use for rendering the detail content.\n\nWhen a template name is provided as a value for this property, the corresponding template\nwill be used for rendering the detail content for all the messages. If applications want\nto use a different template for different messages, they can provide a function that\nreturns a template name instead.\n\nThe provided function should accept an object of type MessageBannerTemplateValueParameters\nand return a key to a template for rendering the corresponding message's detail content.\nThe value returned from this function should be a key to one of the dynamic template slots\nprovided. If the returned value is not one of the keys of the provided dynamic template slots,\nthe component will throw an Error.\n\nIf the function returns undefined, the component then will perform default rendering\nof the detail content using the detail property of the corresponding message.\n\nIf an application specifies both detail and a valid detail-template-value, the detail-template-value\nwill take precedence and the corresponding template will be used for rendering the detail content.<p><span style=\"font-weight: bold\">Note:</span> For additional information see <a href=\"#DynamicSlots.MessageBannerTemplateContext\">DynamicSlots.MessageBannerTemplateContext</a>.</p>",
+    "dynamicSlotDef": "MessageBannerTemplateContext",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "type": {
       "names": [
@@ -159,6 +160,49 @@
       }
     ]
   },
+  {
+    "memberof": "oj-c.MessageBanner",
+    "id": "oj-c.MessageBanner#sorting",
+    "name": "sorting",
+    "kind": "member",
+    "longname": "oj-c.MessageBanner#sorting",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies how to sort the messages from the dataprovider.",
+    "meta": {
+      "filename": "message-banner.tsx",
+      "path": "web/components/oj-c/message-banner"
+    },
+    "ojvalues": [
+      {
+        "name": "severity",
+        "description": "Sort the messages in the decreasing order of severity: error, warning, info, confirmation, and none. Then sort the messages of the same severity in reverse chronological order using the timestamp property.",
+        "displayName": "Severity",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "off",
+        "description": "Messages appear in the order they are supplied with no additional sorting.",
+        "displayName": "Off",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"severity\"",
+    "type": {
+      "names": [
+        "\"off\"",
+        "\"severity\""
+      ]
+    }
+  },
   {
     "memberof": "oj-c.MessageBanner",
     "id": "oj-c.MessageBanner#setProperty",
@@ -168,7 +212,7 @@
     "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "scope": "instance",
     "params": [
@@ -202,7 +246,7 @@
     "description": "Retrieves the value of a property or a subproperty.",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "scope": "instance",
     "params": [
@@ -231,7 +275,7 @@
     "description": "Performs a batch set of properties.",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "scope": "instance",
     "params": [
@@ -260,7 +304,7 @@
     "description": "Triggered when a user tries to close a message through UI interaction. The application\nshould listen to this event and remove the corresponding message item from the data\nwhich would then result in the message being closed. If the application\nfails to remove the message item from the data, then no change will be done in the\nUI by the component and the message will stay in the UI opened.",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "scope": "instance",
     "properties": [
@@ -323,6 +367,82 @@
       }
     ]
   },
+  {
+    "memberof": "oj-c.MessageBanner",
+    "dynamicSlot": true,
+    "id": "oj-c.MessageBanner#DynamicSlots.MessageBannerTemplateContext",
+    "name": "DynamicSlots.MessageBannerTemplateContext",
+    "kind": "member",
+    "longname": "oj-c.MessageBanner#DynamicSlots.MessageBannerTemplateContext",
+    "description": "Structure of template context used for dynamic templates \n    <p><span style=\"font-weight: bold\">Note:</span> For additional information see <a href=\"#detailTemplateValue\">detail-template-value</a>.</p>",
+    "meta": {
+      "filename": "message-banner.tsx",
+      "path": "web/components/oj-c/message-banner"
+    },
+    "scope": "instance",
+    "ojchild": false,
+    "ojslot": true,
+    "ojtemplateslotprops": "MessageBannerTemplateContext",
+    "properties": [
+      {
+        "name": "data",
+        "description": "The data for the current message",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "D",
+            "for": "data",
+            "jsdocOverride": true
+          }
+        ]
+      },
+      {
+        "name": "key",
+        "description": "The key for the current message",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "K",
+            "for": "key",
+            "jsdocOverride": true
+          }
+        ]
+      },
+      {
+        "name": "metadata",
+        "description": "The metadata for the current message",
+        "optional": false,
+        "type": {
+          "names": [
+            "object"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "ItemMetadata<K>",
+            "for": "metadata",
+            "jsdocOverride": true,
+            "module": {
+              "ItemMetadata": "ojdataprovider"
+            }
+          }
+        ]
+      }
+    ]
+  },
   {
     "id": "oj-c.MessageBanner.keyboardDoc",
     "name": "keyboardDoc",
@@ -332,7 +452,7 @@
     "memberof": "oj-c.MessageBanner",
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "ojfragment": true
   },
@@ -351,7 +471,7 @@
     },
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "properties": [
       {
@@ -441,7 +561,7 @@
     },
     "meta": {
       "filename": "message-banner.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/message-banner"
+      "path": "web/components/oj-c/message-banner"
     },
     "properties": [
       {
@@ -452,7 +572,15 @@
           "names": [
             "any"
           ]
-        }
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "D",
+            "for": "data",
+            "jsdocOverride": true
+          }
+        ]
       },
       {
         "name": "key",
@@ -462,7 +590,15 @@
           "names": [
             "any"
           ]
-        }
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "K",
+            "for": "key",
+            "jsdocOverride": true
+          }
+        ]
       },
       {
         "name": "metadata",
@@ -472,7 +608,18 @@
           "names": [
             "object"
           ]
-        }
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "ItemMetadata<K>",
+            "for": "metadata",
+            "jsdocOverride": true,
+            "module": {
+              "ItemMetadata": "ojdataprovider"
+            }
+          }
+        ]
       }
     ]
   }