@oracle/oraclejet-core-pack 16.1.3 → 17.0.0

package/oj-c/ButtonsetMultiple.json

@@ -0,0 +1,567 @@
+[
+  {
+    "pack": "oj-c",
+    "id": "oj-c.ButtonsetMultiple",
+    "name": "ButtonsetMultiple",
+    "memberof": "oj-c",
+    "longname": "oj-c.ButtonsetMultiple",
+    "kind": "class",
+    "classdesc": "<h3 id=\"ButtonsetMultipleOverview-section\">\n  JET Buttonset Multiple\n  <a class=\"bookmarkable-link\" title=\"Bookmarkable Link\" href=\"#buttonSetMultipleOverview-section\"></a>\n</h3>\n\n<p>Description: A Buttonset Multiple is a grouping of related buttons where any number of buttons may be selected.\n\n<pre class=\"prettyprint\"><code>&lt;oj-c-buttonset-multiple aria-label=\"Pick Items\" value=\"{{value}}\" items=\"[[items]]\">\n&lt;/oj-c-buttonset-multiple>\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>Push Toggle Button</td>\n      <td><kbd>Tap</kbd></td>\n      <td>Toggle the button.</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>Buttonset Multiple</td>\n      <td><kbd>Enter</kbd> or <kbd>Space</kbd></td>\n      <td>Toggle the focused Button.</td>\n    </tr>\n    <tr>\n      <td>Buttonset Multiple</td>\n      <td><kbd>Right Arrow</kbd></td>\n      <td>Move focus to the next enabled Button, wrapping as needed.</td>\n    </tr>\n    <tr>\n      <td>Buttonset Multiple</td>\n      <td><kbd>Left Arrow</kbd></td>\n      <td>Move focus to the previous enabled Button, wrapping as needed.</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>The application is responsible for applying <code class=\"prettyprint\">aria-label</code> and/or\n<code class=\"prettyprint\">aria-controls</code> attributes like the following to the buttonset element, if applicable per the instructions that follow:\n\n<pre class=\"prettyprint\">\n<code>aria-label=\"Choose beverages.\"\naria-controls=\"myTextEditor\"\n</code></pre>\n\n<p>An <code class=\"prettyprint\">aria-label</code> conveying the \"choose multiple\" semantics should be included for a buttonset-multiple.\n\n<p>The <code class=\"prettyprint\">aria-controls</code> attribute should be included if the buttonset is controlling something else on the page, e.g.\nbold / italic / underline buttons controlling a rich text editor.  If the buttonset is contained in a toolbar, <code class=\"prettyprint\">aria-controls</code>\nshould be placed on the toolbar, not on the buttonsets within the toolbar.\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-buttonset-multiple",
+    "tagWithBrackets": "<oj-c-buttonset-multiple>",
+    "domInterface": "CButtonsetMultipleElement",
+    "ojPageTitle": "&lt;oj-c-buttonset-multiple>",
+    "ojcomponent": true,
+    "isvcomponent": true,
+    "camelCaseName": "ButtonsetMultiple",
+    "ojPageTitlePrefix": "Element: ",
+    "ojtsvcomponent": true,
+    "tstype": {
+      "target": "Type",
+      "value": "interface CButtonsetMultipleElement extends JetElement<ButtonsetMultipleElementSettableProperties>"
+    },
+    "ojsignature": [
+      {
+        "target": "Type",
+        "value": "interface CButtonsetMultipleElement extends JetElement<ButtonsetMultipleElementSettableProperties>"
+      }
+    ],
+    "since": "17.0.0",
+    "tsdeprecated": [
+      {
+        "type": "supersedes",
+        "since": "17.0.0",
+        "value": [
+          "oj-buttonset-many"
+        ]
+      }
+    ],
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "ojmodule": "buttonset-multiple"
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#value",
+    "name": "value",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#value",
+    "optional": true,
+    "scope": "instance",
+    "ojwriteback": true,
+    "description": "Specifies which toggle button is selected",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "type": {
+      "names": [
+        "Array<string>"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#items",
+    "name": "items",
+    "kind": "member",
+    "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>",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "defaultvalue": "[]",
+    "type": {
+      "names": [
+        "Array<object>"
+      ]
+    },
+    "tstype": [
+      {
+        "target": "Type",
+        "value": "Array<oj-c.ButtonsetMultiple.ToggleItem>",
+        "jsdocOverride": true
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#display",
+    "name": "display",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#display",
+    "optional": true,
+    "scope": "instance",
+    "description": "Display just the label, the icons, or all.",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "ojvalues": [
+      {
+        "name": "all",
+        "description": "Display both the label and icons.",
+        "displayName": "All",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "icons",
+        "description": "Display only the icons.",
+        "displayName": "Icons",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "label",
+        "description": "Display only the text label.",
+        "displayName": "label",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"all\"",
+    "type": {
+      "names": [
+        "\"all\"",
+        "\"label\"",
+        "\"icons\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#disabled",
+    "name": "disabled",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#disabled",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies that the buttonset should be disabled.",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "defaultvalue": false,
+    "type": {
+      "names": [
+        "boolean"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#size",
+    "name": "size",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#size",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the size of the toggle buttons",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "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.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#width",
+    "name": "width",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#width",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the buttonset width",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "type": {
+      "names": [
+        "number|string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#maxWidth",
+    "name": "maxWidth",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#maxWidth",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies the buttonset max width",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "type": {
+      "names": [
+        "number|string"
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#chroming",
+    "name": "chroming",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#chroming",
+    "optional": true,
+    "scope": "instance",
+    "description": "Indicates in what states the button has chromings in background and border.",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "ojvalues": [
+      {
+        "name": "borderless",
+        "description": "Borderless buttons are a less prominent variation.",
+        "displayName": "Borderless",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "outlined",
+        "description": "Outlined buttons are a more prominent variation.",
+        "displayName": "Outlined",
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      }
+    ],
+    "defaultvalue": "\"outlined\"",
+    "type": {
+      "names": [
+        "\"borderless\"",
+        "\"outlined\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#layoutWidth",
+    "name": "layoutWidth",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple#layoutWidth",
+    "optional": true,
+    "scope": "instance",
+    "description": "Specifies if button width should be equal or based on contents.",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "type": {
+      "names": [
+        "\"auto\"",
+        "\"equal\""
+      ]
+    }
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#blur",
+    "name": "blur",
+    "kind": "function",
+    "longname": "oj-c.ButtonsetMultiple#blur",
+    "description": "blurs the button",
+    "ojhidden": true,
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "scope": "instance",
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#focus",
+    "name": "focus",
+    "kind": "function",
+    "longname": "oj-c.ButtonsetMultiple#focus",
+    "description": "focuses the button",
+    "ojhidden": true,
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "scope": "instance",
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "any"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#setProperty",
+    "name": "setProperty",
+    "kind": "function",
+    "longname": "oj-c.ButtonsetMultiple#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": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "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.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#getProperty",
+    "name": "getProperty",
+    "kind": "function",
+    "longname": "oj-c.ButtonsetMultiple#getProperty",
+    "description": "Retrieves the value of a property or a subproperty.",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "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.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple#setProperties",
+    "name": "setProperties",
+    "kind": "function",
+    "longname": "oj-c.ButtonsetMultiple#setProperties",
+    "description": "Performs a batch set of properties.",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "scope": "instance",
+    "params": [
+      {
+        "name": "properties",
+        "description": "An object containing the property and value pairs to set.",
+        "type": "object"
+      }
+    ],
+    "returns": [
+      {
+        "type": {
+          "names": [
+            "void"
+          ]
+        }
+      }
+    ]
+  },
+  {
+    "id": "oj-c.ButtonsetMultiple.touchDoc",
+    "name": "touchDoc",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple.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>Push Toggle Button</td>\n      <td><kbd>Tap</kbd></td>\n      <td>Toggle the button.</td>\n    </tr>\n  </tbody>\n</table>",
+    "memberof": "oj-c.ButtonsetMultiple",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "ojfragment": true
+  },
+  {
+    "id": "oj-c.ButtonsetMultiple.keyboardDoc",
+    "name": "keyboardDoc",
+    "kind": "member",
+    "longname": "oj-c.ButtonsetMultiple.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>Buttonset Multiple</td>\n      <td><kbd>Enter</kbd> or <kbd>Space</kbd></td>\n      <td>Toggle the focused Button.</td>\n    </tr>\n    <tr>\n      <td>Buttonset Multiple</td>\n      <td><kbd>Right Arrow</kbd></td>\n      <td>Move focus to the next enabled Button, wrapping as needed.</td>\n    </tr>\n    <tr>\n      <td>Buttonset Multiple</td>\n      <td><kbd>Left Arrow</kbd></td>\n      <td>Move focus to the previous enabled Button, wrapping as needed.</td>\n    </tr>\n  </tbody>\n</table>",
+    "memberof": "oj-c.ButtonsetMultiple",
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "ojfragment": true
+  },
+  {
+    "memberof": "oj-c.ButtonsetMultiple",
+    "id": "oj-c.ButtonsetMultiple.ToggleItem",
+    "name": "ToggleItem",
+    "kind": "typedef",
+    "longname": "oj-c.ButtonsetMultiple.ToggleItem",
+    "scope": "static",
+    "description": "",
+    "type": {
+      "names": [
+        "Object"
+      ]
+    },
+    "meta": {
+      "filename": "buttonset-multiple.tsx",
+      "path": "web/components/oj-c/buttonset-multiple"
+    },
+    "properties": [
+      {
+        "name": "label",
+        "optional": false,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "value",
+        "optional": false,
+        "type": {
+          "names": [
+            "string"
+          ]
+        }
+      },
+      {
+        "name": "disabled",
+        "optional": true,
+        "type": {
+          "names": [
+            "boolean"
+          ]
+        }
+      },
+      {
+        "name": "startIcon",
+        "optional": true,
+        "type": {
+          "names": [
+            "object"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "ToggleIcon",
+            "for": "startIcon",
+            "jsdocOverride": true
+          }
+        ]
+      },
+      {
+        "name": "endIcon",
+        "optional": true,
+        "type": {
+          "names": [
+            "object"
+          ]
+        },
+        "tstype": [
+          {
+            "target": "Type",
+            "value": "ToggleIcon",
+            "for": "endIcon",
+            "jsdocOverride": true
+          }
+        ]
+      }
+    ]
+  }
+]