@momentum-design/components 0.87.1 → 0.87.2
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/custom-elements.json +500 -500
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +3 -3
@@ -9479,252 +9479,6 @@
|
|
9479
9479
|
}
|
9480
9480
|
]
|
9481
9481
|
},
|
9482
|
-
{
|
9483
|
-
"kind": "javascript-module",
|
9484
|
-
"path": "components/divider/divider.component.js",
|
9485
|
-
"declarations": [
|
9486
|
-
{
|
9487
|
-
"kind": "class",
|
9488
|
-
"description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
|
9489
|
-
"name": "Divider",
|
9490
|
-
"cssProperties": [
|
9491
|
-
{
|
9492
|
-
"description": "background color of the divider",
|
9493
|
-
"name": "--mdc-divider-background-color"
|
9494
|
-
},
|
9495
|
-
{
|
9496
|
-
"description": "width of the divider",
|
9497
|
-
"name": "--mdc-divider-width"
|
9498
|
-
},
|
9499
|
-
{
|
9500
|
-
"description": "gradient of the horizontal divider",
|
9501
|
-
"name": "--mdc-divider-horizontal-gradient"
|
9502
|
-
},
|
9503
|
-
{
|
9504
|
-
"description": "gradient of the vertical divider",
|
9505
|
-
"name": "--mdc-divider-vertical-gradient"
|
9506
|
-
},
|
9507
|
-
{
|
9508
|
-
"description": "font size of label in the text divider",
|
9509
|
-
"name": "--mdc-divider-text-size"
|
9510
|
-
},
|
9511
|
-
{
|
9512
|
-
"description": "font color of label in the text divider",
|
9513
|
-
"name": "--mdc-divider-text-color"
|
9514
|
-
},
|
9515
|
-
{
|
9516
|
-
"description": "left and right margin of label in the text divider",
|
9517
|
-
"name": "--mdc-divider-text-margin"
|
9518
|
-
},
|
9519
|
-
{
|
9520
|
-
"description": "line height of label in the text divider",
|
9521
|
-
"name": "--mdc-divider-text-line-height"
|
9522
|
-
},
|
9523
|
-
{
|
9524
|
-
"description": "background color of the grabber button in rest state",
|
9525
|
-
"name": "--mdc-divider-grabber-button-background-color-normal"
|
9526
|
-
},
|
9527
|
-
{
|
9528
|
-
"description": "background color of the grabber button in hover state",
|
9529
|
-
"name": "--mdc-divider-grabber-button-background-color-hover"
|
9530
|
-
},
|
9531
|
-
{
|
9532
|
-
"description": "background color of the grabber button in pressed state",
|
9533
|
-
"name": "--mdc-divider-grabber-button-background-color-pressed"
|
9534
|
-
},
|
9535
|
-
{
|
9536
|
-
"description": "border color of the grabber button",
|
9537
|
-
"name": "--mdc-divider-grabber-button-border-color"
|
9538
|
-
},
|
9539
|
-
{
|
9540
|
-
"description": "border radius of the grabber button",
|
9541
|
-
"name": "--mdc-divider-grabber-button-border-radius"
|
9542
|
-
}
|
9543
|
-
],
|
9544
|
-
"members": [
|
9545
|
-
{
|
9546
|
-
"kind": "field",
|
9547
|
-
"name": "orientation",
|
9548
|
-
"type": {
|
9549
|
-
"text": "DividerOrientation"
|
9550
|
-
},
|
9551
|
-
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
9552
|
-
"default": "horizontal",
|
9553
|
-
"attribute": "orientation",
|
9554
|
-
"reflects": true
|
9555
|
-
},
|
9556
|
-
{
|
9557
|
-
"kind": "field",
|
9558
|
-
"name": "variant",
|
9559
|
-
"type": {
|
9560
|
-
"text": "DividerVariant"
|
9561
|
-
},
|
9562
|
-
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
9563
|
-
"default": "solid",
|
9564
|
-
"attribute": "variant",
|
9565
|
-
"reflects": true
|
9566
|
-
},
|
9567
|
-
{
|
9568
|
-
"kind": "field",
|
9569
|
-
"name": "arrowDirection",
|
9570
|
-
"type": {
|
9571
|
-
"text": "Directions"
|
9572
|
-
},
|
9573
|
-
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9574
|
-
"default": "'negative'",
|
9575
|
-
"attribute": "arrow-direction",
|
9576
|
-
"reflects": true
|
9577
|
-
},
|
9578
|
-
{
|
9579
|
-
"kind": "field",
|
9580
|
-
"name": "buttonPosition",
|
9581
|
-
"type": {
|
9582
|
-
"text": "Directions"
|
9583
|
-
},
|
9584
|
-
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9585
|
-
"default": "'negative'",
|
9586
|
-
"attribute": "button-position",
|
9587
|
-
"reflects": true
|
9588
|
-
},
|
9589
|
-
{
|
9590
|
-
"kind": "method",
|
9591
|
-
"name": "setVariant",
|
9592
|
-
"privacy": "private",
|
9593
|
-
"parameters": [
|
9594
|
-
{
|
9595
|
-
"name": "variant",
|
9596
|
-
"type": {
|
9597
|
-
"text": "DividerVariant"
|
9598
|
-
},
|
9599
|
-
"description": "The variant to set."
|
9600
|
-
}
|
9601
|
-
],
|
9602
|
-
"description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
9603
|
-
},
|
9604
|
-
{
|
9605
|
-
"kind": "method",
|
9606
|
-
"name": "setOrientation",
|
9607
|
-
"privacy": "private",
|
9608
|
-
"parameters": [
|
9609
|
-
{
|
9610
|
-
"name": "orientation",
|
9611
|
-
"type": {
|
9612
|
-
"text": "DividerOrientation"
|
9613
|
-
},
|
9614
|
-
"description": "The orientation to set."
|
9615
|
-
}
|
9616
|
-
],
|
9617
|
-
"description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
|
9618
|
-
},
|
9619
|
-
{
|
9620
|
-
"kind": "method",
|
9621
|
-
"name": "ensureValidDirections",
|
9622
|
-
"privacy": "private",
|
9623
|
-
"description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
|
9624
|
-
"parameters": [
|
9625
|
-
{
|
9626
|
-
"description": "The buttonPosition to set.",
|
9627
|
-
"name": "buttonPosition"
|
9628
|
-
},
|
9629
|
-
{
|
9630
|
-
"description": "The arrowDirection to set.",
|
9631
|
-
"name": "arrowDirection"
|
9632
|
-
}
|
9633
|
-
]
|
9634
|
-
},
|
9635
|
-
{
|
9636
|
-
"kind": "method",
|
9637
|
-
"name": "setGrabberButton",
|
9638
|
-
"privacy": "private",
|
9639
|
-
"return": {
|
9640
|
-
"type": {
|
9641
|
-
"text": "void"
|
9642
|
-
}
|
9643
|
-
},
|
9644
|
-
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
9645
|
-
},
|
9646
|
-
{
|
9647
|
-
"kind": "method",
|
9648
|
-
"name": "getArrowIcon",
|
9649
|
-
"privacy": "private",
|
9650
|
-
"return": {
|
9651
|
-
"type": {
|
9652
|
-
"text": ""
|
9653
|
-
}
|
9654
|
-
},
|
9655
|
-
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
9656
|
-
},
|
9657
|
-
{
|
9658
|
-
"kind": "method",
|
9659
|
-
"name": "inferDividerType",
|
9660
|
-
"privacy": "private",
|
9661
|
-
"description": "Infers the type of divider based on the kind of slot present.",
|
9662
|
-
"parameters": [
|
9663
|
-
{
|
9664
|
-
"description": "default slot of divider",
|
9665
|
-
"name": "slot"
|
9666
|
-
}
|
9667
|
-
]
|
9668
|
-
}
|
9669
|
-
],
|
9670
|
-
"attributes": [
|
9671
|
-
{
|
9672
|
-
"name": "orientation",
|
9673
|
-
"type": {
|
9674
|
-
"text": "DividerOrientation"
|
9675
|
-
},
|
9676
|
-
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
9677
|
-
"default": "horizontal",
|
9678
|
-
"fieldName": "orientation"
|
9679
|
-
},
|
9680
|
-
{
|
9681
|
-
"name": "variant",
|
9682
|
-
"type": {
|
9683
|
-
"text": "DividerVariant"
|
9684
|
-
},
|
9685
|
-
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
9686
|
-
"default": "solid",
|
9687
|
-
"fieldName": "variant"
|
9688
|
-
},
|
9689
|
-
{
|
9690
|
-
"name": "arrow-direction",
|
9691
|
-
"type": {
|
9692
|
-
"text": "Directions"
|
9693
|
-
},
|
9694
|
-
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9695
|
-
"default": "'negative'",
|
9696
|
-
"fieldName": "arrowDirection"
|
9697
|
-
},
|
9698
|
-
{
|
9699
|
-
"name": "button-position",
|
9700
|
-
"type": {
|
9701
|
-
"text": "Directions"
|
9702
|
-
},
|
9703
|
-
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
9704
|
-
"default": "'negative'",
|
9705
|
-
"fieldName": "buttonPosition"
|
9706
|
-
}
|
9707
|
-
],
|
9708
|
-
"superclass": {
|
9709
|
-
"name": "Component",
|
9710
|
-
"module": "/src/models"
|
9711
|
-
},
|
9712
|
-
"tagName": "mdc-divider",
|
9713
|
-
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
9714
|
-
"customElement": true
|
9715
|
-
}
|
9716
|
-
],
|
9717
|
-
"exports": [
|
9718
|
-
{
|
9719
|
-
"kind": "js",
|
9720
|
-
"name": "default",
|
9721
|
-
"declaration": {
|
9722
|
-
"name": "Divider",
|
9723
|
-
"module": "components/divider/divider.component.js"
|
9724
|
-
}
|
9725
|
-
}
|
9726
|
-
]
|
9727
|
-
},
|
9728
9482
|
{
|
9729
9483
|
"kind": "javascript-module",
|
9730
9484
|
"path": "components/dialog/dialog.component.js",
|
@@ -10691,90 +10445,336 @@
|
|
10691
10445
|
"fieldName": "headerText"
|
10692
10446
|
},
|
10693
10447
|
{
|
10694
|
-
"name": "description-text",
|
10695
|
-
"type": {
|
10696
|
-
"text": "string | undefined"
|
10448
|
+
"name": "description-text",
|
10449
|
+
"type": {
|
10450
|
+
"text": "string | undefined"
|
10451
|
+
},
|
10452
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
10453
|
+
"fieldName": "descriptionText"
|
10454
|
+
},
|
10455
|
+
{
|
10456
|
+
"name": "header-tag-name",
|
10457
|
+
"type": {
|
10458
|
+
"text": "string"
|
10459
|
+
},
|
10460
|
+
"description": "The html tag to be used for the header text",
|
10461
|
+
"fieldName": "headerTagName"
|
10462
|
+
},
|
10463
|
+
{
|
10464
|
+
"name": "description-tag-name",
|
10465
|
+
"type": {
|
10466
|
+
"text": "string"
|
10467
|
+
},
|
10468
|
+
"description": "The html tag to be used for the below-header description text",
|
10469
|
+
"fieldName": "descriptionTagName"
|
10470
|
+
},
|
10471
|
+
{
|
10472
|
+
"name": "role",
|
10473
|
+
"type": {
|
10474
|
+
"text": "DialogRole"
|
10475
|
+
},
|
10476
|
+
"description": "Role of the dialog",
|
10477
|
+
"default": "dialog",
|
10478
|
+
"fieldName": "role"
|
10479
|
+
},
|
10480
|
+
{
|
10481
|
+
"name": "disable-aria-haspopup",
|
10482
|
+
"type": {
|
10483
|
+
"text": "boolean"
|
10484
|
+
},
|
10485
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
10486
|
+
"default": "false",
|
10487
|
+
"fieldName": "disableAriaHasPopup"
|
10488
|
+
},
|
10489
|
+
{
|
10490
|
+
"name": "focus-trap",
|
10491
|
+
"type": {
|
10492
|
+
"text": "boolean"
|
10493
|
+
},
|
10494
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
|
10495
|
+
"default": "true",
|
10496
|
+
"fieldName": "focusTrap"
|
10497
|
+
},
|
10498
|
+
{
|
10499
|
+
"name": "should-focus-trap-wrap",
|
10500
|
+
"type": {
|
10501
|
+
"text": "boolean"
|
10502
|
+
},
|
10503
|
+
"default": "true",
|
10504
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
10505
|
+
"fieldName": "shouldFocusTrapWrap",
|
10506
|
+
"inheritedFrom": {
|
10507
|
+
"name": "FocusTrapMixin",
|
10508
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
10509
|
+
}
|
10510
|
+
}
|
10511
|
+
],
|
10512
|
+
"mixins": [
|
10513
|
+
{
|
10514
|
+
"name": "PreventScrollMixin",
|
10515
|
+
"module": "/src/utils/mixins/PreventScrollMixin"
|
10516
|
+
},
|
10517
|
+
{
|
10518
|
+
"name": "FocusTrapMixin",
|
10519
|
+
"module": "/src/utils/mixins/FocusTrapMixin"
|
10520
|
+
},
|
10521
|
+
{
|
10522
|
+
"name": "CardAndDialogFooterMixin",
|
10523
|
+
"module": "/src/utils/mixins/CardAndDialogFooterMixin"
|
10524
|
+
}
|
10525
|
+
],
|
10526
|
+
"superclass": {
|
10527
|
+
"name": "Component",
|
10528
|
+
"module": "/src/models"
|
10529
|
+
},
|
10530
|
+
"tagName": "mdc-dialog",
|
10531
|
+
"jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
10532
|
+
"customElement": true
|
10533
|
+
}
|
10534
|
+
],
|
10535
|
+
"exports": [
|
10536
|
+
{
|
10537
|
+
"kind": "js",
|
10538
|
+
"name": "default",
|
10539
|
+
"declaration": {
|
10540
|
+
"name": "Dialog",
|
10541
|
+
"module": "components/dialog/dialog.component.js"
|
10542
|
+
}
|
10543
|
+
}
|
10544
|
+
]
|
10545
|
+
},
|
10546
|
+
{
|
10547
|
+
"kind": "javascript-module",
|
10548
|
+
"path": "components/divider/divider.component.js",
|
10549
|
+
"declarations": [
|
10550
|
+
{
|
10551
|
+
"kind": "class",
|
10552
|
+
"description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
|
10553
|
+
"name": "Divider",
|
10554
|
+
"cssProperties": [
|
10555
|
+
{
|
10556
|
+
"description": "background color of the divider",
|
10557
|
+
"name": "--mdc-divider-background-color"
|
10558
|
+
},
|
10559
|
+
{
|
10560
|
+
"description": "width of the divider",
|
10561
|
+
"name": "--mdc-divider-width"
|
10562
|
+
},
|
10563
|
+
{
|
10564
|
+
"description": "gradient of the horizontal divider",
|
10565
|
+
"name": "--mdc-divider-horizontal-gradient"
|
10566
|
+
},
|
10567
|
+
{
|
10568
|
+
"description": "gradient of the vertical divider",
|
10569
|
+
"name": "--mdc-divider-vertical-gradient"
|
10570
|
+
},
|
10571
|
+
{
|
10572
|
+
"description": "font size of label in the text divider",
|
10573
|
+
"name": "--mdc-divider-text-size"
|
10574
|
+
},
|
10575
|
+
{
|
10576
|
+
"description": "font color of label in the text divider",
|
10577
|
+
"name": "--mdc-divider-text-color"
|
10578
|
+
},
|
10579
|
+
{
|
10580
|
+
"description": "left and right margin of label in the text divider",
|
10581
|
+
"name": "--mdc-divider-text-margin"
|
10582
|
+
},
|
10583
|
+
{
|
10584
|
+
"description": "line height of label in the text divider",
|
10585
|
+
"name": "--mdc-divider-text-line-height"
|
10586
|
+
},
|
10587
|
+
{
|
10588
|
+
"description": "background color of the grabber button in rest state",
|
10589
|
+
"name": "--mdc-divider-grabber-button-background-color-normal"
|
10590
|
+
},
|
10591
|
+
{
|
10592
|
+
"description": "background color of the grabber button in hover state",
|
10593
|
+
"name": "--mdc-divider-grabber-button-background-color-hover"
|
10594
|
+
},
|
10595
|
+
{
|
10596
|
+
"description": "background color of the grabber button in pressed state",
|
10597
|
+
"name": "--mdc-divider-grabber-button-background-color-pressed"
|
10598
|
+
},
|
10599
|
+
{
|
10600
|
+
"description": "border color of the grabber button",
|
10601
|
+
"name": "--mdc-divider-grabber-button-border-color"
|
10602
|
+
},
|
10603
|
+
{
|
10604
|
+
"description": "border radius of the grabber button",
|
10605
|
+
"name": "--mdc-divider-grabber-button-border-radius"
|
10606
|
+
}
|
10607
|
+
],
|
10608
|
+
"members": [
|
10609
|
+
{
|
10610
|
+
"kind": "field",
|
10611
|
+
"name": "orientation",
|
10612
|
+
"type": {
|
10613
|
+
"text": "DividerOrientation"
|
10614
|
+
},
|
10615
|
+
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
10616
|
+
"default": "horizontal",
|
10617
|
+
"attribute": "orientation",
|
10618
|
+
"reflects": true
|
10619
|
+
},
|
10620
|
+
{
|
10621
|
+
"kind": "field",
|
10622
|
+
"name": "variant",
|
10623
|
+
"type": {
|
10624
|
+
"text": "DividerVariant"
|
10625
|
+
},
|
10626
|
+
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
10627
|
+
"default": "solid",
|
10628
|
+
"attribute": "variant",
|
10629
|
+
"reflects": true
|
10630
|
+
},
|
10631
|
+
{
|
10632
|
+
"kind": "field",
|
10633
|
+
"name": "arrowDirection",
|
10634
|
+
"type": {
|
10635
|
+
"text": "Directions"
|
10636
|
+
},
|
10637
|
+
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
10638
|
+
"default": "'negative'",
|
10639
|
+
"attribute": "arrow-direction",
|
10640
|
+
"reflects": true
|
10641
|
+
},
|
10642
|
+
{
|
10643
|
+
"kind": "field",
|
10644
|
+
"name": "buttonPosition",
|
10645
|
+
"type": {
|
10646
|
+
"text": "Directions"
|
10647
|
+
},
|
10648
|
+
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
10649
|
+
"default": "'negative'",
|
10650
|
+
"attribute": "button-position",
|
10651
|
+
"reflects": true
|
10652
|
+
},
|
10653
|
+
{
|
10654
|
+
"kind": "method",
|
10655
|
+
"name": "setVariant",
|
10656
|
+
"privacy": "private",
|
10657
|
+
"parameters": [
|
10658
|
+
{
|
10659
|
+
"name": "variant",
|
10660
|
+
"type": {
|
10661
|
+
"text": "DividerVariant"
|
10662
|
+
},
|
10663
|
+
"description": "The variant to set."
|
10664
|
+
}
|
10665
|
+
],
|
10666
|
+
"description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
10667
|
+
},
|
10668
|
+
{
|
10669
|
+
"kind": "method",
|
10670
|
+
"name": "setOrientation",
|
10671
|
+
"privacy": "private",
|
10672
|
+
"parameters": [
|
10673
|
+
{
|
10674
|
+
"name": "orientation",
|
10675
|
+
"type": {
|
10676
|
+
"text": "DividerOrientation"
|
10677
|
+
},
|
10678
|
+
"description": "The orientation to set."
|
10679
|
+
}
|
10680
|
+
],
|
10681
|
+
"description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
|
10682
|
+
},
|
10683
|
+
{
|
10684
|
+
"kind": "method",
|
10685
|
+
"name": "ensureValidDirections",
|
10686
|
+
"privacy": "private",
|
10687
|
+
"description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
|
10688
|
+
"parameters": [
|
10689
|
+
{
|
10690
|
+
"description": "The buttonPosition to set.",
|
10691
|
+
"name": "buttonPosition"
|
10692
|
+
},
|
10693
|
+
{
|
10694
|
+
"description": "The arrowDirection to set.",
|
10695
|
+
"name": "arrowDirection"
|
10696
|
+
}
|
10697
|
+
]
|
10698
|
+
},
|
10699
|
+
{
|
10700
|
+
"kind": "method",
|
10701
|
+
"name": "setGrabberButton",
|
10702
|
+
"privacy": "private",
|
10703
|
+
"return": {
|
10704
|
+
"type": {
|
10705
|
+
"text": "void"
|
10706
|
+
}
|
10697
10707
|
},
|
10698
|
-
"description": "
|
10699
|
-
"fieldName": "descriptionText"
|
10708
|
+
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
10700
10709
|
},
|
10701
10710
|
{
|
10702
|
-
"
|
10703
|
-
"
|
10704
|
-
|
10711
|
+
"kind": "method",
|
10712
|
+
"name": "getArrowIcon",
|
10713
|
+
"privacy": "private",
|
10714
|
+
"return": {
|
10715
|
+
"type": {
|
10716
|
+
"text": ""
|
10717
|
+
}
|
10705
10718
|
},
|
10706
|
-
"description": "
|
10707
|
-
"fieldName": "headerTagName"
|
10719
|
+
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
10708
10720
|
},
|
10709
10721
|
{
|
10710
|
-
"
|
10711
|
-
"
|
10712
|
-
|
10713
|
-
|
10714
|
-
"
|
10715
|
-
|
10716
|
-
|
10722
|
+
"kind": "method",
|
10723
|
+
"name": "inferDividerType",
|
10724
|
+
"privacy": "private",
|
10725
|
+
"description": "Infers the type of divider based on the kind of slot present.",
|
10726
|
+
"parameters": [
|
10727
|
+
{
|
10728
|
+
"description": "default slot of divider",
|
10729
|
+
"name": "slot"
|
10730
|
+
}
|
10731
|
+
]
|
10732
|
+
}
|
10733
|
+
],
|
10734
|
+
"attributes": [
|
10717
10735
|
{
|
10718
|
-
"name": "
|
10736
|
+
"name": "orientation",
|
10719
10737
|
"type": {
|
10720
|
-
"text": "
|
10738
|
+
"text": "DividerOrientation"
|
10721
10739
|
},
|
10722
|
-
"description": "
|
10723
|
-
"default": "
|
10724
|
-
"fieldName": "
|
10740
|
+
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
10741
|
+
"default": "horizontal",
|
10742
|
+
"fieldName": "orientation"
|
10725
10743
|
},
|
10726
10744
|
{
|
10727
|
-
"name": "
|
10745
|
+
"name": "variant",
|
10728
10746
|
"type": {
|
10729
|
-
"text": "
|
10747
|
+
"text": "DividerVariant"
|
10730
10748
|
},
|
10731
|
-
"description": "
|
10732
|
-
"default": "
|
10733
|
-
"fieldName": "
|
10749
|
+
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
10750
|
+
"default": "solid",
|
10751
|
+
"fieldName": "variant"
|
10734
10752
|
},
|
10735
10753
|
{
|
10736
|
-
"name": "
|
10754
|
+
"name": "arrow-direction",
|
10737
10755
|
"type": {
|
10738
|
-
"text": "
|
10756
|
+
"text": "Directions"
|
10739
10757
|
},
|
10740
|
-
"description": "
|
10741
|
-
"default": "
|
10742
|
-
"fieldName": "
|
10758
|
+
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
10759
|
+
"default": "'negative'",
|
10760
|
+
"fieldName": "arrowDirection"
|
10743
10761
|
},
|
10744
10762
|
{
|
10745
|
-
"name": "
|
10763
|
+
"name": "button-position",
|
10746
10764
|
"type": {
|
10747
|
-
"text": "
|
10765
|
+
"text": "Directions"
|
10748
10766
|
},
|
10749
|
-
"
|
10750
|
-
"
|
10751
|
-
"fieldName": "
|
10752
|
-
"inheritedFrom": {
|
10753
|
-
"name": "FocusTrapMixin",
|
10754
|
-
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
10755
|
-
}
|
10756
|
-
}
|
10757
|
-
],
|
10758
|
-
"mixins": [
|
10759
|
-
{
|
10760
|
-
"name": "PreventScrollMixin",
|
10761
|
-
"module": "/src/utils/mixins/PreventScrollMixin"
|
10762
|
-
},
|
10763
|
-
{
|
10764
|
-
"name": "FocusTrapMixin",
|
10765
|
-
"module": "/src/utils/mixins/FocusTrapMixin"
|
10766
|
-
},
|
10767
|
-
{
|
10768
|
-
"name": "CardAndDialogFooterMixin",
|
10769
|
-
"module": "/src/utils/mixins/CardAndDialogFooterMixin"
|
10767
|
+
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
10768
|
+
"default": "'negative'",
|
10769
|
+
"fieldName": "buttonPosition"
|
10770
10770
|
}
|
10771
10771
|
],
|
10772
10772
|
"superclass": {
|
10773
10773
|
"name": "Component",
|
10774
10774
|
"module": "/src/models"
|
10775
10775
|
},
|
10776
|
-
"tagName": "mdc-
|
10777
|
-
"jsDoc": "/**\n *
|
10776
|
+
"tagName": "mdc-divider",
|
10777
|
+
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
10778
10778
|
"customElement": true
|
10779
10779
|
}
|
10780
10780
|
],
|
@@ -10783,8 +10783,8 @@
|
|
10783
10783
|
"kind": "js",
|
10784
10784
|
"name": "default",
|
10785
10785
|
"declaration": {
|
10786
|
-
"name": "
|
10787
|
-
"module": "components/
|
10786
|
+
"name": "Divider",
|
10787
|
+
"module": "components/divider/divider.component.js"
|
10788
10788
|
}
|
10789
10789
|
}
|
10790
10790
|
]
|
@@ -33715,24 +33715,28 @@
|
|
33715
33715
|
},
|
33716
33716
|
{
|
33717
33717
|
"kind": "javascript-module",
|
33718
|
-
"path": "components/
|
33718
|
+
"path": "components/tooltip/tooltip.component.js",
|
33719
33719
|
"declarations": [
|
33720
33720
|
{
|
33721
33721
|
"kind": "class",
|
33722
|
-
"description": "A
|
33723
|
-
"name": "
|
33722
|
+
"description": "A tooltip is triggered by mouse hover or by keyboard focus\nand will disappear upon mouse exit or focus change.\n\nNote: Tooltips cannot contain content that can be focused or interacted with.",
|
33723
|
+
"name": "Tooltip",
|
33724
33724
|
"cssProperties": [
|
33725
33725
|
{
|
33726
|
-
"description": "The maximum width of the
|
33727
|
-
"name": "--mdc-
|
33726
|
+
"description": "The maximum width of the tooltip.",
|
33727
|
+
"name": "--mdc-tooltip-max-width"
|
33728
33728
|
},
|
33729
33729
|
{
|
33730
|
-
"description": "The
|
33731
|
-
"name": "--mdc-
|
33730
|
+
"description": "The padding of the tooltip.",
|
33731
|
+
"name": "--mdc-tooltip-padding"
|
33732
33732
|
},
|
33733
33733
|
{
|
33734
|
-
"description": "The text color of the
|
33735
|
-
"name": "--mdc-
|
33734
|
+
"description": "The text color of the tooltip.",
|
33735
|
+
"name": "--mdc-tooltip-text-color"
|
33736
|
+
},
|
33737
|
+
{
|
33738
|
+
"description": "The text color of the tooltip when the color is contrast.",
|
33739
|
+
"name": "--mdc-tooltip-text-color-contrast"
|
33736
33740
|
},
|
33737
33741
|
{
|
33738
33742
|
"description": "radius of the arrow border",
|
@@ -33815,53 +33819,29 @@
|
|
33815
33819
|
}
|
33816
33820
|
}
|
33817
33821
|
],
|
33818
|
-
"slots": [
|
33819
|
-
{
|
33820
|
-
"description": "Default slot for the toggletip content",
|
33821
|
-
"name": "",
|
33822
|
-
"inheritedFrom": {
|
33823
|
-
"name": "Popover",
|
33824
|
-
"module": "src/components/popover/popover.component.ts"
|
33825
|
-
}
|
33826
|
-
}
|
33827
|
-
],
|
33828
33822
|
"members": [
|
33829
33823
|
{
|
33830
33824
|
"kind": "field",
|
33831
|
-
"name": "
|
33832
|
-
"type": {
|
33833
|
-
"text": "Array<Node>"
|
33834
|
-
},
|
33835
|
-
"privacy": "private"
|
33836
|
-
},
|
33837
|
-
{
|
33838
|
-
"kind": "field",
|
33839
|
-
"name": "screenreaderAnnouncerIdentity",
|
33825
|
+
"name": "tooltipType",
|
33840
33826
|
"type": {
|
33841
|
-
"text": "
|
33827
|
+
"text": "TooltipType"
|
33842
33828
|
},
|
33843
|
-
"description": "
|
33844
|
-
"
|
33829
|
+
"description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
|
33830
|
+
"default": "'description'",
|
33831
|
+
"attribute": "tooltip-type",
|
33845
33832
|
"reflects": true
|
33846
33833
|
},
|
33847
33834
|
{
|
33848
33835
|
"kind": "field",
|
33849
|
-
"name": "
|
33836
|
+
"name": "defaultSlotNodes",
|
33850
33837
|
"type": {
|
33851
|
-
"text": "
|
33838
|
+
"text": "Array<Node>"
|
33852
33839
|
},
|
33853
|
-
"
|
33854
|
-
"default": "bottom",
|
33855
|
-
"attribute": "placement",
|
33856
|
-
"reflects": true,
|
33857
|
-
"inheritedFrom": {
|
33858
|
-
"name": "Popover",
|
33859
|
-
"module": "components/popover/popover.component.js"
|
33860
|
-
}
|
33840
|
+
"privacy": "private"
|
33861
33841
|
},
|
33862
33842
|
{
|
33863
33843
|
"kind": "method",
|
33864
|
-
"name": "
|
33844
|
+
"name": "getTooltipText",
|
33865
33845
|
"privacy": "private",
|
33866
33846
|
"return": {
|
33867
33847
|
"type": {
|
@@ -33869,6 +33849,37 @@
|
|
33869
33849
|
}
|
33870
33850
|
}
|
33871
33851
|
},
|
33852
|
+
{
|
33853
|
+
"kind": "method",
|
33854
|
+
"name": "setTooltipType",
|
33855
|
+
"privacy": "private",
|
33856
|
+
"return": {
|
33857
|
+
"type": {
|
33858
|
+
"text": "void"
|
33859
|
+
}
|
33860
|
+
},
|
33861
|
+
"parameters": [
|
33862
|
+
{
|
33863
|
+
"name": "type",
|
33864
|
+
"type": {
|
33865
|
+
"text": "TooltipType"
|
33866
|
+
},
|
33867
|
+
"description": "The type to set."
|
33868
|
+
}
|
33869
|
+
],
|
33870
|
+
"description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
|
33871
|
+
},
|
33872
|
+
{
|
33873
|
+
"kind": "method",
|
33874
|
+
"name": "onIdUpdated",
|
33875
|
+
"privacy": "private",
|
33876
|
+
"return": {
|
33877
|
+
"type": {
|
33878
|
+
"text": "void"
|
33879
|
+
}
|
33880
|
+
},
|
33881
|
+
"description": "Updates the tooltip id if it is empty."
|
33882
|
+
},
|
33872
33883
|
{
|
33873
33884
|
"kind": "method",
|
33874
33885
|
"name": "onPlacementUpdated",
|
@@ -33878,7 +33889,27 @@
|
|
33878
33889
|
"text": "void"
|
33879
33890
|
}
|
33880
33891
|
},
|
33881
|
-
"description": "Updates the placement attribute if it is not a valid placement.\
|
33892
|
+
"description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
|
33893
|
+
},
|
33894
|
+
{
|
33895
|
+
"kind": "method",
|
33896
|
+
"name": "onTooltipTypeUpdated",
|
33897
|
+
"privacy": "private",
|
33898
|
+
"return": {
|
33899
|
+
"type": {
|
33900
|
+
"text": "void"
|
33901
|
+
}
|
33902
|
+
},
|
33903
|
+
"parameters": [
|
33904
|
+
{
|
33905
|
+
"name": "changedProperties",
|
33906
|
+
"type": {
|
33907
|
+
"text": "PropertyValues"
|
33908
|
+
},
|
33909
|
+
"description": "The changed properties."
|
33910
|
+
}
|
33911
|
+
],
|
33912
|
+
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
33882
33913
|
},
|
33883
33914
|
{
|
33884
33915
|
"kind": "field",
|
@@ -34471,6 +34502,21 @@
|
|
34471
34502
|
"module": "components/popover/popover.component.js"
|
34472
34503
|
}
|
34473
34504
|
},
|
34505
|
+
{
|
34506
|
+
"kind": "field",
|
34507
|
+
"name": "placement",
|
34508
|
+
"type": {
|
34509
|
+
"text": "PopoverPlacement"
|
34510
|
+
},
|
34511
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
34512
|
+
"default": "bottom",
|
34513
|
+
"attribute": "placement",
|
34514
|
+
"reflects": true,
|
34515
|
+
"inheritedFrom": {
|
34516
|
+
"name": "Popover",
|
34517
|
+
"module": "components/popover/popover.component.js"
|
34518
|
+
}
|
34519
|
+
},
|
34474
34520
|
{
|
34475
34521
|
"kind": "field",
|
34476
34522
|
"name": "color",
|
@@ -35038,7 +35084,7 @@
|
|
35038
35084
|
],
|
35039
35085
|
"events": [
|
35040
35086
|
{
|
35041
|
-
"description": "(React: onShown) This event is dispatched when the
|
35087
|
+
"description": "(React: onShown) This event is dispatched when the tooltip is shown",
|
35042
35088
|
"name": "shown",
|
35043
35089
|
"reactName": "onShown",
|
35044
35090
|
"inheritedFrom": {
|
@@ -35047,7 +35093,7 @@
|
|
35047
35093
|
}
|
35048
35094
|
},
|
35049
35095
|
{
|
35050
|
-
"description": "(React: onHidden) This event is dispatched when the
|
35096
|
+
"description": "(React: onHidden) This event is dispatched when the tooltip is hidden",
|
35051
35097
|
"name": "hidden",
|
35052
35098
|
"reactName": "onHidden",
|
35053
35099
|
"inheritedFrom": {
|
@@ -35056,7 +35102,7 @@
|
|
35056
35102
|
}
|
35057
35103
|
},
|
35058
35104
|
{
|
35059
|
-
"description": "(React: onCreated) This event is dispatched when the
|
35105
|
+
"description": "(React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)",
|
35060
35106
|
"name": "created",
|
35061
35107
|
"reactName": "onCreated",
|
35062
35108
|
"inheritedFrom": {
|
@@ -35065,7 +35111,7 @@
|
|
35065
35111
|
}
|
35066
35112
|
},
|
35067
35113
|
{
|
35068
|
-
"description": "(React: onDestroyed) This event is dispatched when the
|
35114
|
+
"description": "(React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)",
|
35069
35115
|
"name": "destroyed",
|
35070
35116
|
"reactName": "onDestroyed",
|
35071
35117
|
"inheritedFrom": {
|
@@ -35076,25 +35122,13 @@
|
|
35076
35122
|
],
|
35077
35123
|
"attributes": [
|
35078
35124
|
{
|
35079
|
-
"name": "
|
35080
|
-
"type": {
|
35081
|
-
"text": "string | undefined"
|
35082
|
-
},
|
35083
|
-
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
35084
|
-
"fieldName": "screenreaderAnnouncerIdentity"
|
35085
|
-
},
|
35086
|
-
{
|
35087
|
-
"name": "placement",
|
35125
|
+
"name": "tooltip-type",
|
35088
35126
|
"type": {
|
35089
|
-
"text": "
|
35127
|
+
"text": "TooltipType"
|
35090
35128
|
},
|
35091
|
-
"description": "The
|
35092
|
-
"default": "
|
35093
|
-
"fieldName": "
|
35094
|
-
"inheritedFrom": {
|
35095
|
-
"name": "Popover",
|
35096
|
-
"module": "src/components/popover/popover.component.ts"
|
35097
|
-
}
|
35129
|
+
"description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
|
35130
|
+
"default": "'description'",
|
35131
|
+
"fieldName": "tooltipType"
|
35098
35132
|
},
|
35099
35133
|
{
|
35100
35134
|
"name": "should-focus-trap-wrap",
|
@@ -35148,6 +35182,19 @@
|
|
35148
35182
|
"module": "src/components/popover/popover.component.ts"
|
35149
35183
|
}
|
35150
35184
|
},
|
35185
|
+
{
|
35186
|
+
"name": "placement",
|
35187
|
+
"type": {
|
35188
|
+
"text": "PopoverPlacement"
|
35189
|
+
},
|
35190
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
35191
|
+
"default": "bottom",
|
35192
|
+
"fieldName": "placement",
|
35193
|
+
"inheritedFrom": {
|
35194
|
+
"name": "Popover",
|
35195
|
+
"module": "src/components/popover/popover.component.ts"
|
35196
|
+
}
|
35197
|
+
},
|
35151
35198
|
{
|
35152
35199
|
"name": "color",
|
35153
35200
|
"type": {
|
@@ -35478,9 +35525,19 @@
|
|
35478
35525
|
"name": "Popover",
|
35479
35526
|
"module": "/src/components/popover/popover.component"
|
35480
35527
|
},
|
35481
|
-
"tagName": "mdc-
|
35482
|
-
"jsDoc": "/**\n * A
|
35483
|
-
"customElement": true
|
35528
|
+
"tagName": "mdc-tooltip",
|
35529
|
+
"jsDoc": "/**\n * A tooltip is triggered by mouse hover or by keyboard focus\n * and will disappear upon mouse exit or focus change.\n *\n * Note: Tooltips cannot contain content that can be focused or interacted with.\n *\n * @tagname mdc-tooltip\n *\n * @event shown - (React: onShown) This event is dispatched when the tooltip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the tooltip is hidden\n * @event created - (React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-tooltip-max-width - The maximum width of the tooltip.\n * @cssproperty --mdc-tooltip-padding - The padding of the tooltip.\n * @cssproperty --mdc-tooltip-text-color - The text color of the tooltip.\n * @cssproperty --mdc-tooltip-text-color-contrast - The text color of the tooltip when the color is contrast.\n *\n */",
|
35530
|
+
"customElement": true,
|
35531
|
+
"slots": [
|
35532
|
+
{
|
35533
|
+
"description": "Default slot for the popover content",
|
35534
|
+
"name": "",
|
35535
|
+
"inheritedFrom": {
|
35536
|
+
"name": "Popover",
|
35537
|
+
"module": "src/components/popover/popover.component.ts"
|
35538
|
+
}
|
35539
|
+
}
|
35540
|
+
]
|
35484
35541
|
}
|
35485
35542
|
],
|
35486
35543
|
"exports": [
|
@@ -35488,36 +35545,32 @@
|
|
35488
35545
|
"kind": "js",
|
35489
35546
|
"name": "default",
|
35490
35547
|
"declaration": {
|
35491
|
-
"name": "
|
35492
|
-
"module": "components/
|
35548
|
+
"name": "Tooltip",
|
35549
|
+
"module": "components/tooltip/tooltip.component.js"
|
35493
35550
|
}
|
35494
35551
|
}
|
35495
35552
|
]
|
35496
35553
|
},
|
35497
35554
|
{
|
35498
35555
|
"kind": "javascript-module",
|
35499
|
-
"path": "components/
|
35556
|
+
"path": "components/toggletip/toggletip.component.js",
|
35500
35557
|
"declarations": [
|
35501
35558
|
{
|
35502
35559
|
"kind": "class",
|
35503
|
-
"description": "A
|
35504
|
-
"name": "
|
35560
|
+
"description": "A toggletip is triggered by clicking a trigger element.\n\nIt can contain interactive content and can be closed by\nclicking outside the toggletip or pressing the escape key.\n\nIt can have optional close button to close the toggletip.\n\nToggletip component uses `mdc-screenreaderannouncer` internally to\nannounce the toggletip text content with screen readers when the toggletip is shown.\n\n`screenreader-announcer-identity` attribute can be used to provide ID of an element\nin DOM to which announcement elements are added. If not set, a visually hidden\ndiv element is created in DOM to which announcement elements are added.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
35561
|
+
"name": "ToggleTip",
|
35505
35562
|
"cssProperties": [
|
35506
35563
|
{
|
35507
|
-
"description": "The maximum width of the
|
35508
|
-
"name": "--mdc-
|
35509
|
-
},
|
35510
|
-
{
|
35511
|
-
"description": "The padding of the tooltip.",
|
35512
|
-
"name": "--mdc-tooltip-padding"
|
35564
|
+
"description": "The maximum width of the toggletip.",
|
35565
|
+
"name": "--mdc-toggletip-max-width"
|
35513
35566
|
},
|
35514
35567
|
{
|
35515
|
-
"description": "The text color of the
|
35516
|
-
"name": "--mdc-
|
35568
|
+
"description": "The text color of the toggletip.",
|
35569
|
+
"name": "--mdc-toggletip-text-color"
|
35517
35570
|
},
|
35518
35571
|
{
|
35519
|
-
"description": "The text color of the
|
35520
|
-
"name": "--mdc-
|
35572
|
+
"description": "The text color of the toggletip when the color is contrast.",
|
35573
|
+
"name": "--mdc-toggletip-text-color-contrast"
|
35521
35574
|
},
|
35522
35575
|
{
|
35523
35576
|
"description": "radius of the arrow border",
|
@@ -35600,18 +35653,17 @@
|
|
35600
35653
|
}
|
35601
35654
|
}
|
35602
35655
|
],
|
35603
|
-
"
|
35656
|
+
"slots": [
|
35604
35657
|
{
|
35605
|
-
"
|
35606
|
-
"name": "
|
35607
|
-
"
|
35608
|
-
"
|
35609
|
-
|
35610
|
-
|
35611
|
-
|
35612
|
-
|
35613
|
-
|
35614
|
-
},
|
35658
|
+
"description": "Default slot for the toggletip content",
|
35659
|
+
"name": "",
|
35660
|
+
"inheritedFrom": {
|
35661
|
+
"name": "Popover",
|
35662
|
+
"module": "src/components/popover/popover.component.ts"
|
35663
|
+
}
|
35664
|
+
}
|
35665
|
+
],
|
35666
|
+
"members": [
|
35615
35667
|
{
|
35616
35668
|
"kind": "field",
|
35617
35669
|
"name": "defaultSlotNodes",
|
@@ -35621,76 +35673,50 @@
|
|
35621
35673
|
"privacy": "private"
|
35622
35674
|
},
|
35623
35675
|
{
|
35624
|
-
"kind": "
|
35625
|
-
"name": "
|
35626
|
-
"
|
35627
|
-
|
35628
|
-
"type": {
|
35629
|
-
"text": ""
|
35630
|
-
}
|
35631
|
-
}
|
35632
|
-
},
|
35633
|
-
{
|
35634
|
-
"kind": "method",
|
35635
|
-
"name": "setTooltipType",
|
35636
|
-
"privacy": "private",
|
35637
|
-
"return": {
|
35638
|
-
"type": {
|
35639
|
-
"text": "void"
|
35640
|
-
}
|
35676
|
+
"kind": "field",
|
35677
|
+
"name": "screenreaderAnnouncerIdentity",
|
35678
|
+
"type": {
|
35679
|
+
"text": "string | undefined"
|
35641
35680
|
},
|
35642
|
-
"
|
35643
|
-
|
35644
|
-
|
35645
|
-
"type": {
|
35646
|
-
"text": "TooltipType"
|
35647
|
-
},
|
35648
|
-
"description": "The type to set."
|
35649
|
-
}
|
35650
|
-
],
|
35651
|
-
"description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
|
35681
|
+
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
35682
|
+
"attribute": "screenreader-announcer-identity",
|
35683
|
+
"reflects": true
|
35652
35684
|
},
|
35653
35685
|
{
|
35654
|
-
"kind": "
|
35655
|
-
"name": "
|
35656
|
-
"
|
35657
|
-
|
35658
|
-
"type": {
|
35659
|
-
"text": "void"
|
35660
|
-
}
|
35686
|
+
"kind": "field",
|
35687
|
+
"name": "placement",
|
35688
|
+
"type": {
|
35689
|
+
"text": "PopoverPlacement"
|
35661
35690
|
},
|
35662
|
-
"description": "
|
35691
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
35692
|
+
"default": "bottom",
|
35693
|
+
"attribute": "placement",
|
35694
|
+
"reflects": true,
|
35695
|
+
"inheritedFrom": {
|
35696
|
+
"name": "Popover",
|
35697
|
+
"module": "components/popover/popover.component.js"
|
35698
|
+
}
|
35663
35699
|
},
|
35664
35700
|
{
|
35665
35701
|
"kind": "method",
|
35666
|
-
"name": "
|
35702
|
+
"name": "getToggleTipText",
|
35667
35703
|
"privacy": "private",
|
35668
35704
|
"return": {
|
35669
35705
|
"type": {
|
35670
|
-
"text": "
|
35706
|
+
"text": ""
|
35671
35707
|
}
|
35672
|
-
}
|
35673
|
-
"description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
|
35708
|
+
}
|
35674
35709
|
},
|
35675
35710
|
{
|
35676
35711
|
"kind": "method",
|
35677
|
-
"name": "
|
35712
|
+
"name": "onPlacementUpdated",
|
35678
35713
|
"privacy": "private",
|
35679
35714
|
"return": {
|
35680
35715
|
"type": {
|
35681
35716
|
"text": "void"
|
35682
35717
|
}
|
35683
35718
|
},
|
35684
|
-
"
|
35685
|
-
{
|
35686
|
-
"name": "changedProperties",
|
35687
|
-
"type": {
|
35688
|
-
"text": "PropertyValues"
|
35689
|
-
},
|
35690
|
-
"description": "The changed properties."
|
35691
|
-
}
|
35692
|
-
],
|
35693
|
-
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
35719
|
+
"description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
|
35694
35720
|
},
|
35695
35721
|
{
|
35696
35722
|
"kind": "field",
|
@@ -36283,21 +36309,6 @@
|
|
36283
36309
|
"module": "components/popover/popover.component.js"
|
36284
36310
|
}
|
36285
36311
|
},
|
36286
|
-
{
|
36287
|
-
"kind": "field",
|
36288
|
-
"name": "placement",
|
36289
|
-
"type": {
|
36290
|
-
"text": "PopoverPlacement"
|
36291
|
-
},
|
36292
|
-
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
36293
|
-
"default": "bottom",
|
36294
|
-
"attribute": "placement",
|
36295
|
-
"reflects": true,
|
36296
|
-
"inheritedFrom": {
|
36297
|
-
"name": "Popover",
|
36298
|
-
"module": "components/popover/popover.component.js"
|
36299
|
-
}
|
36300
|
-
},
|
36301
36312
|
{
|
36302
36313
|
"kind": "field",
|
36303
36314
|
"name": "color",
|
@@ -36865,7 +36876,7 @@
|
|
36865
36876
|
],
|
36866
36877
|
"events": [
|
36867
36878
|
{
|
36868
|
-
"description": "(React: onShown) This event is dispatched when the
|
36879
|
+
"description": "(React: onShown) This event is dispatched when the toggletip is shown",
|
36869
36880
|
"name": "shown",
|
36870
36881
|
"reactName": "onShown",
|
36871
36882
|
"inheritedFrom": {
|
@@ -36874,7 +36885,7 @@
|
|
36874
36885
|
}
|
36875
36886
|
},
|
36876
36887
|
{
|
36877
|
-
"description": "(React: onHidden) This event is dispatched when the
|
36888
|
+
"description": "(React: onHidden) This event is dispatched when the toggletip is hidden",
|
36878
36889
|
"name": "hidden",
|
36879
36890
|
"reactName": "onHidden",
|
36880
36891
|
"inheritedFrom": {
|
@@ -36883,7 +36894,7 @@
|
|
36883
36894
|
}
|
36884
36895
|
},
|
36885
36896
|
{
|
36886
|
-
"description": "(React: onCreated) This event is dispatched when the
|
36897
|
+
"description": "(React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)",
|
36887
36898
|
"name": "created",
|
36888
36899
|
"reactName": "onCreated",
|
36889
36900
|
"inheritedFrom": {
|
@@ -36892,7 +36903,7 @@
|
|
36892
36903
|
}
|
36893
36904
|
},
|
36894
36905
|
{
|
36895
|
-
"description": "(React: onDestroyed) This event is dispatched when the
|
36906
|
+
"description": "(React: onDestroyed) This event is dispatched when the toggletip is destroyed (removed from the DOM)",
|
36896
36907
|
"name": "destroyed",
|
36897
36908
|
"reactName": "onDestroyed",
|
36898
36909
|
"inheritedFrom": {
|
@@ -36903,13 +36914,25 @@
|
|
36903
36914
|
],
|
36904
36915
|
"attributes": [
|
36905
36916
|
{
|
36906
|
-
"name": "
|
36917
|
+
"name": "screenreader-announcer-identity",
|
36907
36918
|
"type": {
|
36908
|
-
"text": "
|
36919
|
+
"text": "string | undefined"
|
36909
36920
|
},
|
36910
|
-
"description": "
|
36911
|
-
"
|
36912
|
-
|
36921
|
+
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
36922
|
+
"fieldName": "screenreaderAnnouncerIdentity"
|
36923
|
+
},
|
36924
|
+
{
|
36925
|
+
"name": "placement",
|
36926
|
+
"type": {
|
36927
|
+
"text": "PopoverPlacement"
|
36928
|
+
},
|
36929
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
36930
|
+
"default": "bottom",
|
36931
|
+
"fieldName": "placement",
|
36932
|
+
"inheritedFrom": {
|
36933
|
+
"name": "Popover",
|
36934
|
+
"module": "src/components/popover/popover.component.ts"
|
36935
|
+
}
|
36913
36936
|
},
|
36914
36937
|
{
|
36915
36938
|
"name": "should-focus-trap-wrap",
|
@@ -36963,19 +36986,6 @@
|
|
36963
36986
|
"module": "src/components/popover/popover.component.ts"
|
36964
36987
|
}
|
36965
36988
|
},
|
36966
|
-
{
|
36967
|
-
"name": "placement",
|
36968
|
-
"type": {
|
36969
|
-
"text": "PopoverPlacement"
|
36970
|
-
},
|
36971
|
-
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
36972
|
-
"default": "bottom",
|
36973
|
-
"fieldName": "placement",
|
36974
|
-
"inheritedFrom": {
|
36975
|
-
"name": "Popover",
|
36976
|
-
"module": "src/components/popover/popover.component.ts"
|
36977
|
-
}
|
36978
|
-
},
|
36979
36989
|
{
|
36980
36990
|
"name": "color",
|
36981
36991
|
"type": {
|
@@ -37306,19 +37316,9 @@
|
|
37306
37316
|
"name": "Popover",
|
37307
37317
|
"module": "/src/components/popover/popover.component"
|
37308
37318
|
},
|
37309
|
-
"tagName": "mdc-
|
37310
|
-
"jsDoc": "/**\n * A
|
37311
|
-
"customElement": true
|
37312
|
-
"slots": [
|
37313
|
-
{
|
37314
|
-
"description": "Default slot for the popover content",
|
37315
|
-
"name": "",
|
37316
|
-
"inheritedFrom": {
|
37317
|
-
"name": "Popover",
|
37318
|
-
"module": "src/components/popover/popover.component.ts"
|
37319
|
-
}
|
37320
|
-
}
|
37321
|
-
]
|
37319
|
+
"tagName": "mdc-toggletip",
|
37320
|
+
"jsDoc": "/**\n * A toggletip is triggered by clicking a trigger element.\n *\n * It can contain interactive content and can be closed by\n * clicking outside the toggletip or pressing the escape key.\n *\n * It can have optional close button to close the toggletip.\n *\n * Toggletip component uses `mdc-screenreaderannouncer` internally to\n * announce the toggletip text content with screen readers when the toggletip is shown.\n *\n * `screenreader-announcer-identity` attribute can be used to provide ID of an element\n * in DOM to which announcement elements are added. If not set, a visually hidden\n * div element is created in DOM to which announcement elements are added.\n *\n * Please refer to the `mdc-screenreaderannouncer` component for more details.\n *\n * @dependency mdc-screenreaderannouncer\n * @dependency mdc-button\n *\n * @tagname mdc-toggletip\n *\n * @event shown - (React: onShown) This event is dispatched when the toggletip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the toggletip is hidden\n * @event created - (React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the toggletip\n * is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-toggletip-max-width - The maximum width of the toggletip.\n * @cssproperty --mdc-toggletip-text-color - The text color of the toggletip.\n * @cssproperty --mdc-toggletip-text-color-contrast - The text color of the toggletip\n * when the color is contrast.\n *\n * @slot - Default slot for the toggletip content\n */",
|
37321
|
+
"customElement": true
|
37322
37322
|
}
|
37323
37323
|
],
|
37324
37324
|
"exports": [
|
@@ -37326,8 +37326,8 @@
|
|
37326
37326
|
"kind": "js",
|
37327
37327
|
"name": "default",
|
37328
37328
|
"declaration": {
|
37329
|
-
"name": "
|
37330
|
-
"module": "components/
|
37329
|
+
"name": "ToggleTip",
|
37330
|
+
"module": "components/toggletip/toggletip.component.js"
|
37331
37331
|
}
|
37332
37332
|
}
|
37333
37333
|
]
|