@oracle/oraclejet-core-pack 14.0.0

package/oj-c/Collapsible.json

@@ -0,0 +1,396 @@
+[
+  {
+    "pack": "oj-c",
+    "id": "oj-c.Collapsible",
+    "name": "Collapsible",
+    "memberof": "oj-c",
+    "longname": "oj-c.Collapsible",
+    "kind": "class",
+    "classdesc": "<h3 id=\"collapsibleOverview-section\">\n  JET Collapsible\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#collapsibleOverview-section\"></a>\n</h3>\n\n<p>Description: A JET Collapsible displays a header that can be expanded to show additional content beneath it.\nThe child element of the oj-c-collapsible in the named <a href=\"#header\">header</a> slot is displayed in the header, while the child element in the <a href=\"#Default\">default</a> slot is displayed as the content.\n\n<p>Note for performance reasons, if the collapsible content is expensive to render, you should wrap it in an <code class=\"prettyprint\">oj-defer</code> element to defer the rendering of that content.<br/>\nSee the Collapsible - Deferred Rendering demo for an example.</p>\n\n<pre class=\"prettyprint\"><code>\n&lt;oj-c-collapsible>\n  &lt;h3 slot='header'>Header 1&lt;/h3>\n  &lt;p>Content 1&lt;/p>\n&lt;/oj-c-collapsible>\n</code></pre>\n\n<h3 id=\"migration-section\">\n  Migration\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#migration-section\"></a>\n </h3>\n To migrate from oj-collapsible to oj-c-collapsible, you need to revise the import statement and references to oj-c-collapsible in your app.\n In addition, please note the changes between the two components below.\n <h5>oj-header-border style class</h5>\n <p>The <code class=\"prettyprint\">oj-header-border</code> style class should no longer be used with oj-c-collapsible.\n    To display a divider between the collapsible header and content, set the <code class=\"prettyprint\">variant</code> property value\n    to <code class=\"prettyprint\">horizontal-rule</code>\n </p>\n <h5>Child margins</h5>\n  <p>By default, <code class=\"prettyprint\">oj-c-collapsible</code> removes margins from children passed\n     in the <code class=\"prettyprint\">header</code> and default (content) slots. To preserve the margins,\n     wrap the header or content elements in an extra <code class=\"prettyprint\">div</code>.\n  </p>\n\n<h3 id=\"data-attributes-section\">\n  Custom Data Attributes\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#data-attributes-section\"></a>\n</h3>\n\n<p>Collapsible supports the following custom data attributes.\n<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Name</th>\n      <th>Description</th>\n      <th>Example</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td><kbd>data-oj-clickthrough</kbd></td>\n      <td><p>Specify on any element inside the header where you want to control whether Collapsible should toggle disclosure by\n          an event originating from the element or one of its descendants.</p>\n          <p>For example, if you specify this attribute with a value of \"disabled\" on a button inside the header, then Collapsible\n          will not trigger disclosure when user clicks on the button.</p>\n      </td>\n      <td>\n        <pre class=\"prettyprint\"><code>&lt;oj-c-collapsible>\n  &lt;div slot=\"header\">\n    &lt;h3>Header 3&lt;/h3>\n    &lt;oj-c-button data-oj-clickthrough=\"disabled\">&lt;/oj-c-button\n  &lt;/div>\n  &lt;p>Content&lt;/p>\n&lt;/oj-c-collapsible></code></pre>\n      </td>\n    </tr>\n  </tbody>\n</table>",
+    "scope": "static",
+    "tagWithoutBrackets": "oj-c-collapsible",
+    "tagWithBrackets": "<oj-c-collapsible>",
+    "domInterface": "CCollapsibleElement",
+    "ojPageTitle": "&lt;oj-c-collapsible>",
+    "ojcomponent": true,
+    "isvcomponent": true,
+    "camelCaseName": "Collapsible",
+    "ojPageTitlePrefix": "Element: ",
+    "ojtsvcomponent": true,
+    "tstype": {
+      "target": "Type",
+      "value": "interface CCollapsibleElement extends JetElement<CollapsibleElementSettableProperties>"
+    },
+    "ojsignature": [
+      {
+        "target": "Type",
+        "value": "interface CCollapsibleElement extends JetElement<CollapsibleElementSettableProperties>"
+      }
+    ],
+    "since": "14.0.0",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "ojmodule": "collapsible"
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#disabled",
+    "name": "disabled",
+    "kind": "member",
+    "longname": "oj-c.Collapsible#disabled",
+    "optional": true,
+    "scope": "instance",
+    "description": "Disables the collapsible if set to <code class=\"prettyprint\">true</code>.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#expanded",
+    "name": "expanded",
+    "kind": "member",
+    "longname": "oj-c.Collapsible#expanded",
+    "optional": true,
+    "scope": "instance",
+    "ojwriteback": true,
+    "description": "Specifies if the content is expanded.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#iconPosition",
+    "name": "iconPosition",
+    "kind": "member",
+    "longname": "oj-c.Collapsible#iconPosition",
+    "optional": true,
+    "scope": "instance",
+    "description": "Controls placement of the icon in the header.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "type": {
+      "names": [
+        "\"start\"",
+        "\"end\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#variant",
+    "name": "variant",
+    "kind": "member",
+    "longname": "oj-c.Collapsible#variant",
+    "optional": true,
+    "scope": "instance",
+    "description": "Controls display of the optional divider below the header.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "type": {
+      "names": [
+        "\"basic\"",
+        "\"horizontal-rule\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#setProperty",
+    "name": "setProperty",
+    "kind": "function",
+    "longname": "oj-c.Collapsible#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": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "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.Collapsible",
+    "id": "oj-c.Collapsible#getProperty",
+    "name": "getProperty",
+    "kind": "function",
+    "longname": "oj-c.Collapsible#getProperty",
+    "description": "Retrieves the value of a property or a subproperty.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "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.Collapsible",
+    "id": "oj-c.Collapsible#setProperties",
+    "name": "setProperties",
+    "kind": "function",
+    "longname": "oj-c.Collapsible#setProperties",
+    "description": "Performs a batch set of properties.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "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.Collapsible",
+    "id": "oj-c.Collapsible#event:ojBeforeCollapse",
+    "name": "ojBeforeCollapse",
+    "kind": "event",
+    "longname": "oj-c.Collapsible#event:ojBeforeCollapse",
+    "description": "Triggered immediately before the collapsible is collapsed.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "scope": "instance",
+    "properties": [
+      {
+        "name": "accept",
+        "description": "This method can be called with an application-created Promise to cancel this event asynchronously.  The Promise should be resolved or rejected to accept or cancel the event, respectively.",
+        "type": {
+          "names": [
+            "function"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "(param: Promise<void>) => void",
+            "for": "accept",
+            "jsdocOverride": true
+          }
+        ]
+      },
+      {
+        "name": "target",
+        "type": {
+          "names": [
+            "EventTarget|null"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "EventTarget|null",
+            "for": "target",
+            "jsdocOverride": true
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#event:ojBeforeExpand",
+    "name": "ojBeforeExpand",
+    "kind": "event",
+    "longname": "oj-c.Collapsible#event:ojBeforeExpand",
+    "description": "Triggered immediately before the collapsible is expanded.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "scope": "instance",
+    "properties": [
+      {
+        "name": "accept",
+        "description": "This method can be called with an application-created Promise to cancel this event asynchronously.  The Promise should be resolved or rejected to accept or cancel the event, respectively.",
+        "type": {
+          "names": [
+            "function"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "(param: Promise<void>) => void",
+            "for": "accept",
+            "jsdocOverride": true
+          }
+        ]
+      },
+      {
+        "name": "target",
+        "type": {
+          "names": [
+            "EventTarget|null"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "EventTarget|null",
+            "for": "target",
+            "jsdocOverride": true
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#event:ojCollapse",
+    "name": "ojCollapse",
+    "kind": "event",
+    "longname": "oj-c.Collapsible#event:ojCollapse",
+    "description": "Triggered after the collapsible has been collapsed.",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "scope": "instance",
+    "properties": [
+      {
+        "name": "target",
+        "type": {
+          "names": [
+            "EventTarget|null"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "EventTarget|null",
+            "for": "target",
+            "jsdocOverride": true
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#event:ojExpand",
+    "name": "ojExpand",
+    "kind": "event",
+    "longname": "oj-c.Collapsible#event:ojExpand",
+    "description": "Triggered after the collapsible has been expanded (after animation completes).",
+    "meta": {
+      "filename": "collapsible.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "scope": "instance",
+    "properties": [
+      {
+        "name": "target",
+        "type": {
+          "names": [
+            "EventTarget|null"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "EventTarget|null",
+            "for": "target",
+            "jsdocOverride": true
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#Default",
+    "name": "Default",
+    "kind": "member",
+    "longname": "oj-c.Collapsible#Default",
+    "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_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "scope": "instance",
+    "ojchild": true,
+    "ojslot": false
+  },
+  {
+    "memberof": "oj-c.Collapsible",
+    "id": "oj-c.Collapsible#header",
+    "name": "header",
+    "kind": "member",
+    "longname": "oj-c.Collapsible#header",
+    "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_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/collapsible"
+    },
+    "scope": "instance",
+    "ojchild": false,
+    "ojslot": true
+  }
+]