@oracle/oraclejet-core-pack 16.1.3 → 17.0.0

package/oj-c/Collapsible.json

@@ -28,9 +28,15 @@
       }
     ],
     "since": "14.0.0",
+    "tsdeprecated": [
+      {
+        "type": "candidate",
+        "since": "17.0.0"
+      }
+    ],
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "ojmodule": "collapsible"
   },
@@ -45,8 +51,9 @@
     "description": "Disables the collapsible if set to <code class=\"prettyprint\">true</code>.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
+    "defaultvalue": false,
     "type": {
       "names": [
         "boolean"
@@ -65,8 +72,9 @@
     "description": "Specifies if the content is expanded.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
+    "defaultvalue": false,
     "type": {
       "names": [
         "boolean"
@@ -84,8 +92,31 @@
     "description": "Controls placement of the icon in the header.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
+    "ojvalues": [
+      {
+        "name": "start",
+        "description": "icon position is start (default, if unspecified)",
+        "displayName": "Start",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "end",
+        "description": "icon position is end",
+        "displayName": "End",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"start\"",
     "type": {
       "names": [
         "\"end\"",
@@ -104,8 +135,31 @@
     "description": "Controls display of the optional divider below the header.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
+    "ojvalues": [
+      {
+        "name": "basic",
+        "description": "basic, no divider (default, if unspecified)",
+        "displayName": "Basic",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "horizontal-rule",
+        "description": "displays a horizontal divider between the header and content",
+        "displayName": "Horizontal Rule",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"basic\"",
     "type": {
       "names": [
         "\"basic\"",
@@ -122,7 +176,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": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "params": [
@@ -156,7 +210,7 @@
     "description": "Retrieves the value of a property or a subproperty.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "params": [
@@ -185,7 +239,7 @@
     "description": "Performs a batch set of properties.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "params": [
@@ -214,7 +268,7 @@
     "description": "Triggered immediately before the collapsible is collapsed.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "properties": [
@@ -225,15 +279,7 @@
           "names": [
             "function"
           ]
-        },
-        "tstype": [
-          {
-            "target": "Type",
-            "value": "(param: Promise<void>) => void",
-            "for": "accept",
-            "jsdocOverride": true
-          }
-        ]
+        }
       },
       {
         "name": "target",
@@ -263,7 +309,7 @@
     "description": "Triggered immediately before the collapsible is expanded.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "properties": [
@@ -274,15 +320,7 @@
           "names": [
             "function"
           ]
-        },
-        "tstype": [
-          {
-            "target": "Type",
-            "value": "(param: Promise<void>) => void",
-            "for": "accept",
-            "jsdocOverride": true
-          }
-        ]
+        }
       },
       {
         "name": "target",
@@ -312,7 +350,7 @@
     "description": "Triggered after the collapsible has been collapsed.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "properties": [
@@ -344,7 +382,7 @@
     "description": "Triggered after the collapsible has been expanded (after animation completes).",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "properties": [
@@ -376,7 +414,7 @@
     "description": "The default slot is the content of the collapsible. The oj-c-collapsible element accepts plain text or DOM nodes as children for the default slot.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "ojchild": true,
@@ -391,7 +429,7 @@
     "description": "The header slot is the collapsible's header. If not specified, the header contains only an open/close icon. Note that the header text is required for JET collapsible for accessibility purposes.",
     "meta": {
       "filename": "collapsible.tsx",
-      "path": "/home/jenkins/uitech/workspace/OJET_Code_16.1.3/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+      "path": "web/components/oj-c/collapsible"
     },
     "scope": "instance",
     "ojchild": false,

package/oj-c/ConveyorBelt.json

@@ -0,0 +1,325 @@
+[
+  {
+    "pack": "oj-c",
+    "id": "oj-c.ConveyorBelt",
+    "name": "ConveyorBelt",
+    "memberof": "oj-c",
+    "longname": "oj-c.ConveyorBelt",
+    "kind": "class",
+    "classdesc": "<p>Container element that manages overflow for its child\nelements and allows scrolling among them.\n\n\n<pre class=\"prettyprint\"><code>\n&lt;oj-c-conveyor-belt items=\"[[dataArray]]\">\n   &lt;template slot='itemTemplate'>\n       &lt;oj-c-button label=\"[[$current.data]]\"></oj-c-button>\n    &lt;/template>\n&lt;/oj-c-conveyor-belt>\n</code></pre>\n\n<p>Use ConveyorBelt when you want to:\n<ul>\n<li>handle overflow without showing a scrollbar</li>\n<li>keep all items accessible via tabbing and readable by a screen reader</li>\n</ul>",
+    "scope": "static",
+    "tagWithoutBrackets": "oj-c-conveyor-belt",
+    "tagWithBrackets": "<oj-c-conveyor-belt>",
+    "domInterface": "CConveyorBeltElement",
+    "ojPageTitle": "&lt;oj-c-conveyor-belt>",
+    "ojcomponent": true,
+    "isvcomponent": true,
+    "camelCaseName": "ConveyorBelt",
+    "ojPageTitlePrefix": "Element: ",
+    "ojtsvcomponent": true,
+    "tstype": {
+      "target": "Type",
+      "value": "interface CConveyorBeltElement extends JetElement<ConveyorBeltElementSettableProperties>"
+    },
+    "ojsignature": [
+      {
+        "target": "Type",
+        "value": "interface CConveyorBeltElement extends JetElement<ConveyorBeltElementSettableProperties>"
+      }
+    ],
+    "since": "17.0.0",
+    "tsdeprecated": [
+      {
+        "type": "supersedes",
+        "since": "17.0.0",
+        "value": [
+          "oj-conveyor-belt"
+        ]
+      }
+    ],
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "ojmodule": "conveyor-belt"
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#scrollPosition",
+    "name": "scrollPosition",
+    "kind": "member",
+    "longname": "oj-c.ConveyorBelt#scrollPosition",
+    "optional": true,
+    "scope": "instance",
+    "ojwriteback": true,
+    "description": "<p>Gets or sets the number of pixels that an element's content is scrolled from its initial position.\n\n<p>The default value of this property is 0.\n\n<p> There is no difference between LTR/RTL value assignment.\nIn both LTR and RTL values changes from 0 and max scroll position >=0  if we scroll to the end.\nIf we scroll to the beginning then the values changes from max scroll position >=0 to min scroll position = 0\nWhen the value exceeds max/min the value is constrained to the max/min scroll position accordingly.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "type": {
+      "names": [
+        "number"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#arrowVisibility",
+    "name": "arrowVisibility",
+    "kind": "member",
+    "longname": "oj-c.ConveyorBelt#arrowVisibility",
+    "optional": true,
+    "scope": "instance",
+    "description": "<p>Indicates whether overflow content arrows are visible or hidden.\n\n<p>The default value of this property varies by theme. If the default value is 'auto', then the behavior varies by device.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "type": {
+      "names": [
+        "\"auto\"",
+        "\"hidden\"",
+        "\"visible\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#items",
+    "name": "items",
+    "kind": "member",
+    "longname": "oj-c.ConveyorBelt#items",
+    "optional": true,
+    "scope": "instance",
+    "description": "An array of data items or a data provider that returns the items for the ConveyorBelt.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "type": {
+      "names": [
+        "Array<object>|DataProvider"
+      ]
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Array<ConveyorBeltArrayDataItem<K, D>>|DataProvider<K, D>",
+        "jsdocOverride": true
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#orientation",
+    "name": "orientation",
+    "kind": "member",
+    "longname": "oj-c.ConveyorBelt#orientation",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specify the orientation of the conveyorBelt.\n\"horizontal\" Orient the conveyorBelt horizontally.\n\"vertical\" Orient the conveyorBelt vertically.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "defaultvalue": "\"horizontal\"",
+    "type": {
+      "names": [
+        "\"horizontal\"",
+        "\"vertical\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#scrollElementIntoView",
+    "name": "scrollElementIntoView",
+    "kind": "function",
+    "longname": "oj-c.ConveyorBelt#scrollElementIntoView",
+    "description": "Scrolls element into view.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "element",
+        "type": "HTMLElement"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#setProperty",
+    "name": "setProperty",
+    "kind": "function",
+    "longname": "oj-c.ConveyorBelt#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": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "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.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#getProperty",
+    "name": "getProperty",
+    "kind": "function",
+    "longname": "oj-c.ConveyorBelt#getProperty",
+    "description": "Retrieves the value of a property or a subproperty.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "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.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#setProperties",
+    "name": "setProperties",
+    "kind": "function",
+    "longname": "oj-c.ConveyorBelt#setProperties",
+    "description": "Performs a batch set of properties.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "properties",
+        "description": "An object containing the property and value pairs to set.",
+        "type": "object"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#Default",
+    "name": "Default",
+    "kind": "member",
+    "longname": "oj-c.ConveyorBelt#Default",
+    "description": "The default slot is the content of the Conveyor Belt.",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "scope": "instance",
+    "ojchild": true,
+    "ojslot": false
+  },
+  {
+    "memberof": "oj-c.ConveyorBelt",
+    "id": "oj-c.ConveyorBelt#itemTemplate",
+    "name": "itemTemplate",
+    "kind": "member",
+    "longname": "oj-c.ConveyorBelt#itemTemplate",
+    "description": "<p>The <code class=\"prettyprint\">itemTemplate</code> slot is used to specify the template for rendering each item in the Conveyor Belt. The slot content must be a &lt;template> element.\n<p>When the template is executed for each item, it will have access to the binding context containing the following properties:</p>\n<ul>\n  <li>$current - an object that contains information for the current item.</li>\n</ul>",
+    "meta": {
+      "filename": "conveyor-belt.tsx",
+      "path": "web/components/oj-c/conveyor-belt"
+    },
+    "scope": "instance",
+    "ojchild": false,
+    "ojslot": true,
+    "properties": [
+      {
+        "name": "data",
+        "description": "The data of the item.  Note this is made available primarily to ease migration.\nApplications should get the data from the item property instead.",
+        "optional": false,
+        "type": {
+          "names": [
+            "any"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "D",
+            "for": "data",
+            "jsdocOverride": true
+          }
+        ]
+      },
+      {
+        "name": "item",
+        "description": "Contains the data and metadata of the item.",
+        "optional": false,
+        "type": {
+          "names": [
+            "object"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "Item<K, D>",
+            "for": "item",
+            "jsdocOverride": true,
+            "module": {
+              "Item": "ojdataprovider"
+            }
+          }
+        ]
+      }
+    ]
+  }
+]