@oracle/oraclejet-core-pack 14.0.0

package/oj-c/SplitMenuButton.json

@@ -0,0 +1,495 @@
+[
+  {
+    "pack": "oj-c",
+    "id": "oj-c.SplitMenuButton",
+    "name": "SplitMenuButton",
+    "memberof": "oj-c",
+    "longname": "oj-c.SplitMenuButton",
+    "kind": "class",
+    "classdesc": "<h3 id=\"splitMenuButtonOverview-section\">\n  JET Split Menu Button\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#buttonOverview-section\"></a>\n</h3>\n\n<p>Description: A Split Menu Button combines a push button and menu button.\n\n<pre class=\"prettyprint\"><code>&lt;oj-c-split-menu-button label=\"Copy\" onAction=\"[[action]]\" items=\"[[items]]\">\n&lt;/oj-c-split-menu-button>\n</code></pre>\n\n<h3 id=\"touch-section\">\n  Touch End User Information\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#touch-section\"></a>\n</h3>\n\n<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Target</th>\n      <th>Gesture</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>Button</td>\n      <td><kbd>Tap on action side</kbd></td>\n      <td>Invoke the action.</td>\n    </tr>\n    <tr>\n      <td>Button</td>\n      <td><kbd>Tap on menu side</kbd></td>\n      <td>Invoke the menu.</td>\n    </tr>\n  </tbody>\n</table>\n\n<h3 id=\"keyboard-section\">\n  Keyboard End User Information\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#keyboard-section\"></a>\n</h3>\n\n<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Target</th>\n      <th>Key</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>Split Menu Button</td>\n      <td><kbd>Enter</kbd> or <kbd>Space</kbd></td>\n      <td>Invoke the Button action.</td>\n    </tr>\n    <tr>\n      <td>Split Menu Button</td>\n      <td><kbd>Down Arrow</kbd></td>\n      <td>Invoke the Button menu.</td>\n    </tr>\n  </tbody>\n</table>\n\n<h3 id=\"a11y-section\">\n  Accessibility\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#a11y-section\"></a>\n</h3>\n\n<p>For accessibility, the label is used as the accessible aria label.  This is required\nas persistent split menu buttons modify the label depending on the last menu item selection.\n\n<p>Disabled content: JET supports an accessible luminosity contrast ratio,\nas specified in <a href=\"http://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast\">WCAG 2.0 - Section 1.4.3 \"Contrast\"</a>,\nin the themes that are accessible.  (See the \"Theming\" chapter of the JET Developer Guide for more information on which\nthemes are accessible.)  Note that Section 1.4.3 says that text or images of text that are part of an inactive user\ninterface component have no contrast requirement.  Because disabled content may not meet the minimum contrast ratio\nrequired of enabled content, it cannot be used to convey meaningful information.<p>",
+    "scope": "static",
+    "tagWithoutBrackets": "oj-c-split-menu-button",
+    "tagWithBrackets": "<oj-c-split-menu-button>",
+    "domInterface": "CSplitMenuButtonElement",
+    "ojPageTitle": "&lt;oj-c-split-menu-button>",
+    "ojcomponent": true,
+    "isvcomponent": true,
+    "camelCaseName": "SplitMenuButton",
+    "ojPageTitlePrefix": "Element: ",
+    "ojtsvcomponent": true,
+    "tstype": {
+      "target": "Type",
+      "value": "interface CSplitMenuButtonElement extends JetElement<SplitMenuButtonElementSettableProperties>"
+    },
+    "ojsignature": [
+      {
+        "target": "Type",
+        "value": "interface CSplitMenuButtonElement extends JetElement<SplitMenuButtonElementSettableProperties>"
+      }
+    ],
+    "since": "14.0.0",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "ojmodule": "split-menu-button"
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#label",
+    "name": "label",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton#label",
+    "optional": false,
+    "scope": "instance",
+    "description": "Text to show in the button.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "defaultvalue": "\"\"",
+    "type": {
+      "names": [
+        "string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#items",
+    "name": "items",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton#items",
+    "optional": true,
+    "scope": "instance",
+    "description": "Items describe the menu items rendered by the menu button.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "defaultvalue": "[]",
+    "type": {
+      "names": [
+        "Array<object>"
+      ]
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "oj-c.SplitMenuButton.SplitMenuButtonMenuItem",
+        "jsdocOverride": true
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#disabled",
+    "name": "disabled",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton#disabled",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies that the button element should be disabled.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "defaultvalue": false,
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#size",
+    "name": "size",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton#size",
+    "optional": true,
+    "scope": "instance",
+    "description": "Size of button",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "ojvalues": [
+      {
+        "name": "sm",
+        "description": "Display a small button.",
+        "displayName": "Small",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "md",
+        "description": "Display a default size button.",
+        "displayName": "Medium",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "lg",
+        "description": "Display a large button.",
+        "displayName": "Large",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"md\"",
+    "type": {
+      "names": [
+        "\"sm\"",
+        "\"md\"",
+        "\"lg\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#width",
+    "name": "width",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton#width",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies that the button style width",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "type": {
+      "names": [
+        "number|string"
+      ]
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Size",
+        "jsdocOverride": true
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#chroming",
+    "name": "chroming",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton#chroming",
+    "optional": true,
+    "scope": "instance",
+    "description": "Indicates in what states the button has chromings in background and border.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "ojvalues": [
+      {
+        "name": "outlined",
+        "description": "Outlined buttons are salient, but lighter weight than solid buttons. Outlined buttons are useful for secondary actions.",
+        "displayName": "Outlined",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "solid",
+        "description": "Solid buttons stand out, and direct the user's attention to the most important actions in the UI.",
+        "displayName": "Solid",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "callToAction",
+        "description": "A Call To Action (CTA) button guides the user to take or complete the action that is the main goal of the page or page section. There should only be one CTA button on a page at any given time.",
+        "displayName": "Call To Action",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"outlined\"",
+    "type": {
+      "names": [
+        "\"outlined\"",
+        "\"solid\"",
+        "\"callToAction\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#blur",
+    "name": "blur",
+    "kind": "function",
+    "longname": "oj-c.SplitMenuButton#blur",
+    "description": "blurs the button",
+    "ojhidden": true,
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "scope": "instance",
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#focus",
+    "name": "focus",
+    "kind": "function",
+    "longname": "oj-c.SplitMenuButton#focus",
+    "description": "focuses the button",
+    "ojhidden": true,
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "scope": "instance",
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#doAction",
+    "name": "doAction",
+    "kind": "function",
+    "longname": "oj-c.SplitMenuButton#doAction",
+    "description": "invokes button action",
+    "ojhidden": true,
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "scope": "instance",
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#setProperty",
+    "name": "setProperty",
+    "kind": "function",
+    "longname": "oj-c.SplitMenuButton#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": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "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.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#getProperty",
+    "name": "getProperty",
+    "kind": "function",
+    "longname": "oj-c.SplitMenuButton#getProperty",
+    "description": "Retrieves the value of a property or a subproperty.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "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.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#setProperties",
+    "name": "setProperties",
+    "kind": "function",
+    "longname": "oj-c.SplitMenuButton#setProperties",
+    "description": "Performs a batch set of properties.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "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.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton#event:ojAction",
+    "name": "ojAction",
+    "kind": "event",
+    "longname": "oj-c.SplitMenuButton#event:ojAction",
+    "description": "Triggered when a button is clicked, whether by keyboard, mouse, or touch events. To meet accessibility requirements, the only supported way to react to the click of a button is to listen for this event.",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "scope": "instance"
+  },
+  {
+    "id": "oj-c.SplitMenuButton.touchDoc",
+    "name": "touchDoc",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton.touchDoc",
+    "description": "<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Target</th>\n      <th>Gesture</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>Button</td>\n      <td><kbd>Tap on action side</kbd></td>\n      <td>Invoke the action.</td>\n    </tr>\n    <tr>\n      <td>Button</td>\n      <td><kbd>Tap on menu side</kbd></td>\n      <td>Invoke the menu.</td>\n    </tr>\n  </tbody>\n</table>",
+    "memberof": "oj-c.SplitMenuButton",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "ojfragment": true
+  },
+  {
+    "id": "oj-c.SplitMenuButton.keyboardDoc",
+    "name": "keyboardDoc",
+    "kind": "member",
+    "longname": "oj-c.SplitMenuButton.keyboardDoc",
+    "description": "<table class=\"keyboard-table\">\n  <thead>\n    <tr>\n      <th>Target</th>\n      <th>Key</th>\n      <th>Action</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>Split Menu Button</td>\n      <td><kbd>Enter</kbd> or <kbd>Space</kbd></td>\n      <td>Invoke the Button action.</td>\n    </tr>\n    <tr>\n      <td>Split Menu Button</td>\n      <td><kbd>Down Arrow</kbd></td>\n      <td>Invoke the Button menu.</td>\n    </tr>\n  </tbody>\n</table>",
+    "memberof": "oj-c.SplitMenuButton",
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "ojfragment": true
+  },
+  {
+    "memberof": "oj-c.SplitMenuButton",
+    "id": "oj-c.SplitMenuButton.SplitMenuButtonMenuItem",
+    "name": "SplitMenuButtonMenuItem",
+    "kind": "typedef",
+    "longname": "oj-c.SplitMenuButton.SplitMenuButtonMenuItem",
+    "scope": "static",
+    "description": "",
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "split-menu-button.tsx",
+      "path": "/home/jenkins/uitech/workspace/OJET_Code_14.0.0/packages/oraclejet-core-pack/web/components/oj-c/split-menu-button"
+    },
+    "properties": [
+      {
+        "name": "type",
+        "optional": true,
+        "type": {
+          "names": [
+            "item",
+            "divider"
+          ]
+        }
+      },
+      {
+        "name": "label",
+        "optional": true,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "disabled",
+        "optional": true,
+        "type": {
+          "names": [
+            "boolean"
+          ]
+        }
+      },
+      {
+        "name": "onAction",
+        "optional": true,
+        "type": {
+          "names": [
+            "function"
+          ]
+        }
+      }
+    ]
+  }
+]