@momentum-design/components 0.100.2 → 0.101.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js.map +2 -2
- package/dist/components/accordion/accordion.component.d.ts +2 -0
- package/dist/components/accordion/accordion.component.js +2 -0
- package/dist/components/accordionbutton/accordionbutton.component.d.ts +2 -0
- package/dist/components/accordionbutton/accordionbutton.component.js +2 -0
- package/dist/components/accordiongroup/accordiongroup.component.d.ts +2 -0
- package/dist/components/accordiongroup/accordiongroup.component.js +2 -0
- package/dist/custom-elements.json +374 -374
- package/dist/react/accordion/index.d.ts +2 -0
- package/dist/react/accordion/index.js +2 -0
- package/dist/react/accordionbutton/index.d.ts +2 -0
- package/dist/react/accordionbutton/index.js +2 -0
- package/dist/react/accordiongroup/index.d.ts +2 -0
- package/dist/react/accordiongroup/index.js +2 -0
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/package.json +1 -1
@@ -8,7 +8,7 @@
|
|
8
8
|
"declarations": [
|
9
9
|
{
|
10
10
|
"kind": "class",
|
11
|
-
"description": "An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n- Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n- Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.",
|
11
|
+
"description": "An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n- Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n- Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.",
|
12
12
|
"name": "Accordion",
|
13
13
|
"cssProperties": [
|
14
14
|
{
|
@@ -371,7 +371,7 @@
|
|
371
371
|
"module": "/src/components/accordionbutton/accordionbutton.component"
|
372
372
|
},
|
373
373
|
"tagName": "mdc-accordion",
|
374
|
-
"jsDoc": "/**\n * An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n * - Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n * - Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * @tagname mdc-accordion\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot leading-controls - The leading controls slot of the accordion on the header section.\n * @slot trailing-controls - The trailing controls slot of the accordion on the header section.\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion.\n *\n * @csspart header-section - The header section of the accordion.\n * @csspart leading-header - The leading header of the accordion.\n * @csspart trailing-header - The trailing header of the accordion.\n * @csspart trailing-header__button - The trailing header button of the accordion.\n * @csspart body-section - The body section of the accordion.\n */",
|
374
|
+
"jsDoc": "/**\n * An accordion contains a header and body section with a focusable heading that can be expanded or collapsed.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n * - Leading Slot - Contains the leading controls of the accordion on the header section. This will be placed on the leading side, after the header text.\n * - Trailing Slot - Contains the trailing controls of the accordion on the header section. This will be placed on the trailing side, before the expand/collapse button.\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If an accordion is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion.\n *\n * @tagname mdc-accordion\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot leading-controls - The leading controls slot of the accordion on the header section.\n * @slot trailing-controls - The trailing controls slot of the accordion on the header section.\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion.\n *\n * @csspart header-section - The header section of the accordion.\n * @csspart leading-header - The leading header of the accordion.\n * @csspart trailing-header - The trailing header of the accordion.\n * @csspart trailing-header__button - The trailing header button of the accordion.\n * @csspart body-section - The body section of the accordion.\n */",
|
375
375
|
"customElement": true,
|
376
376
|
"attributes": [
|
377
377
|
{
|
@@ -483,7 +483,7 @@
|
|
483
483
|
"declarations": [
|
484
484
|
{
|
485
485
|
"kind": "class",
|
486
|
-
"description": "An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you do need any controls on your accordion heading, then it's advised to use `accordion` component.",
|
486
|
+
"description": "An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n\nThe header section contains:\n- Prefix Icon\n- Header Text\n\nThe body section contains:\n- Default slot - User can place any content inside the body section.\n\nThe accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\nThere are two types of variants based on that the border styling of the accordion gets reflected. <br/>\nThere are two sizes of accordion, one is small and the other is large.\nSmall size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n\nBy default, the header text in the accordion heading is of H3 with an aria-level of '3'.\nIf this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n\nAn accordion can be disabled, and when it's disabled, the header section will not be clickable.\n\nIf you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n\nIf an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.",
|
487
487
|
"name": "AccordionButton",
|
488
488
|
"cssProperties": [
|
489
489
|
{
|
@@ -802,7 +802,7 @@
|
|
802
802
|
"module": "/src/models"
|
803
803
|
},
|
804
804
|
"tagName": "mdc-accordionbutton",
|
805
|
-
"jsDoc": "/**\n * An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n *\n * @tagname mdc-accordionbutton\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion button is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion button.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion button.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion button.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion button.\n *\n * @csspart header-section - The header section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart leading-header - The leading header of the accordion button.\n * @csspart trailing-header - The trailing header of the accordion button.\n * @csspart trailing-header__icon - The trailing header icon of the accordion button.\n * @csspart body-section - The body section of the accordion button.\n */",
|
805
|
+
"jsDoc": "/**\n * An accordion button contains a header and body section with optional slots inside the heading which are focusable.\n *\n * The header section contains:\n * - Prefix Icon\n * - Header Text\n *\n * The body section contains:\n * - Default slot - User can place any content inside the body section.\n *\n * The accordion button can be expanded or collapsed. The visibility of the body section can be controlled by `expanded` attribute. <br/>\n * There are two types of variants based on that the border styling of the accordion gets reflected. <br/>\n * There are two sizes of accordion, one is small and the other is large.\n * Small size has a padding of 1rem (16px) and large size has a padding of 1.5rem (24px) for the body section of accordion.\n *\n * By default, the header text in the accordion heading is of H3 with an aria-level of '3'.\n * If this accordion is placed on any other level in the entire webpage, then do adjust the aria-level number based on that.\n *\n * An accordion can be disabled, and when it's disabled, the header section will not be clickable.\n *\n * If you do need any controls on your accordion heading, then it's advised to use `accordion` component.\n *\n * If an accordion button is expanded by default, then the screen reader might loose focus when toggling the visibilty of the accordion button.\n *\n * @tagname mdc-accordionbutton\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @slot default - The default slot contains the body section of the accordion. User can place anything inside this body slot.\n *\n * @event shown - (React: onShown) This event is triggered when the accordion button is expanded.\n *\n * @cssproperty --mdc-accordionbutton-border-color - The border color of the accordion button.\n * @cssproperty --mdc-accordionbutton-hover-color - The hover color of the accordion button.\n * @cssproperty --mdc-accordionbutton-active-color - The active color of the accordion button.\n * @cssproperty --mdc-accordionbutton-disabled-color - The disabled color of the accordion button.\n *\n * @csspart header-section - The header section of the accordion button.\n * @csspart header-button-section - The header button section of the accordion button.\n * @csspart leading-header - The leading header of the accordion button.\n * @csspart trailing-header - The trailing header of the accordion button.\n * @csspart trailing-header__icon - The trailing header icon of the accordion button.\n * @csspart body-section - The body section of the accordion button.\n */",
|
806
806
|
"customElement": true
|
807
807
|
}
|
808
808
|
],
|
@@ -823,7 +823,7 @@
|
|
823
823
|
"declarations": [
|
824
824
|
{
|
825
825
|
"kind": "class",
|
826
|
-
"description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.",
|
826
|
+
"description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
|
827
827
|
"name": "AccordionGroup",
|
828
828
|
"cssProperties": [
|
829
829
|
{
|
@@ -953,7 +953,7 @@
|
|
953
953
|
"module": "/src/models"
|
954
954
|
},
|
955
955
|
"tagName": "mdc-accordiongroup",
|
956
|
-
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
956
|
+
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
957
957
|
"customElement": true
|
958
958
|
}
|
959
959
|
],
|
@@ -3064,6 +3064,181 @@
|
|
3064
3064
|
}
|
3065
3065
|
]
|
3066
3066
|
},
|
3067
|
+
{
|
3068
|
+
"kind": "javascript-module",
|
3069
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
3070
|
+
"declarations": [
|
3071
|
+
{
|
3072
|
+
"kind": "class",
|
3073
|
+
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
3074
|
+
"name": "Brandvisual",
|
3075
|
+
"members": [
|
3076
|
+
{
|
3077
|
+
"kind": "field",
|
3078
|
+
"name": "brandVisualData",
|
3079
|
+
"type": {
|
3080
|
+
"text": "HTMLElement | undefined"
|
3081
|
+
},
|
3082
|
+
"privacy": "private"
|
3083
|
+
},
|
3084
|
+
{
|
3085
|
+
"kind": "field",
|
3086
|
+
"name": "name",
|
3087
|
+
"type": {
|
3088
|
+
"text": "BrandVisualNames | undefined"
|
3089
|
+
},
|
3090
|
+
"description": "Name of the brandVisual (= filename)",
|
3091
|
+
"attribute": "name",
|
3092
|
+
"reflects": true
|
3093
|
+
},
|
3094
|
+
{
|
3095
|
+
"kind": "method",
|
3096
|
+
"name": "getBrandVisualData",
|
3097
|
+
"privacy": "private"
|
3098
|
+
},
|
3099
|
+
{
|
3100
|
+
"kind": "method",
|
3101
|
+
"name": "handleBrandVisualLoadedSuccess",
|
3102
|
+
"privacy": "private",
|
3103
|
+
"parameters": [
|
3104
|
+
{
|
3105
|
+
"name": "brandVisualHtml",
|
3106
|
+
"type": {
|
3107
|
+
"text": "HTMLElement"
|
3108
|
+
},
|
3109
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
3110
|
+
}
|
3111
|
+
],
|
3112
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
3113
|
+
},
|
3114
|
+
{
|
3115
|
+
"kind": "method",
|
3116
|
+
"name": "handleBrandVisualLoadedFailure",
|
3117
|
+
"privacy": "private",
|
3118
|
+
"parameters": [
|
3119
|
+
{
|
3120
|
+
"name": "error",
|
3121
|
+
"type": {
|
3122
|
+
"text": "unknown"
|
3123
|
+
}
|
3124
|
+
}
|
3125
|
+
],
|
3126
|
+
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
3127
|
+
}
|
3128
|
+
],
|
3129
|
+
"events": [
|
3130
|
+
{
|
3131
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
3132
|
+
"name": "load",
|
3133
|
+
"reactName": "onLoad"
|
3134
|
+
},
|
3135
|
+
{
|
3136
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
3137
|
+
"name": "error",
|
3138
|
+
"reactName": "onError"
|
3139
|
+
}
|
3140
|
+
],
|
3141
|
+
"attributes": [
|
3142
|
+
{
|
3143
|
+
"name": "name",
|
3144
|
+
"type": {
|
3145
|
+
"text": "BrandVisualNames | undefined"
|
3146
|
+
},
|
3147
|
+
"description": "Name of the brandVisual (= filename)",
|
3148
|
+
"fieldName": "name"
|
3149
|
+
}
|
3150
|
+
],
|
3151
|
+
"superclass": {
|
3152
|
+
"name": "Component",
|
3153
|
+
"module": "/src/models"
|
3154
|
+
},
|
3155
|
+
"tagName": "mdc-brandvisual",
|
3156
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
3157
|
+
"customElement": true
|
3158
|
+
}
|
3159
|
+
],
|
3160
|
+
"exports": [
|
3161
|
+
{
|
3162
|
+
"kind": "js",
|
3163
|
+
"name": "default",
|
3164
|
+
"declaration": {
|
3165
|
+
"name": "Brandvisual",
|
3166
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
3167
|
+
}
|
3168
|
+
}
|
3169
|
+
]
|
3170
|
+
},
|
3171
|
+
{
|
3172
|
+
"kind": "javascript-module",
|
3173
|
+
"path": "components/bullet/bullet.component.js",
|
3174
|
+
"declarations": [
|
3175
|
+
{
|
3176
|
+
"kind": "class",
|
3177
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
3178
|
+
"name": "Bullet",
|
3179
|
+
"cssProperties": [
|
3180
|
+
{
|
3181
|
+
"description": "background color of the bullet",
|
3182
|
+
"name": "--mdc-bullet-background-color"
|
3183
|
+
},
|
3184
|
+
{
|
3185
|
+
"description": "small size value of the bullet",
|
3186
|
+
"name": "--mdc-bullet-size-small"
|
3187
|
+
},
|
3188
|
+
{
|
3189
|
+
"description": "medium size value of the bullet",
|
3190
|
+
"name": "--mdc-bullet-size-medium"
|
3191
|
+
},
|
3192
|
+
{
|
3193
|
+
"description": "large size value of the bullet",
|
3194
|
+
"name": "--mdc-bullet-size-large"
|
3195
|
+
}
|
3196
|
+
],
|
3197
|
+
"members": [
|
3198
|
+
{
|
3199
|
+
"kind": "field",
|
3200
|
+
"name": "size",
|
3201
|
+
"type": {
|
3202
|
+
"text": "Size"
|
3203
|
+
},
|
3204
|
+
"privacy": "public",
|
3205
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
3206
|
+
"default": "small",
|
3207
|
+
"attribute": "size",
|
3208
|
+
"reflects": true
|
3209
|
+
}
|
3210
|
+
],
|
3211
|
+
"attributes": [
|
3212
|
+
{
|
3213
|
+
"name": "size",
|
3214
|
+
"type": {
|
3215
|
+
"text": "Size"
|
3216
|
+
},
|
3217
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
3218
|
+
"default": "small",
|
3219
|
+
"fieldName": "size"
|
3220
|
+
}
|
3221
|
+
],
|
3222
|
+
"superclass": {
|
3223
|
+
"name": "Component",
|
3224
|
+
"module": "/src/models"
|
3225
|
+
},
|
3226
|
+
"tagName": "mdc-bullet",
|
3227
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
|
3228
|
+
"customElement": true
|
3229
|
+
}
|
3230
|
+
],
|
3231
|
+
"exports": [
|
3232
|
+
{
|
3233
|
+
"kind": "js",
|
3234
|
+
"name": "default",
|
3235
|
+
"declaration": {
|
3236
|
+
"name": "Bullet",
|
3237
|
+
"module": "components/bullet/bullet.component.js"
|
3238
|
+
}
|
3239
|
+
}
|
3240
|
+
]
|
3241
|
+
},
|
3067
3242
|
{
|
3068
3243
|
"kind": "javascript-module",
|
3069
3244
|
"path": "components/button/button.component.js",
|
@@ -3759,181 +3934,6 @@
|
|
3759
3934
|
}
|
3760
3935
|
]
|
3761
3936
|
},
|
3762
|
-
{
|
3763
|
-
"kind": "javascript-module",
|
3764
|
-
"path": "components/bullet/bullet.component.js",
|
3765
|
-
"declarations": [
|
3766
|
-
{
|
3767
|
-
"kind": "class",
|
3768
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
3769
|
-
"name": "Bullet",
|
3770
|
-
"cssProperties": [
|
3771
|
-
{
|
3772
|
-
"description": "background color of the bullet",
|
3773
|
-
"name": "--mdc-bullet-background-color"
|
3774
|
-
},
|
3775
|
-
{
|
3776
|
-
"description": "small size value of the bullet",
|
3777
|
-
"name": "--mdc-bullet-size-small"
|
3778
|
-
},
|
3779
|
-
{
|
3780
|
-
"description": "medium size value of the bullet",
|
3781
|
-
"name": "--mdc-bullet-size-medium"
|
3782
|
-
},
|
3783
|
-
{
|
3784
|
-
"description": "large size value of the bullet",
|
3785
|
-
"name": "--mdc-bullet-size-large"
|
3786
|
-
}
|
3787
|
-
],
|
3788
|
-
"members": [
|
3789
|
-
{
|
3790
|
-
"kind": "field",
|
3791
|
-
"name": "size",
|
3792
|
-
"type": {
|
3793
|
-
"text": "Size"
|
3794
|
-
},
|
3795
|
-
"privacy": "public",
|
3796
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
3797
|
-
"default": "small",
|
3798
|
-
"attribute": "size",
|
3799
|
-
"reflects": true
|
3800
|
-
}
|
3801
|
-
],
|
3802
|
-
"attributes": [
|
3803
|
-
{
|
3804
|
-
"name": "size",
|
3805
|
-
"type": {
|
3806
|
-
"text": "Size"
|
3807
|
-
},
|
3808
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
3809
|
-
"default": "small",
|
3810
|
-
"fieldName": "size"
|
3811
|
-
}
|
3812
|
-
],
|
3813
|
-
"superclass": {
|
3814
|
-
"name": "Component",
|
3815
|
-
"module": "/src/models"
|
3816
|
-
},
|
3817
|
-
"tagName": "mdc-bullet",
|
3818
|
-
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
|
3819
|
-
"customElement": true
|
3820
|
-
}
|
3821
|
-
],
|
3822
|
-
"exports": [
|
3823
|
-
{
|
3824
|
-
"kind": "js",
|
3825
|
-
"name": "default",
|
3826
|
-
"declaration": {
|
3827
|
-
"name": "Bullet",
|
3828
|
-
"module": "components/bullet/bullet.component.js"
|
3829
|
-
}
|
3830
|
-
}
|
3831
|
-
]
|
3832
|
-
},
|
3833
|
-
{
|
3834
|
-
"kind": "javascript-module",
|
3835
|
-
"path": "components/brandvisual/brandvisual.component.js",
|
3836
|
-
"declarations": [
|
3837
|
-
{
|
3838
|
-
"kind": "class",
|
3839
|
-
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
3840
|
-
"name": "Brandvisual",
|
3841
|
-
"members": [
|
3842
|
-
{
|
3843
|
-
"kind": "field",
|
3844
|
-
"name": "brandVisualData",
|
3845
|
-
"type": {
|
3846
|
-
"text": "HTMLElement | undefined"
|
3847
|
-
},
|
3848
|
-
"privacy": "private"
|
3849
|
-
},
|
3850
|
-
{
|
3851
|
-
"kind": "field",
|
3852
|
-
"name": "name",
|
3853
|
-
"type": {
|
3854
|
-
"text": "BrandVisualNames | undefined"
|
3855
|
-
},
|
3856
|
-
"description": "Name of the brandVisual (= filename)",
|
3857
|
-
"attribute": "name",
|
3858
|
-
"reflects": true
|
3859
|
-
},
|
3860
|
-
{
|
3861
|
-
"kind": "method",
|
3862
|
-
"name": "getBrandVisualData",
|
3863
|
-
"privacy": "private"
|
3864
|
-
},
|
3865
|
-
{
|
3866
|
-
"kind": "method",
|
3867
|
-
"name": "handleBrandVisualLoadedSuccess",
|
3868
|
-
"privacy": "private",
|
3869
|
-
"parameters": [
|
3870
|
-
{
|
3871
|
-
"name": "brandVisualHtml",
|
3872
|
-
"type": {
|
3873
|
-
"text": "HTMLElement"
|
3874
|
-
},
|
3875
|
-
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
3876
|
-
}
|
3877
|
-
],
|
3878
|
-
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
3879
|
-
},
|
3880
|
-
{
|
3881
|
-
"kind": "method",
|
3882
|
-
"name": "handleBrandVisualLoadedFailure",
|
3883
|
-
"privacy": "private",
|
3884
|
-
"parameters": [
|
3885
|
-
{
|
3886
|
-
"name": "error",
|
3887
|
-
"type": {
|
3888
|
-
"text": "unknown"
|
3889
|
-
}
|
3890
|
-
}
|
3891
|
-
],
|
3892
|
-
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
3893
|
-
}
|
3894
|
-
],
|
3895
|
-
"events": [
|
3896
|
-
{
|
3897
|
-
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
3898
|
-
"name": "load",
|
3899
|
-
"reactName": "onLoad"
|
3900
|
-
},
|
3901
|
-
{
|
3902
|
-
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
3903
|
-
"name": "error",
|
3904
|
-
"reactName": "onError"
|
3905
|
-
}
|
3906
|
-
],
|
3907
|
-
"attributes": [
|
3908
|
-
{
|
3909
|
-
"name": "name",
|
3910
|
-
"type": {
|
3911
|
-
"text": "BrandVisualNames | undefined"
|
3912
|
-
},
|
3913
|
-
"description": "Name of the brandVisual (= filename)",
|
3914
|
-
"fieldName": "name"
|
3915
|
-
}
|
3916
|
-
],
|
3917
|
-
"superclass": {
|
3918
|
-
"name": "Component",
|
3919
|
-
"module": "/src/models"
|
3920
|
-
},
|
3921
|
-
"tagName": "mdc-brandvisual",
|
3922
|
-
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
3923
|
-
"customElement": true
|
3924
|
-
}
|
3925
|
-
],
|
3926
|
-
"exports": [
|
3927
|
-
{
|
3928
|
-
"kind": "js",
|
3929
|
-
"name": "default",
|
3930
|
-
"declaration": {
|
3931
|
-
"name": "Brandvisual",
|
3932
|
-
"module": "components/brandvisual/brandvisual.component.js"
|
3933
|
-
}
|
3934
|
-
}
|
3935
|
-
]
|
3936
|
-
},
|
3937
3937
|
{
|
3938
3938
|
"kind": "javascript-module",
|
3939
3939
|
"path": "components/buttongroup/buttongroup.component.js",
|
@@ -17803,15 +17803,15 @@
|
|
17803
17803
|
},
|
17804
17804
|
{
|
17805
17805
|
"kind": "javascript-module",
|
17806
|
-
"path": "components/
|
17806
|
+
"path": "components/menuitem/menuitem.component.js",
|
17807
17807
|
"declarations": [
|
17808
17808
|
{
|
17809
17809
|
"kind": "class",
|
17810
|
-
"description": "
|
17811
|
-
"name": "
|
17810
|
+
"description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
|
17811
|
+
"name": "MenuItem",
|
17812
17812
|
"slots": [
|
17813
17813
|
{
|
17814
|
-
"description": "slot for menu item
|
17814
|
+
"description": "slot for menu item controls to appear of leading end.",
|
17815
17815
|
"name": "leading-controls",
|
17816
17816
|
"inheritedFrom": {
|
17817
17817
|
"name": "ListItem",
|
@@ -17819,7 +17819,7 @@
|
|
17819
17819
|
}
|
17820
17820
|
},
|
17821
17821
|
{
|
17822
|
-
"description": "slot for menu item
|
17822
|
+
"description": "slot for menu item primary label.",
|
17823
17823
|
"name": "leading-text-primary-label",
|
17824
17824
|
"inheritedFrom": {
|
17825
17825
|
"name": "ListItem",
|
@@ -17827,7 +17827,7 @@
|
|
17827
17827
|
}
|
17828
17828
|
},
|
17829
17829
|
{
|
17830
|
-
"description": "slot for menu item
|
17830
|
+
"description": "slot for menu item secondary label.",
|
17831
17831
|
"name": "leading-text-secondary-label",
|
17832
17832
|
"inheritedFrom": {
|
17833
17833
|
"name": "ListItem",
|
@@ -17835,7 +17835,7 @@
|
|
17835
17835
|
}
|
17836
17836
|
},
|
17837
17837
|
{
|
17838
|
-
"description": "slot for menu item
|
17838
|
+
"description": "slot for menu item tertiary label.",
|
17839
17839
|
"name": "leading-text-tertiary-label",
|
17840
17840
|
"inheritedFrom": {
|
17841
17841
|
"name": "ListItem",
|
@@ -17843,7 +17843,7 @@
|
|
17843
17843
|
}
|
17844
17844
|
},
|
17845
17845
|
{
|
17846
|
-
"description": "slot for menu item
|
17846
|
+
"description": "slot for menu item side header text.",
|
17847
17847
|
"name": "trailing-text-side-header",
|
17848
17848
|
"inheritedFrom": {
|
17849
17849
|
"name": "ListItem",
|
@@ -17851,7 +17851,7 @@
|
|
17851
17851
|
}
|
17852
17852
|
},
|
17853
17853
|
{
|
17854
|
-
"description": "slot for menu item
|
17854
|
+
"description": "slot for menu item subline text.",
|
17855
17855
|
"name": "trailing-text-subline",
|
17856
17856
|
"inheritedFrom": {
|
17857
17857
|
"name": "ListItem",
|
@@ -17859,7 +17859,7 @@
|
|
17859
17859
|
}
|
17860
17860
|
},
|
17861
17861
|
{
|
17862
|
-
"description": "slot for menu item
|
17862
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
17863
17863
|
"name": "trailing-controls",
|
17864
17864
|
"inheritedFrom": {
|
17865
17865
|
"name": "ListItem",
|
@@ -17868,67 +17868,6 @@
|
|
17868
17868
|
}
|
17869
17869
|
],
|
17870
17870
|
"members": [
|
17871
|
-
{
|
17872
|
-
"kind": "field",
|
17873
|
-
"name": "checked",
|
17874
|
-
"type": {
|
17875
|
-
"text": "boolean"
|
17876
|
-
},
|
17877
|
-
"default": "false",
|
17878
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
17879
|
-
"attribute": "checked",
|
17880
|
-
"reflects": true
|
17881
|
-
},
|
17882
|
-
{
|
17883
|
-
"kind": "field",
|
17884
|
-
"name": "indicator",
|
17885
|
-
"type": {
|
17886
|
-
"text": "Indicator"
|
17887
|
-
},
|
17888
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
17889
|
-
"default": "'checkbox'",
|
17890
|
-
"attribute": "indicator",
|
17891
|
-
"reflects": true
|
17892
|
-
},
|
17893
|
-
{
|
17894
|
-
"kind": "method",
|
17895
|
-
"name": "handleMouseClick",
|
17896
|
-
"privacy": "private",
|
17897
|
-
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
17898
|
-
},
|
17899
|
-
{
|
17900
|
-
"kind": "method",
|
17901
|
-
"name": "staticCheckbox",
|
17902
|
-
"privacy": "private",
|
17903
|
-
"return": {
|
17904
|
-
"type": {
|
17905
|
-
"text": ""
|
17906
|
-
}
|
17907
|
-
},
|
17908
|
-
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
17909
|
-
},
|
17910
|
-
{
|
17911
|
-
"kind": "method",
|
17912
|
-
"name": "staticToggle",
|
17913
|
-
"privacy": "private",
|
17914
|
-
"return": {
|
17915
|
-
"type": {
|
17916
|
-
"text": ""
|
17917
|
-
}
|
17918
|
-
},
|
17919
|
-
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
17920
|
-
},
|
17921
|
-
{
|
17922
|
-
"kind": "method",
|
17923
|
-
"name": "getCheckmarkIcon",
|
17924
|
-
"privacy": "private",
|
17925
|
-
"return": {
|
17926
|
-
"type": {
|
17927
|
-
"text": ""
|
17928
|
-
}
|
17929
|
-
},
|
17930
|
-
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
17931
|
-
},
|
17932
17871
|
{
|
17933
17872
|
"kind": "field",
|
17934
17873
|
"name": "arrowPosition",
|
@@ -17937,11 +17876,7 @@
|
|
17937
17876
|
},
|
17938
17877
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
17939
17878
|
"attribute": "arrow-position",
|
17940
|
-
"reflects": true
|
17941
|
-
"inheritedFrom": {
|
17942
|
-
"name": "MenuItem",
|
17943
|
-
"module": "components/menuitem/menuitem.component.js"
|
17944
|
-
}
|
17879
|
+
"reflects": true
|
17945
17880
|
},
|
17946
17881
|
{
|
17947
17882
|
"kind": "field",
|
@@ -17951,11 +17886,7 @@
|
|
17951
17886
|
},
|
17952
17887
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
17953
17888
|
"attribute": "arrow-direction",
|
17954
|
-
"reflects": true
|
17955
|
-
"inheritedFrom": {
|
17956
|
-
"name": "MenuItem",
|
17957
|
-
"module": "components/menuitem/menuitem.component.js"
|
17958
|
-
}
|
17889
|
+
"reflects": true
|
17959
17890
|
},
|
17960
17891
|
{
|
17961
17892
|
"kind": "field",
|
@@ -17966,11 +17897,7 @@
|
|
17966
17897
|
"default": "undefined",
|
17967
17898
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
17968
17899
|
"attribute": "name",
|
17969
|
-
"reflects": true
|
17970
|
-
"inheritedFrom": {
|
17971
|
-
"name": "MenuItem",
|
17972
|
-
"module": "components/menuitem/menuitem.component.js"
|
17973
|
-
}
|
17900
|
+
"reflects": true
|
17974
17901
|
},
|
17975
17902
|
{
|
17976
17903
|
"kind": "field",
|
@@ -17981,11 +17908,7 @@
|
|
17981
17908
|
"default": "undefined",
|
17982
17909
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
17983
17910
|
"attribute": "value",
|
17984
|
-
"reflects": true
|
17985
|
-
"inheritedFrom": {
|
17986
|
-
"name": "MenuItem",
|
17987
|
-
"module": "components/menuitem/menuitem.component.js"
|
17988
|
-
}
|
17911
|
+
"reflects": true
|
17989
17912
|
},
|
17990
17913
|
{
|
17991
17914
|
"kind": "method",
|
@@ -18029,11 +17952,7 @@
|
|
18029
17952
|
"description": "The keyboard event that triggered the action."
|
18030
17953
|
}
|
18031
17954
|
],
|
18032
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
18033
|
-
"inheritedFrom": {
|
18034
|
-
"name": "MenuItem",
|
18035
|
-
"module": "components/menuitem/menuitem.component.js"
|
18036
|
-
}
|
17955
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
18037
17956
|
},
|
18038
17957
|
{
|
18039
17958
|
"kind": "method",
|
@@ -18370,15 +18289,7 @@
|
|
18370
18289
|
],
|
18371
18290
|
"events": [
|
18372
18291
|
{
|
18373
|
-
"
|
18374
|
-
"type": {
|
18375
|
-
"text": "Event"
|
18376
|
-
},
|
18377
|
-
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
18378
|
-
"reactName": "onChange"
|
18379
|
-
},
|
18380
|
-
{
|
18381
|
-
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
18292
|
+
"description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
|
18382
18293
|
"name": "click",
|
18383
18294
|
"reactName": "onClick",
|
18384
18295
|
"inheritedFrom": {
|
@@ -18386,15 +18297,6 @@
|
|
18386
18297
|
"module": "src/components/listitem/listitem.component.ts"
|
18387
18298
|
}
|
18388
18299
|
},
|
18389
|
-
{
|
18390
|
-
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
18391
|
-
"name": "focus",
|
18392
|
-
"reactName": "onFocus",
|
18393
|
-
"inheritedFrom": {
|
18394
|
-
"name": "ListItem",
|
18395
|
-
"module": "src/components/listitem/listitem.component.ts"
|
18396
|
-
}
|
18397
|
-
},
|
18398
18300
|
{
|
18399
18301
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
18400
18302
|
"name": "keydown",
|
@@ -18413,6 +18315,15 @@
|
|
18413
18315
|
"module": "src/components/listitem/listitem.component.ts"
|
18414
18316
|
}
|
18415
18317
|
},
|
18318
|
+
{
|
18319
|
+
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
18320
|
+
"name": "focus",
|
18321
|
+
"reactName": "onFocus",
|
18322
|
+
"inheritedFrom": {
|
18323
|
+
"name": "ListItem",
|
18324
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18325
|
+
}
|
18326
|
+
},
|
18416
18327
|
{
|
18417
18328
|
"description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
|
18418
18329
|
"name": "enabled",
|
@@ -18451,35 +18362,13 @@
|
|
18451
18362
|
}
|
18452
18363
|
],
|
18453
18364
|
"attributes": [
|
18454
|
-
{
|
18455
|
-
"name": "checked",
|
18456
|
-
"type": {
|
18457
|
-
"text": "boolean"
|
18458
|
-
},
|
18459
|
-
"default": "false",
|
18460
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
18461
|
-
"fieldName": "checked"
|
18462
|
-
},
|
18463
|
-
{
|
18464
|
-
"name": "indicator",
|
18465
|
-
"type": {
|
18466
|
-
"text": "Indicator"
|
18467
|
-
},
|
18468
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
18469
|
-
"default": "'checkbox'",
|
18470
|
-
"fieldName": "indicator"
|
18471
|
-
},
|
18472
18365
|
{
|
18473
18366
|
"name": "arrow-position",
|
18474
18367
|
"type": {
|
18475
18368
|
"text": "ArrowPositions | undefined"
|
18476
18369
|
},
|
18477
18370
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
18478
|
-
"fieldName": "arrowPosition"
|
18479
|
-
"inheritedFrom": {
|
18480
|
-
"name": "MenuItem",
|
18481
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
18482
|
-
}
|
18371
|
+
"fieldName": "arrowPosition"
|
18483
18372
|
},
|
18484
18373
|
{
|
18485
18374
|
"name": "arrow-direction",
|
@@ -18487,11 +18376,7 @@
|
|
18487
18376
|
"text": "ArrowDirections | undefined"
|
18488
18377
|
},
|
18489
18378
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
18490
|
-
"fieldName": "arrowDirection"
|
18491
|
-
"inheritedFrom": {
|
18492
|
-
"name": "MenuItem",
|
18493
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
18494
|
-
}
|
18379
|
+
"fieldName": "arrowDirection"
|
18495
18380
|
},
|
18496
18381
|
{
|
18497
18382
|
"name": "name",
|
@@ -18500,11 +18385,7 @@
|
|
18500
18385
|
},
|
18501
18386
|
"default": "undefined",
|
18502
18387
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
18503
|
-
"fieldName": "name"
|
18504
|
-
"inheritedFrom": {
|
18505
|
-
"name": "MenuItem",
|
18506
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
18507
|
-
}
|
18388
|
+
"fieldName": "name"
|
18508
18389
|
},
|
18509
18390
|
{
|
18510
18391
|
"name": "value",
|
@@ -18513,11 +18394,7 @@
|
|
18513
18394
|
},
|
18514
18395
|
"default": "undefined",
|
18515
18396
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
18516
|
-
"fieldName": "value"
|
18517
|
-
"inheritedFrom": {
|
18518
|
-
"name": "MenuItem",
|
18519
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
18520
|
-
}
|
18397
|
+
"fieldName": "value"
|
18521
18398
|
},
|
18522
18399
|
{
|
18523
18400
|
"name": "disabled",
|
@@ -18658,11 +18535,11 @@
|
|
18658
18535
|
}
|
18659
18536
|
],
|
18660
18537
|
"superclass": {
|
18661
|
-
"name": "
|
18662
|
-
"module": "/src/components/
|
18538
|
+
"name": "ListItem",
|
18539
|
+
"module": "/src/components/listitem/listitem.component"
|
18663
18540
|
},
|
18664
|
-
"tagName": "mdc-
|
18665
|
-
"jsDoc": "/**\n *
|
18541
|
+
"tagName": "mdc-menuitem",
|
18542
|
+
"jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
|
18666
18543
|
"customElement": true,
|
18667
18544
|
"cssProperties": [
|
18668
18545
|
{
|
@@ -18737,23 +18614,23 @@
|
|
18737
18614
|
"kind": "js",
|
18738
18615
|
"name": "default",
|
18739
18616
|
"declaration": {
|
18740
|
-
"name": "
|
18741
|
-
"module": "components/
|
18617
|
+
"name": "MenuItem",
|
18618
|
+
"module": "components/menuitem/menuitem.component.js"
|
18742
18619
|
}
|
18743
18620
|
}
|
18744
18621
|
]
|
18745
18622
|
},
|
18746
18623
|
{
|
18747
18624
|
"kind": "javascript-module",
|
18748
|
-
"path": "components/
|
18625
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
18749
18626
|
"declarations": [
|
18750
18627
|
{
|
18751
18628
|
"kind": "class",
|
18752
|
-
"description": "
|
18753
|
-
"name": "
|
18629
|
+
"description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
|
18630
|
+
"name": "MenuItemCheckbox",
|
18754
18631
|
"slots": [
|
18755
18632
|
{
|
18756
|
-
"description": "slot for menu item controls to appear of leading end.",
|
18633
|
+
"description": "slot for menu item checkbox controls to appear of leading end.",
|
18757
18634
|
"name": "leading-controls",
|
18758
18635
|
"inheritedFrom": {
|
18759
18636
|
"name": "ListItem",
|
@@ -18761,7 +18638,7 @@
|
|
18761
18638
|
}
|
18762
18639
|
},
|
18763
18640
|
{
|
18764
|
-
"description": "slot for menu item primary label.",
|
18641
|
+
"description": "slot for menu item checkbox primary label.",
|
18765
18642
|
"name": "leading-text-primary-label",
|
18766
18643
|
"inheritedFrom": {
|
18767
18644
|
"name": "ListItem",
|
@@ -18769,7 +18646,7 @@
|
|
18769
18646
|
}
|
18770
18647
|
},
|
18771
18648
|
{
|
18772
|
-
"description": "slot for menu item secondary label.",
|
18649
|
+
"description": "slot for menu item checkbox secondary label.",
|
18773
18650
|
"name": "leading-text-secondary-label",
|
18774
18651
|
"inheritedFrom": {
|
18775
18652
|
"name": "ListItem",
|
@@ -18777,7 +18654,7 @@
|
|
18777
18654
|
}
|
18778
18655
|
},
|
18779
18656
|
{
|
18780
|
-
"description": "slot for menu item tertiary label.",
|
18657
|
+
"description": "slot for menu item checkbox tertiary label.",
|
18781
18658
|
"name": "leading-text-tertiary-label",
|
18782
18659
|
"inheritedFrom": {
|
18783
18660
|
"name": "ListItem",
|
@@ -18785,7 +18662,7 @@
|
|
18785
18662
|
}
|
18786
18663
|
},
|
18787
18664
|
{
|
18788
|
-
"description": "slot for menu item side header text.",
|
18665
|
+
"description": "slot for menu item checkbox side header text.",
|
18789
18666
|
"name": "trailing-text-side-header",
|
18790
18667
|
"inheritedFrom": {
|
18791
18668
|
"name": "ListItem",
|
@@ -18793,7 +18670,7 @@
|
|
18793
18670
|
}
|
18794
18671
|
},
|
18795
18672
|
{
|
18796
|
-
"description": "slot for menu item subline text.",
|
18673
|
+
"description": "slot for menu item checkbox subline text.",
|
18797
18674
|
"name": "trailing-text-subline",
|
18798
18675
|
"inheritedFrom": {
|
18799
18676
|
"name": "ListItem",
|
@@ -18801,7 +18678,7 @@
|
|
18801
18678
|
}
|
18802
18679
|
},
|
18803
18680
|
{
|
18804
|
-
"description": "slot for menu item controls to appear of trailing end.",
|
18681
|
+
"description": "slot for menu item checkbox controls to appear of trailing end.",
|
18805
18682
|
"name": "trailing-controls",
|
18806
18683
|
"inheritedFrom": {
|
18807
18684
|
"name": "ListItem",
|
@@ -18810,6 +18687,67 @@
|
|
18810
18687
|
}
|
18811
18688
|
],
|
18812
18689
|
"members": [
|
18690
|
+
{
|
18691
|
+
"kind": "field",
|
18692
|
+
"name": "checked",
|
18693
|
+
"type": {
|
18694
|
+
"text": "boolean"
|
18695
|
+
},
|
18696
|
+
"default": "false",
|
18697
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
18698
|
+
"attribute": "checked",
|
18699
|
+
"reflects": true
|
18700
|
+
},
|
18701
|
+
{
|
18702
|
+
"kind": "field",
|
18703
|
+
"name": "indicator",
|
18704
|
+
"type": {
|
18705
|
+
"text": "Indicator"
|
18706
|
+
},
|
18707
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
18708
|
+
"default": "'checkbox'",
|
18709
|
+
"attribute": "indicator",
|
18710
|
+
"reflects": true
|
18711
|
+
},
|
18712
|
+
{
|
18713
|
+
"kind": "method",
|
18714
|
+
"name": "handleMouseClick",
|
18715
|
+
"privacy": "private",
|
18716
|
+
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
18717
|
+
},
|
18718
|
+
{
|
18719
|
+
"kind": "method",
|
18720
|
+
"name": "staticCheckbox",
|
18721
|
+
"privacy": "private",
|
18722
|
+
"return": {
|
18723
|
+
"type": {
|
18724
|
+
"text": ""
|
18725
|
+
}
|
18726
|
+
},
|
18727
|
+
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
18728
|
+
},
|
18729
|
+
{
|
18730
|
+
"kind": "method",
|
18731
|
+
"name": "staticToggle",
|
18732
|
+
"privacy": "private",
|
18733
|
+
"return": {
|
18734
|
+
"type": {
|
18735
|
+
"text": ""
|
18736
|
+
}
|
18737
|
+
},
|
18738
|
+
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
18739
|
+
},
|
18740
|
+
{
|
18741
|
+
"kind": "method",
|
18742
|
+
"name": "getCheckmarkIcon",
|
18743
|
+
"privacy": "private",
|
18744
|
+
"return": {
|
18745
|
+
"type": {
|
18746
|
+
"text": ""
|
18747
|
+
}
|
18748
|
+
},
|
18749
|
+
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
18750
|
+
},
|
18813
18751
|
{
|
18814
18752
|
"kind": "field",
|
18815
18753
|
"name": "arrowPosition",
|
@@ -18818,7 +18756,11 @@
|
|
18818
18756
|
},
|
18819
18757
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
18820
18758
|
"attribute": "arrow-position",
|
18821
|
-
"reflects": true
|
18759
|
+
"reflects": true,
|
18760
|
+
"inheritedFrom": {
|
18761
|
+
"name": "MenuItem",
|
18762
|
+
"module": "components/menuitem/menuitem.component.js"
|
18763
|
+
}
|
18822
18764
|
},
|
18823
18765
|
{
|
18824
18766
|
"kind": "field",
|
@@ -18828,7 +18770,11 @@
|
|
18828
18770
|
},
|
18829
18771
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
18830
18772
|
"attribute": "arrow-direction",
|
18831
|
-
"reflects": true
|
18773
|
+
"reflects": true,
|
18774
|
+
"inheritedFrom": {
|
18775
|
+
"name": "MenuItem",
|
18776
|
+
"module": "components/menuitem/menuitem.component.js"
|
18777
|
+
}
|
18832
18778
|
},
|
18833
18779
|
{
|
18834
18780
|
"kind": "field",
|
@@ -18839,7 +18785,11 @@
|
|
18839
18785
|
"default": "undefined",
|
18840
18786
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
18841
18787
|
"attribute": "name",
|
18842
|
-
"reflects": true
|
18788
|
+
"reflects": true,
|
18789
|
+
"inheritedFrom": {
|
18790
|
+
"name": "MenuItem",
|
18791
|
+
"module": "components/menuitem/menuitem.component.js"
|
18792
|
+
}
|
18843
18793
|
},
|
18844
18794
|
{
|
18845
18795
|
"kind": "field",
|
@@ -18850,7 +18800,11 @@
|
|
18850
18800
|
"default": "undefined",
|
18851
18801
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
18852
18802
|
"attribute": "value",
|
18853
|
-
"reflects": true
|
18803
|
+
"reflects": true,
|
18804
|
+
"inheritedFrom": {
|
18805
|
+
"name": "MenuItem",
|
18806
|
+
"module": "components/menuitem/menuitem.component.js"
|
18807
|
+
}
|
18854
18808
|
},
|
18855
18809
|
{
|
18856
18810
|
"kind": "method",
|
@@ -18894,7 +18848,11 @@
|
|
18894
18848
|
"description": "The keyboard event that triggered the action."
|
18895
18849
|
}
|
18896
18850
|
],
|
18897
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
18851
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
18852
|
+
"inheritedFrom": {
|
18853
|
+
"name": "MenuItem",
|
18854
|
+
"module": "components/menuitem/menuitem.component.js"
|
18855
|
+
}
|
18898
18856
|
},
|
18899
18857
|
{
|
18900
18858
|
"kind": "method",
|
@@ -19231,7 +19189,15 @@
|
|
19231
19189
|
],
|
19232
19190
|
"events": [
|
19233
19191
|
{
|
19234
|
-
"
|
19192
|
+
"name": "change",
|
19193
|
+
"type": {
|
19194
|
+
"text": "Event"
|
19195
|
+
},
|
19196
|
+
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
19197
|
+
"reactName": "onChange"
|
19198
|
+
},
|
19199
|
+
{
|
19200
|
+
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
19235
19201
|
"name": "click",
|
19236
19202
|
"reactName": "onClick",
|
19237
19203
|
"inheritedFrom": {
|
@@ -19240,27 +19206,27 @@
|
|
19240
19206
|
}
|
19241
19207
|
},
|
19242
19208
|
{
|
19243
|
-
"description": "(React:
|
19244
|
-
"name": "
|
19245
|
-
"reactName": "
|
19209
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
19210
|
+
"name": "focus",
|
19211
|
+
"reactName": "onFocus",
|
19246
19212
|
"inheritedFrom": {
|
19247
19213
|
"name": "ListItem",
|
19248
19214
|
"module": "src/components/listitem/listitem.component.ts"
|
19249
19215
|
}
|
19250
19216
|
},
|
19251
19217
|
{
|
19252
|
-
"description": "(React:
|
19253
|
-
"name": "
|
19254
|
-
"reactName": "
|
19218
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
19219
|
+
"name": "keydown",
|
19220
|
+
"reactName": "onKeyDown",
|
19255
19221
|
"inheritedFrom": {
|
19256
19222
|
"name": "ListItem",
|
19257
19223
|
"module": "src/components/listitem/listitem.component.ts"
|
19258
19224
|
}
|
19259
19225
|
},
|
19260
19226
|
{
|
19261
|
-
"description": "(React:
|
19262
|
-
"name": "
|
19263
|
-
"reactName": "
|
19227
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
|
19228
|
+
"name": "keyup",
|
19229
|
+
"reactName": "onKeyUp",
|
19264
19230
|
"inheritedFrom": {
|
19265
19231
|
"name": "ListItem",
|
19266
19232
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -19304,13 +19270,35 @@
|
|
19304
19270
|
}
|
19305
19271
|
],
|
19306
19272
|
"attributes": [
|
19273
|
+
{
|
19274
|
+
"name": "checked",
|
19275
|
+
"type": {
|
19276
|
+
"text": "boolean"
|
19277
|
+
},
|
19278
|
+
"default": "false",
|
19279
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
19280
|
+
"fieldName": "checked"
|
19281
|
+
},
|
19282
|
+
{
|
19283
|
+
"name": "indicator",
|
19284
|
+
"type": {
|
19285
|
+
"text": "Indicator"
|
19286
|
+
},
|
19287
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
19288
|
+
"default": "'checkbox'",
|
19289
|
+
"fieldName": "indicator"
|
19290
|
+
},
|
19307
19291
|
{
|
19308
19292
|
"name": "arrow-position",
|
19309
19293
|
"type": {
|
19310
19294
|
"text": "ArrowPositions | undefined"
|
19311
19295
|
},
|
19312
19296
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
19313
|
-
"fieldName": "arrowPosition"
|
19297
|
+
"fieldName": "arrowPosition",
|
19298
|
+
"inheritedFrom": {
|
19299
|
+
"name": "MenuItem",
|
19300
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
19301
|
+
}
|
19314
19302
|
},
|
19315
19303
|
{
|
19316
19304
|
"name": "arrow-direction",
|
@@ -19318,7 +19306,11 @@
|
|
19318
19306
|
"text": "ArrowDirections | undefined"
|
19319
19307
|
},
|
19320
19308
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
19321
|
-
"fieldName": "arrowDirection"
|
19309
|
+
"fieldName": "arrowDirection",
|
19310
|
+
"inheritedFrom": {
|
19311
|
+
"name": "MenuItem",
|
19312
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
19313
|
+
}
|
19322
19314
|
},
|
19323
19315
|
{
|
19324
19316
|
"name": "name",
|
@@ -19327,7 +19319,11 @@
|
|
19327
19319
|
},
|
19328
19320
|
"default": "undefined",
|
19329
19321
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
19330
|
-
"fieldName": "name"
|
19322
|
+
"fieldName": "name",
|
19323
|
+
"inheritedFrom": {
|
19324
|
+
"name": "MenuItem",
|
19325
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
19326
|
+
}
|
19331
19327
|
},
|
19332
19328
|
{
|
19333
19329
|
"name": "value",
|
@@ -19336,7 +19332,11 @@
|
|
19336
19332
|
},
|
19337
19333
|
"default": "undefined",
|
19338
19334
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
19339
|
-
"fieldName": "value"
|
19335
|
+
"fieldName": "value",
|
19336
|
+
"inheritedFrom": {
|
19337
|
+
"name": "MenuItem",
|
19338
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
19339
|
+
}
|
19340
19340
|
},
|
19341
19341
|
{
|
19342
19342
|
"name": "disabled",
|
@@ -19477,11 +19477,11 @@
|
|
19477
19477
|
}
|
19478
19478
|
],
|
19479
19479
|
"superclass": {
|
19480
|
-
"name": "
|
19481
|
-
"module": "/src/components/
|
19480
|
+
"name": "MenuItem",
|
19481
|
+
"module": "/src/components/menuitem/menuitem.component"
|
19482
19482
|
},
|
19483
|
-
"tagName": "mdc-
|
19484
|
-
"jsDoc": "/**\n *
|
19483
|
+
"tagName": "mdc-menuitemcheckbox",
|
19484
|
+
"jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
|
19485
19485
|
"customElement": true,
|
19486
19486
|
"cssProperties": [
|
19487
19487
|
{
|
@@ -19556,8 +19556,8 @@
|
|
19556
19556
|
"kind": "js",
|
19557
19557
|
"name": "default",
|
19558
19558
|
"declaration": {
|
19559
|
-
"name": "
|
19560
|
-
"module": "components/
|
19559
|
+
"name": "MenuItemCheckbox",
|
19560
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
19561
19561
|
}
|
19562
19562
|
}
|
19563
19563
|
]
|