@oracle/oraclejet-core-pack 17.0.4 → 17.1.0

package/oj-c/Button.json

@@ -191,7 +191,7 @@
     "ojvalues": [
       {
         "name": "xs",
-        "description": "Display an extra small button.  Only suppported for component developers with ghost chroming in icon display mode.",
+        "description": "Display an extra small button.  Only supported for component developers with ghost chroming in icon display mode.",
         "displayName": "Extra Small",
         "type": {
           "names": [

package/oj-c/ButtonsetMultiple.json

@@ -30,7 +30,7 @@
     "since": "17.0.0",
     "tsdeprecated": [
       {
-        "type": "supersedes",
+        "type": "candidate",
         "since": "17.0.0",
         "value": [
           "oj-buttonset-many"
@@ -71,7 +71,7 @@
     "longname": "oj-c.ButtonsetMultiple#items",
     "optional": true,
     "scope": "instance",
-    "description": "<table class=\"props\">\n<tr><th>Type</th><th>Def</th></tr>\n<tr><td>ToggleIcon</td><td>{\ntype?: 'class';\n    class: string;\n  }\n| {\n    type: 'img';\n   src: string;\n  };</td></tr>\n</table>",
+    "description": "Specifies the toggle buttons rendered by the buttonset.",
     "meta": {
       "filename": "buttonset-multiple.tsx",
       "path": "web/components/oj-c/buttonset-multiple"
@@ -539,9 +539,9 @@
         "tstype": [
           {
             "target": "Type",
-            "value": "ToggleIcon",
-            "for": "startIcon",
-            "jsdocOverride": true
+            "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }",
+            "jsdocOverride": true,
+            "for": "startIcon"
           }
         ]
       },
@@ -556,9 +556,9 @@
         "tstype": [
           {
             "target": "Type",
-            "value": "ToggleIcon",
-            "for": "endIcon",
-            "jsdocOverride": true
+            "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }",
+            "jsdocOverride": true,
+            "for": "endIcon"
           }
         ]
       }

package/oj-c/ButtonsetSingle.json

@@ -30,7 +30,7 @@
     "since": "17.0.0",
     "tsdeprecated": [
       {
-        "type": "supersedes",
+        "type": "candidate",
         "since": "17.0.0",
         "value": [
           "oj-buttonset-one"
@@ -71,7 +71,7 @@
     "longname": "oj-c.ButtonsetSingle#items",
     "optional": true,
     "scope": "instance",
-    "description": "<table class=\"props\">\n<tr><th>Type</th><th>Def</th></tr>\n<tr><td>ToggleIcon</td><td>{\ntype?: 'class';\n    class: string;\n  }\n| {\n    type: 'img';\n   src: string;\n  };</td></tr>\n</table>",
+    "description": "Specifies the toggle buttons rendered by the buttonset.",
     "meta": {
       "filename": "buttonset-single.tsx",
       "path": "web/components/oj-c/buttonset-single"
@@ -539,9 +539,9 @@
         "tstype": [
           {
             "target": "Type",
-            "value": "ToggleIcon",
-            "for": "startIcon",
-            "jsdocOverride": true
+            "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }",
+            "jsdocOverride": true,
+            "for": "startIcon"
           }
         ]
       },
@@ -556,9 +556,9 @@
         "tstype": [
           {
             "target": "Type",
-            "value": "ToggleIcon",
-            "for": "endIcon",
-            "jsdocOverride": true
+            "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }",
+            "jsdocOverride": true,
+            "for": "endIcon"
           }
         ]
       }

package/oj-c/CardView.json

@@ -63,7 +63,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "ReadOnlyPropertyChanged",
+        "value": "K",
         "jsdocOverride": true
       }
     ]
@@ -91,7 +91,10 @@
       {
         "target": "Type",
         "value": "DataProvider<K, D>|null",
-        "jsdocOverride": true
+        "jsdocOverride": true,
+        "module": {
+          "DataProvider": "ojdataprovider"
+        }
       }
     ]
   },
@@ -202,7 +205,17 @@
       "names": [
         "object"
       ]
-    }
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "ImmutableKeySet<K>",
+        "jsdocOverride": true,
+        "module": {
+          "ImmutableKeySet": "ojkeyset"
+        }
+      }
+    ]
   },
   {
     "memberof": "oj-c.CardView",
@@ -497,8 +510,8 @@
           {
             "target": "Type",
             "value": "Array<K>",
-            "for": "reorderedKeys",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "reorderedKeys"
           }
         ]
       },
@@ -515,8 +528,8 @@
           {
             "target": "Type",
             "value": "Array<K>",
-            "for": "itemKeys",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "itemKeys"
           }
         ]
       },
@@ -533,8 +546,8 @@
           {
             "target": "Type",
             "value": "K|null",
-            "for": "referenceKey",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "referenceKey"
           }
         ]
       }
@@ -584,8 +597,8 @@
           {
             "target": "Type",
             "value": "D",
-            "for": "data",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "data"
           }
         ]
       },
