@oracle/oraclejet-core-pack 17.1.4 → 18.0.1

package/oj-c/Skeleton.json

@@ -0,0 +1,192 @@
+[
+  {
+    "pack": "oj-c",
+    "id": "oj-c.Skeleton",
+    "name": "Skeleton",
+    "memberof": "oj-c",
+    "longname": "oj-c.Skeleton",
+    "kind": "class",
+    "classdesc": "<h3 id=\"skeletonOverview-section\">\n  JET Skeleton\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#skeletonOverview-section\"></a>\n</h3>\n<p>Description: A skeleton gives a visual representation that content is loading. </p>\n<p>The oj-c-skeleton is a component that may be placed within the skeletonTemplate of oj-c-card-view.\n\n<pre class=\"prettyprint\">\n<code>\n&lt;oj-c-card-view\n   id=\"cardview\"\n         class=\"demo-card-view\"\n         aria-label=\"cardview with custom skeleton\"\n         data=[[dataProvider]]>\n     &lt;template slot=\"skeletonTemplate\" data-oj-as=\"context\">\n       &lt;div class=\"oj-panel oj-sm-padding-0 \n        :style=\"[[context.loadingStatus === 'initial' ? { width: '300px', height: '240px' } : { width: context.width, height: context.height } ]]\">\n           &lt;oj-c-skeleton height =\"100%\">\n           &lt;/oj-c-skeleton>\n       &lt;/div>\n     &lt;/template>\n     &lt;template data-oj-as=\"item\" slot=\"itemTemplate\">\n       &lt;div class=\"oj-panel\">\n         &lt;demo-profile-card-layout\n           name=\"[[item.data.name]]\"\n           initials=\"[[item.data.initials]]\"\n         >\n         &lt;/demo-profile-card-layout>\n       &lt;/div>\n     &lt;/template>\n&lt;/oj-c-card-view>\n</code></pre>",
+    "scope": "static",
+    "tagWithoutBrackets": "oj-c-skeleton",
+    "tagWithBrackets": "<oj-c-skeleton>",
+    "domInterface": "CSkeletonElement",
+    "ojPageTitle": "&lt;oj-c-skeleton>",
+    "ojcomponent": true,
+    "isvcomponent": true,
+    "camelCaseName": "Skeleton",
+    "ojPageTitlePrefix": "Element: ",
+    "ojtsvcomponent": true,
+    "tstype": {
+      "target": "Type",
+      "value": "interface CSkeletonElement extends JetElement<SkeletonElementSettableProperties>"
+    },
+    "ojsignature": [
+      {
+        "target": "Type",
+        "value": "interface CSkeletonElement extends JetElement<SkeletonElementSettableProperties>"
+      }
+    ],
+    "since": "18.0.0",
+    "tsdeprecated": [
+      {
+        "type": "candidate",
+        "since": "18.0.0"
+      }
+    ],
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "ojmodule": "skeleton"
+  },
+  {
+    "memberof": "oj-c.Skeleton",
+    "id": "oj-c.Skeleton#height",
+    "name": "height",
+    "kind": "member",
+    "longname": "oj-c.Skeleton#height",
+    "optional": false,
+    "scope": "instance",
+    "description": "Specifies the height of the skeleton",
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "type": {
+      "names": [
+        "number|string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Skeleton",
+    "id": "oj-c.Skeleton#width",
+    "name": "width",
+    "kind": "member",
+    "longname": "oj-c.Skeleton#width",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the width of the skeleton",
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "type": {
+      "names": [
+        "number|string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Skeleton",
+    "id": "oj-c.Skeleton#borderRadius",
+    "name": "borderRadius",
+    "kind": "member",
+    "longname": "oj-c.Skeleton#borderRadius",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the border radius of the skeleton",
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "type": {
+      "names": [
+        "number|string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Skeleton",
+    "id": "oj-c.Skeleton#setProperty",
+    "name": "setProperty",
+    "kind": "function",
+    "longname": "oj-c.Skeleton#setProperty",
+    "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "property",
+        "description": "The property name to set. Supports dot notation for subproperty access.",
+        "type": "string"
+      },
+      {
+        "name": "value",
+        "description": "The new value to set the property to.",
+        "type": "any"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Skeleton",
+    "id": "oj-c.Skeleton#getProperty",
+    "name": "getProperty",
+    "kind": "function",
+    "longname": "oj-c.Skeleton#getProperty",
+    "description": "Retrieves the value of a property or a subproperty.",
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "property",
+        "description": "The property name to get. Supports dot notation for subproperty access.",
+        "type": "string"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Skeleton",
+    "id": "oj-c.Skeleton#setProperties",
+    "name": "setProperties",
+    "kind": "function",
+    "longname": "oj-c.Skeleton#setProperties",
+    "description": "Performs a batch set of properties.",
+    "meta": {
+      "filename": "skeleton.tsx",
+      "path": "web/components/oj-c/skeleton"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "properties",
+        "description": "An object containing the property and value pairs to set.",
+        "type": "object"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  }
+]

package/oj-c/SplitMenuButton.json

@@ -53,7 +53,6 @@
       "filename": "split-menu-button.tsx",
       "path": "web/components/oj-c/split-menu-button"
     },
-    "defaultvalue": "\"\"",
     "type": {
       "names": [
         "string"
@@ -255,12 +254,11 @@
   },
   {
     "memberof": "oj-c.SplitMenuButton",
-    "id": "oj-c.SplitMenuButton#blur",
-    "name": "blur",
+    "id": "oj-c.SplitMenuButton#focus",
+    "name": "focus",
     "kind": "function",
-    "longname": "oj-c.SplitMenuButton#blur",
-    "description": "blurs the button",
-    "ojhidden": true,
+    "longname": "oj-c.SplitMenuButton#focus",
+    "description": "",
     "meta": {
       "filename": "split-menu-button.tsx",
       "path": "web/components/oj-c/split-menu-button"
@@ -270,7 +268,7 @@
       {
         "type": {
           "names": [
-            "any"
+            "void"
           ]
         }
       }
@@ -278,12 +276,11 @@
   },
   {
     "memberof": "oj-c.SplitMenuButton",
-    "id": "oj-c.SplitMenuButton#focus",
-    "name": "focus",
+    "id": "oj-c.SplitMenuButton#blur",
+    "name": "blur",
     "kind": "function",
-    "longname": "oj-c.SplitMenuButton#focus",
-    "description": "focuses the button",
-    "ojhidden": true,
+    "longname": "oj-c.SplitMenuButton#blur",
+    "description": "",
     "meta": {
       "filename": "split-menu-button.tsx",
       "path": "web/components/oj-c/split-menu-button"
@@ -293,7 +290,7 @@
       {
         "type": {
           "names": [
-            "any"
+            "void"
           ]
         }
       }
@@ -301,12 +298,11 @@
   },
   {
     "memberof": "oj-c.SplitMenuButton",
-    "id": "oj-c.SplitMenuButton#doAction",
-    "name": "doAction",
+    "id": "oj-c.SplitMenuButton#click",
+    "name": "click",
     "kind": "function",
-    "longname": "oj-c.SplitMenuButton#doAction",
-    "description": "invokes button action",
-    "ojhidden": true,
+    "longname": "oj-c.SplitMenuButton#click",
+    "description": "",
     "meta": {
       "filename": "split-menu-button.tsx",
       "path": "web/components/oj-c/split-menu-button"
@@ -316,7 +312,7 @@
       {
         "type": {
           "names": [
-            "any"
+            "void"
           ]
         }
       }

package/oj-c/TabBar.json

@@ -62,7 +62,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "Array<oj-c.TabBar.TabData<string | number>>|DataProvider<K, oj-c.TabBar.TabData<K>>",
+        "value": "Array<oj-c.TabBar.TabData<string | number>|oj-c.TabBar.TabLinkItemData<string | number>>|DataProvider<K, oj-c.TabBar.TabData<K> | oj-c.TabBar.TabLinkItemData<K>>",
         "jsdocOverride": true,
         "module": {
           "DataProvider": "ojdataprovider"
@@ -86,7 +86,7 @@
     },
     "type": {
       "names": [
-        "any"
+        "string|number"
       ]
     },
     "tstype": [
@@ -280,6 +280,27 @@
       ]
     }
   },
+  {
+    "memberof": "oj-c.TabBar",
+    "id": "oj-c.TabBar#truncation",
+    "name": "truncation",
+    "kind": "member",
+    "longname": "oj-c.TabBar#truncation",
+    "optional": true,
+    "scope": "instance",
+    "description": "Truncation applies to the tab labels when there is not enough room to display all tabs.",
+    "meta": {
+      "filename": "tab-bar.tsx",
+      "path": "web/components/oj-c/tab-bar"
+    },
+    "defaultvalue": "\"none\"",
+    "type": {
+      "names": [
+        "\"none\"",
+        "\"progressive\""
+      ]
+    }
+  },
   {
     "memberof": "oj-c.TabBar",
     "id": "oj-c.TabBar#_doReorderHelper",
@@ -428,7 +449,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -460,7 +481,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -493,7 +514,7 @@
         "optional": false,
         "type": {
           "names": [
-            "Array<any>"
+            "Array<string|number>"
           ]
         },
         "tstype": [
@@ -525,7 +546,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -542,7 +563,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -611,7 +632,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -706,5 +727,130 @@
         }
       }
     ]
+  },
+  {
+    "memberof": "oj-c.TabBar",
+    "id": "oj-c.TabBar.TabLinkItemData",
+    "name": "TabLinkItemData",
+    "kind": "typedef",
+    "longname": "oj-c.TabBar.TabLinkItemData",
+    "scope": "static",
+    "description": "The data item object that represents a tab with link. Note: Do not use with <code class=\"prettyprint\"> overflow=\"popup\"</code> as links are currently not supported in overflow items inside a popup.",
+    "tsgenerictype": {
+      "target": "Type",
+      "value": "<K extends string | number>",
+      "for": "genericTypeParameters"
+    },
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "tab-bar.tsx",
+      "path": "web/components/oj-c/tab-bar"
+    },
+    "properties": [
+      {
+        "name": "itemKey",
+        "description": "Key of the TabBarItem",
+        "optional": false,
+        "type": {
+          "names": [
+            "string|number"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "K",
+            "jsdocOverride": true,
+            "for": "itemKey"
+          }
+        ]
+      },
+      {
+        "name": "label",
+        "description": "Label of the TabBarItem. For icon only display this label is the content\nfor aria-label and tooltip text of the Tab.",
+        "optional": false,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "icon",
+        "description": "The icon before the label in non-stack case, icon above the label in\nstacked case or the stand alone icon when no label is specified.",
+        "optional": true,
+        "type": {
+          "names": [
+            "object"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }",
+            "jsdocOverride": true,
+            "for": "icon"
+          }
+        ]
+      },
+      {
+        "name": "badge",
+        "description": "The content to be rendered inside the Badge component.",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      },
+      {
+        "name": "metadata",
+        "description": "The content to be rendered inside the Text component as a metadata,\nthat appears after the label in non stack case only.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "severity",
+        "description": "The status icon to be rendered after the label in non stack case only.",
+        "optional": true,
+        "type": {
+          "names": [
+            "\"none\"",
+            "\"error\"",
+            "\"confirmation\"",
+            "\"info\"",
+            "\"warning\""
+          ]
+        }
+      },
+      {
+        "name": "tabPanelId",
+        "description": "Accepts the tabpanel element's ID associated with the tab item",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "href",
+        "description": "Sets the URL that the hyperlink points to. If there is no valid URL use \"#\" for href value to navigate to the top of the page.",
+        "optional": false,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ]
   }
 ]

package/oj-c/TabBarMixed.json

@@ -30,7 +30,7 @@
     "since": "16.1.0",
     "tsdeprecated": [
       {
-        "type": "candidate",
+        "type": "production",
         "since": "17.0.0"
       }
     ],
@@ -192,7 +192,7 @@
     },
     "type": {
       "names": [
-        "any"
+        "string|number"
       ]
     },
     "tstype": [
@@ -409,7 +409,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -441,7 +441,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -473,7 +473,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -490,7 +490,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [
@@ -584,7 +584,7 @@
         "optional": false,
         "type": {
           "names": [
-            "any"
+            "string|number"
           ]
         },
         "tstype": [