@@ -602,8 +615,8 @@
           {
             "target": "Type",
             "value": "Item<K, D>",
-            "for": "item",
             "jsdocOverride": true,
+            "for": "item",
             "module": {
               "Item": "ojdataprovider"
             }

package/oj-c/Checkbox.json

@@ -120,7 +120,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "oj-c.Checkbox.DisplayOptions",
+        "value": "oj-c.Checkbox.DisplayOptionsProps",
         "jsdocOverride": true
       }
     ]
@@ -651,10 +651,10 @@
   },
   {
     "memberof": "oj-c.Checkbox",
-    "id": "oj-c.Checkbox.DisplayOptions",
-    "name": "DisplayOptions",
+    "id": "oj-c.Checkbox.DisplayOptionsProps",
+    "name": "DisplayOptionsProps",
     "kind": "typedef",
-    "longname": "oj-c.Checkbox.DisplayOptions",
+    "longname": "oj-c.Checkbox.DisplayOptionsProps",
     "scope": "static",
     "description": "Display options for auxiliary content that determines whether or not it should be displayed.",
     "type": {

package/oj-c/Checkboxset.json

@@ -144,7 +144,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "oj-c.Checkboxset.DisplayOptions",
+        "value": "oj-c.Checkboxset.DisplayOptionsProps",
         "jsdocOverride": true
       }
     ]
@@ -444,8 +444,11 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "Array<(CheckboxsetDataItem & { value: V; })>|DataProvider<V, D>",
-        "jsdocOverride": true
+        "value": "Array<oj-c.Checkboxset.CheckboxsetArrayDataItem<V>>|DataProvider<V, D>",
+        "jsdocOverride": true,
+        "module": {
+          "DataProvider": "ojdataprovider"
+        }
       }
     ]
   },
@@ -842,7 +845,7 @@
     "kind": "typedef",
     "longname": "oj-c.Checkboxset.CheckboxsetDataItem",
     "scope": "static",
-    "description": "The data item object that represents a checkbox in the rendered checkboxset. The label property is required and\nprovides the text for the checkbox.",
+    "description": "An object that represents the data associated with a checkbox in the rendered checkboxset. The label property is required and\nprovides the text for the checkbox.",
     "type": {
       "names": [
         "Object"
@@ -897,10 +900,10 @@
   },
   {
     "memberof": "oj-c.Checkboxset",
-    "id": "oj-c.Checkboxset.DisplayOptions",
-    "name": "DisplayOptions",
+    "id": "oj-c.Checkboxset.DisplayOptionsProps",
+    "name": "DisplayOptionsProps",
     "kind": "typedef",
-    "longname": "oj-c.Checkboxset.DisplayOptions",
+    "longname": "oj-c.Checkboxset.DisplayOptionsProps",
     "scope": "static",
     "description": "Display options for auxiliary content that determines whether or not it should be displayed.",
     "type": {
@@ -1056,5 +1059,87 @@
         }
       }
     ]
+  },
+  {
+    "memberof": "oj-c.Checkboxset",
+    "id": "oj-c.Checkboxset.CheckboxsetArrayDataItem",
+    "name": "CheckboxsetArrayDataItem",
+    "kind": "typedef",
+    "longname": "oj-c.Checkboxset.CheckboxsetArrayDataItem",
+    "scope": "static",
+    "description": "An object that represents the value and corresponding data associated with a checkbox in the rendered checkboxset.\nThe label property is required and provides the text for the checkbox.",
+    "tsgenerictype": {
+      "target": "Type",
+      "value": "<V extends string | number>",
+      "for": "genericTypeParameters"
+    },
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "checkboxset.tsx",
+      "path": "web/components/oj-c/checkboxset"
+    },
+    "properties": [
+      {
+        "name": "label",
+        "description": "The value of this required property will provide the text for the checkbox's label.",
+        "optional": false,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "assistiveText",
+        "description": "Optional value to provide guidance to the user about the checkbox this applies to.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "helpSourceLink",
+        "description": "Optional link to aid the user in the checkbox this applies to.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "helpSourceText",
+        "description": "Optional custom text to be rendered for the <code>helpSourceLink</code>.",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "value",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "V",
+            "jsdocOverride": true,
+            "for": "value"
+          }
+        ]
+      }
+    ]
   }
 ]

package/oj-c/Collapsible.json

@@ -293,8 +293,8 @@
           {
             "target": "Type",
             "value": "EventTarget|null",
-            "for": "target",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "target"
           }
         ]
       }
@@ -334,8 +334,8 @@
           {
             "target": "Type",
             "value": "EventTarget|null",
-            "for": "target",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "target"
           }
         ]
       }
@@ -366,8 +366,8 @@
           {
             "target": "Type",
             "value": "EventTarget|null",
-            "for": "target",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "target"
           }
         ]
       }
@@ -398,8 +398,8 @@
           {
             "target": "Type",
             "value": "EventTarget|null",
-            "for": "target",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "target"
           }
         ]
       }

package/oj-c/ConveyorBelt.json

@@ -105,8 +105,11 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "Array<ConveyorBeltArrayDataItem<K, D>>|DataProvider<K, D>",
-        "jsdocOverride": true
+        "value": "Array<oj-c.ConveyorBelt.ConveyorBeltArrayDataItem<K, D>>|DataProvider<K, D>",
+        "jsdocOverride": true,
+        "module": {
+          "DataProvider": "ojdataprovider"
+        }
       }
     ]
   },
@@ -294,8 +297,8 @@
           {
             "target": "Type",
             "value": "D",
-            "for": "data",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "data"
           }
         ]
       },
@@ -312,8 +315,8 @@
           {
             "target": "Type",
             "value": "Item<K, D>",
-            "for": "item",
             "jsdocOverride": true,
+            "for": "item",
             "module": {
               "Item": "ojdataprovider"
             }
@@ -321,5 +324,64 @@
         ]
       }
     ]
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt.ConveyorBeltArrayDataItem",
+    "name": "ConveyorBeltArrayDataItem",
+    "kind": "typedef",
+    "longname": "oj-c.ConveyorBelt.ConveyorBeltArrayDataItem",
+    "scope": "static",
+    "description": "",
+    "tsgenerictype": {
+      "target": "Type",
+      "value": "<K,D>",
+      "for": "genericTypeParameters"
+    },
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "properties": [
+      {
+        "name": "data",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "D",
+            "jsdocOverride": true,
+            "for": "data"
+          }
+        ]
+      },
+      {
+        "name": "key",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "K",
+            "jsdocOverride": true,
+            "for": "key"
+          }
+        ]
+      }
+    ]
   }
 ]

package/oj-c/DatePicker.json

@@ -30,8 +30,11 @@
     "since": "17.0.0",
     "tsdeprecated": [
       {
-        "type": "candidate",
-        "since": "17.0.0"
+        "type": "supersedes",
+        "since": "17.1.0",
+        "value": [
+          "oj-date-picker"
+        ]
       }
     ],
     "meta": {
@@ -61,7 +64,7 @@
     "tstype": [
       {
         "target": "Type",
-        "value": "(date: Required<CalendarDate>) => { state: \"disabled\" | \"enabled\" | \"restricted\"; }",
+        "value": "(date: Required<oj-c.DatePicker.CalendarDate>) => { state: \"disabled\" | \"enabled\" | \"restricted\"; }",
         "jsdocOverride": true
       }
     ]
@@ -314,6 +317,49 @@
       ]
     }
   },
+  {
+    "memberof": "oj-c.DatePicker",
+    "id": "oj-c.DatePicker#weekDisplay",
+    "name": "weekDisplay",
+    "kind": "member",
+    "longname": "oj-c.DatePicker#weekDisplay",
+    "optional": true,
+    "scope": "instance",
+    "description": "Whether week of the year will be shown in the DatePicker. The default calculation follows the\nrule for ISO 8601 as follows: The first week of the year is defined as the week that contains\nthe first Thursday. Therefore, if January 1st falls on a Friday, it is considered part of the last week\nof the previous year. Conversely, if December 31st falls on a Wednesday, it is part of week 1 of the following year.",
+    "meta": {
+      "filename": "date-picker.tsx",
+      "path": "web/components/oj-c/date-picker"
+    },
+    "ojvalues": [
+      {
+        "name": "none",
+        "description": "The week of the year column will not be shown.",
+        "displayName": "None",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "number",
+        "description": "Will show the week of the year as a number.",
+        "displayName": "Number",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"none\"",
+    "type": {
+      "names": [
+        "\"number\"",
+        "\"none\""
+      ]
+    }
+  },
   {
     "memberof": "oj-c.DatePicker",
     "id": "oj-c.DatePicker#width",
@@ -450,5 +496,52 @@
       "path": "web/components/oj-c/date-picker"
     },
     "ojfragment": true
+  },
+  {
+    "memberof": "oj-c.DatePicker",
+    "id": "oj-c.DatePicker.CalendarDate",
+    "name": "CalendarDate",
+    "kind": "typedef",
+    "longname": "oj-c.DatePicker.CalendarDate",
+    "scope": "static",
+    "description": "",
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "date-picker.tsx",
+      "path": "web/components/oj-c/date-picker"
+    },
+    "properties": [
+      {
+        "name": "year",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      },
+      {
+        "name": "month",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      },
+      {
+        "name": "day",
+        "optional": true,
+        "type": {
+          "names": [
+            "number"
+          ]
+        }
+      }
+    ]
   }
 ]

package/oj-c/FilePicker.json

@@ -406,8 +406,8 @@
           {
             "target": "Type",
             "value": "FileList",
-            "for": "files",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "files"
           }
         ]
       }
@@ -439,8 +439,8 @@
           {
             "target": "Type",
             "value": "Array<oj-c.FilePicker.ComponentMessageItem>",
-            "for": "messages",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "messages"
           }
         ]
       },
@@ -482,8 +482,8 @@
           {
             "target": "Type",
             "value": "FileList",
-            "for": "files",
-            "jsdocOverride": true
+            "jsdocOverride": true,
+            "for": "files"
           }
         ]
       }