@momentum-design/components 0.129.12 → 0.129.14

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.
@@ -3267,37 +3267,43 @@
3267
3267
  "declarations": [
3268
3268
  {
3269
3269
  "kind": "class",
3270
- "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
3270
+ "description": "The `mdc-appheader` component provides a structured and accessible app header layout with three sections: leading, center, and trailing.\n\n## Layout sections\n- **Leading** - Typically holds brand logo, brand name, or menu icon\n- **Center** - Can contain search bar, icons, navigation links, or action controls\n- **Trailing** - Generally includes profile avatar, icons, settings, or additional action controls\n\nEach section automatically handles flex alignment: leading aligns left, center aligns center, trailing aligns right.",
3271
3271
  "name": "Appheader",
3272
+ "cssProperties": [
3273
+ {
3274
+ "description": "Height of the app header. Default is 4rem (64px).",
3275
+ "name": "--mdc-appheader-height"
3276
+ }
3277
+ ],
3272
3278
  "cssParts": [
3273
3279
  {
3274
- "description": "The main container for styling the header.",
3280
+ "description": "The main header container.",
3275
3281
  "name": "container"
3276
3282
  },
3277
3283
  {
3278
- "description": "The leading section of the header.",
3284
+ "description": "The leading section wrapper (left side).",
3279
3285
  "name": "leading-section"
3280
3286
  },
3281
3287
  {
3282
- "description": "The center section of the header.",
3288
+ "description": "The center section wrapper (middle).",
3283
3289
  "name": "center-section"
3284
3290
  },
3285
3291
  {
3286
- "description": "The trailing section of the header.",
3292
+ "description": "The trailing section wrapper (right side).",
3287
3293
  "name": "trailing-section"
3288
3294
  }
3289
3295
  ],
3290
3296
  "slots": [
3291
3297
  {
3292
- "description": "Slot for the leading section (e.g., brand logo, brand name).",
3298
+ "description": "Content for the leading section (left-aligned).",
3293
3299
  "name": "leading"
3294
3300
  },
3295
3301
  {
3296
- "description": "Slot for the center section (e.g., search bar, icons).",
3302
+ "description": "Content for the center section (center-aligned).",
3297
3303
  "name": "center"
3298
3304
  },
3299
3305
  {
3300
- "description": "Slot for the trailing section (e.g., profile avatar, icons).",
3306
+ "description": "Content for the trailing section (right-aligned).",
3301
3307
  "name": "trailing"
3302
3308
  }
3303
3309
  ],
@@ -3307,7 +3313,7 @@
3307
3313
  "module": "/src/models"
3308
3314
  },
3309
3315
  "tagName": "mdc-appheader",
3310
- "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
3316
+ "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout with three sections: leading, center, and trailing.\n *\n * ## Layout sections\n * - **Leading** - Typically holds brand logo, brand name, or menu icon\n * - **Center** - Can contain search bar, icons, navigation links, or action controls\n * - **Trailing** - Generally includes profile avatar, icons, settings, or additional action controls\n *\n * Each section automatically handles flex alignment: leading aligns left, center aligns center, trailing aligns right.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Content for the leading section (left-aligned).\n * @slot center - Content for the center section (center-aligned).\n * @slot trailing - Content for the trailing section (right-aligned).\n *\n * @cssproperty --mdc-appheader-height - Height of the app header. Default is 4rem (64px).\n *\n * @csspart container - The main header container.\n * @csspart leading-section - The leading section wrapper (left side).\n * @csspart center-section - The center section wrapper (middle).\n * @csspart trailing-section - The trailing section wrapper (right side).\n */",
3311
3317
  "customElement": true
3312
3318
  }
3313
3319
  ],
@@ -3328,7 +3334,7 @@
3328
3334
  "declarations": [
3329
3335
  {
3330
3336
  "kind": "class",
3331
- "description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
3337
+ "description": "The `mdc-avatar` component represents a person or a space. It displays as a photo, initials, icon, or counter.\n\n## Display Priority\n\nWhen multiple attributes are provided, the component determines what to display based on this priority:\n1. **Photo** (`src`) - Takes highest priority\n - While loading: Shows `initials` as placeholder if provided (instant), otherwise shows icon (requires loading)\n - After loading: Shows the photo\n - On error: Placeholder remains visible (initials or icon)\n2. **Icon** (`icon-name`) - Takes priority if no `src` is provided\n - Shows custom icon if `icon-name` is set (requires icon library to load)\n - **Note:** If both `icon-name` and `initials` are provided (without `src`), icon takes precedence and initials are ignored.\n This means users may see a delay while the icon loads, even though initials render instantly.\n - Defaults to `user-regular` icon if no other content is available\n3. **Initials** (`initials`) - Displayed only if no `src` or `icon-name` is provided\n - Shows first two characters, converted to uppercase\n - Renders instantly (no loading required)\n4. **Counter** (`counter`) - Displayed only if none of the above are provided\n - Shows numeric value (max 99+)\n - Negative values display as 0\n\n## Behavior\n- Non-interactive and non-focusable component (use `mdc-avatarbutton` for clickable avatars)\n- Shows loading indicator overlay when `is-typing` is true (displays on top of existing content)\n- Presence indicator hidden when counter is set or when typing",
3332
3338
  "name": "Avatar",
3333
3339
  "cssProperties": [
3334
3340
  {
@@ -3481,7 +3487,7 @@
3481
3487
  "module": "/src/models"
3482
3488
  },
3483
3489
  "tagName": "mdc-avatar",
3484
- "jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
3490
+ "jsDoc": "/**\n * The `mdc-avatar` component represents a person or a space. It displays as a photo, initials, icon, or counter.\n *\n * ## Display Priority\n *\n * When multiple attributes are provided, the component determines what to display based on this priority:\n * 1. **Photo** (`src`) - Takes highest priority\n * - While loading: Shows `initials` as placeholder if provided (instant), otherwise shows icon (requires loading)\n * - After loading: Shows the photo\n * - On error: Placeholder remains visible (initials or icon)\n * 2. **Icon** (`icon-name`) - Takes priority if no `src` is provided\n * - Shows custom icon if `icon-name` is set (requires icon library to load)\n * - **Note:** If both `icon-name` and `initials` are provided (without `src`), icon takes precedence and initials are ignored.\n * This means users may see a delay while the icon loads, even though initials render instantly.\n * - Defaults to `user-regular` icon if no other content is available\n * 3. **Initials** (`initials`) - Displayed only if no `src` or `icon-name` is provided\n * - Shows first two characters, converted to uppercase\n * - Renders instantly (no loading required)\n * 4. **Counter** (`counter`) - Displayed only if none of the above are provided\n * - Shows numeric value (max 99+)\n * - Negative values display as 0\n *\n * ## Behavior\n * - Non-interactive and non-focusable component (use `mdc-avatarbutton` for clickable avatars)\n * - Shows loading indicator overlay when `is-typing` is true (displays on top of existing content)\n * - Presence indicator hidden when counter is set or when typing\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
3485
3491
  "customElement": true,
3486
3492
  "attributes": [
3487
3493
  {
@@ -3590,19 +3596,19 @@
3590
3596
  "declarations": [
3591
3597
  {
3592
3598
  "kind": "class",
3593
- "description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
3599
+ "description": "The `mdc-avatarbutton` component is an interactive, clickable version of `mdc-avatar`.\nIt wraps the avatar component in a button, making it focusable and actionable.\n\nThis component extends `buttonsimple` and includes all avatar display features (photo, initials, icon, counter, presence).\nUse CSS parts to customize the avatar's appearance inside the button.\n\n## Accessibility\n- Always provide an `aria-label` attribute to describe the button's purpose",
3594
3600
  "name": "AvatarButton",
3595
3601
  "cssProperties": [
3596
3602
  {
3597
- "description": "Background color of the overlay in rest state",
3603
+ "description": "Background color of the overlay in rest state.",
3598
3604
  "name": "--mdc-avatarbutton-overlay-background-color-rest"
3599
3605
  },
3600
3606
  {
3601
- "description": "Background color of the overlay in hover state",
3607
+ "description": "Background color of the overlay in hover state.",
3602
3608
  "name": "--mdc-avatarbutton-overlay-background-color-hover"
3603
3609
  },
3604
3610
  {
3605
- "description": "Background color of the overlay in active state",
3611
+ "description": "Background color of the overlay in active state.",
3606
3612
  "name": "--mdc-avatarbutton-overlay-background-color-active"
3607
3613
  },
3608
3614
  {
@@ -4079,7 +4085,7 @@
4079
4085
  ],
4080
4086
  "events": [
4081
4087
  {
4082
- "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
4088
+ "description": "(React: onClick) Dispatched when the avatar button is clicked.",
4083
4089
  "name": "click",
4084
4090
  "reactName": "onClick",
4085
4091
  "inheritedFrom": {
@@ -4088,7 +4094,7 @@
4088
4094
  }
4089
4095
  },
4090
4096
  {
4091
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
4097
+ "description": "(React: onKeyDown) Dispatched when a key is pressed on the avatar button.",
4092
4098
  "name": "keydown",
4093
4099
  "reactName": "onKeyDown",
4094
4100
  "inheritedFrom": {
@@ -4097,7 +4103,7 @@
4097
4103
  }
4098
4104
  },
4099
4105
  {
4100
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
4106
+ "description": "(React: onKeyUp) Dispatched when a key is released on the avatar button.",
4101
4107
  "name": "keyup",
4102
4108
  "reactName": "onKeyUp",
4103
4109
  "inheritedFrom": {
@@ -4106,7 +4112,7 @@
4106
4112
  }
4107
4113
  },
4108
4114
  {
4109
- "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
4115
+ "description": "(React: onFocus) Dispatched when the avatar button receives focus.",
4110
4116
  "name": "focus",
4111
4117
  "reactName": "onFocus",
4112
4118
  "inheritedFrom": {
@@ -4355,7 +4361,7 @@
4355
4361
  "module": "/src/components/buttonsimple/buttonsimple.component"
4356
4362
  },
4357
4363
  "tagName": "mdc-avatarbutton",
4358
- "jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * To override styles of the avatar inside, use the specified css parts.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
4364
+ "jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactive, clickable version of `mdc-avatar`.\n * It wraps the avatar component in a button, making it focusable and actionable.\n *\n * This component extends `buttonsimple` and includes all avatar display features (photo, initials, icon, counter, presence).\n * Use CSS parts to customize the avatar's appearance inside the button.\n *\n * ## Accessibility\n * - Always provide an `aria-label` attribute to describe the button's purpose\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) Dispatched when the avatar button is clicked.\n * @event keydown - (React: onKeyDown) Dispatched when a key is pressed on the avatar button.\n * @event keyup - (React: onKeyUp) Dispatched when a key is released on the avatar button.\n * @event focus - (React: onFocus) Dispatched when the avatar button receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state.\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state.\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state.\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
4359
4365
  "customElement": true
4360
4366
  }
4361
4367
  ],
@@ -6078,27 +6084,27 @@
6078
6084
  "declarations": [
6079
6085
  {
6080
6086
  "kind": "class",
6081
- "description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
6087
+ "description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons.\n\n### Features:\n- Behaves like a link while visually resembling a button.\n- Customizable size, color, and variant through attributes.\n- Supports prefix and postfix icons.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
6082
6088
  "name": "ButtonLink",
6083
6089
  "cssProperties": [
6084
6090
  {
6085
- "description": "Height for button size",
6091
+ "description": "Height of the buttonlink",
6086
6092
  "name": "--mdc-button-height"
6087
6093
  },
6088
6094
  {
6089
- "description": "Background color of the button",
6095
+ "description": "Background color of the buttonlink",
6090
6096
  "name": "--mdc-button-background"
6091
6097
  },
6092
6098
  {
6093
- "description": "Borer color of the button",
6099
+ "description": "Border color of the buttonlink",
6094
6100
  "name": "--mdc-button-border-color"
6095
6101
  },
6096
6102
  {
6097
- "description": "Text color of the button",
6103
+ "description": "Text color of the buttonlink",
6098
6104
  "name": "--mdc-button-text-color"
6099
6105
  },
6100
6106
  {
6101
- "description": "Line height of the button text",
6107
+ "description": "Line height of the buttonlink text",
6102
6108
  "name": "--mdc-button-line-height"
6103
6109
  },
6104
6110
  {
@@ -6204,6 +6210,12 @@
6204
6210
  "name": "postfix-icon"
6205
6211
  }
6206
6212
  ],
6213
+ "slots": [
6214
+ {
6215
+ "description": "The default slot for buttonlink text content.",
6216
+ "name": "default"
6217
+ }
6218
+ ],
6207
6219
  "members": [
6208
6220
  {
6209
6221
  "kind": "field",
@@ -6255,7 +6267,7 @@
6255
6267
  "type": {
6256
6268
  "text": "string | undefined"
6257
6269
  },
6258
- "description": "Optional download attribute to instruct browsers to download the linked resource.",
6270
+ "description": "Optional download attribute to instruct browsers to download the linked resource.\n\nValid values:\n- empty string: browser suggests a name for the downloaded file\n- string: name of the downloaded file\n\nMore details in the [Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) docs.",
6259
6271
  "attribute": "download",
6260
6272
  "reflects": true,
6261
6273
  "inheritedFrom": {
@@ -6539,7 +6551,7 @@
6539
6551
  "type": {
6540
6552
  "text": "PillButtonSize | IconButtonSize"
6541
6553
  },
6542
- "description": "ButtonLink sizing is based on the buttonlink type.\n- **Pill buttonlink**: 40, 32, 28, 24.\n- **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon buttonlink can also be 20.",
6554
+ "description": "Size of the buttonlink, determined by its type.\n- **Pill buttonlink**: 40 (2.5rem), 32 (2rem), 28 (1.75rem), 24 (1.5rem)\n- **Icon buttonlink**: 64 (4rem), 52 (3.25rem), 40 (2.5rem), 32 (2rem), 28 (1.75rem), 24 (1.5rem)\n- **Tertiary icon buttonlink** can also use: 20 (1.25rem)",
6543
6555
  "default": "32",
6544
6556
  "attribute": "size",
6545
6557
  "reflects": true
@@ -6643,7 +6655,7 @@
6643
6655
  "type": {
6644
6656
  "text": "PillButtonSize | IconButtonSize"
6645
6657
  },
6646
- "description": "ButtonLink sizing is based on the buttonlink type.\n- **Pill buttonlink**: 40, 32, 28, 24.\n- **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon buttonlink can also be 20.",
6658
+ "description": "Size of the buttonlink, determined by its type.\n- **Pill buttonlink**: 40 (2.5rem), 32 (2rem), 28 (1.75rem), 24 (1.5rem)\n- **Icon buttonlink**: 64 (4rem), 52 (3.25rem), 40 (2.5rem), 32 (2rem), 28 (1.75rem), 24 (1.5rem)\n- **Tertiary icon buttonlink** can also use: 20 (1.25rem)",
6647
6659
  "default": "32",
6648
6660
  "fieldName": "size"
6649
6661
  },
@@ -6800,7 +6812,7 @@
6800
6812
  "type": {
6801
6813
  "text": "string | undefined"
6802
6814
  },
6803
- "description": "Optional download attribute to instruct browsers to download the linked resource.",
6815
+ "description": "Optional download attribute to instruct browsers to download the linked resource.\n\nValid values:\n- empty string: browser suggests a name for the downloaded file\n- string: name of the downloaded file\n\nMore details in the [Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) docs.",
6804
6816
  "fieldName": "download",
6805
6817
  "inheritedFrom": {
6806
6818
  "name": "Linksimple",
@@ -6867,7 +6879,7 @@
6867
6879
  "module": "/src/components/linksimple/linksimple.component"
6868
6880
  },
6869
6881
  "tagName": "mdc-buttonlink",
6870
- "jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @csspart anchor - The anchor element that wraps the buttonlink content.\n * @csspart prefix-icon - The prefix icon element.\n * @csspart button-text - The slot containing the buttonlink text.\n * @csspart postfix-icon - The postfix icon element.\n *\n * @cssproperty --mdc-button-height - Height for button size\n * @cssproperty --mdc-button-background - Background color of the button\n * @cssproperty --mdc-button-border-color - Borer color of the button\n * @cssproperty --mdc-button-text-color - Text color of the button\n * @cssproperty --mdc-button-line-height - Line height of the button text\n * @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon\n * @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon\n */",
6882
+ "jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons.\n *\n * ### Features:\n * - Behaves like a link while visually resembling a button.\n * - Customizable size, color, and variant through attributes.\n * - Supports prefix and postfix icons.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @slot default - The default slot for buttonlink text content.\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @csspart anchor - The anchor element that wraps the buttonlink content.\n * @csspart prefix-icon - The prefix icon element.\n * @csspart button-text - The slot containing the buttonlink text.\n * @csspart postfix-icon - The postfix icon element.\n *\n * @cssproperty --mdc-button-height - Height of the buttonlink\n * @cssproperty --mdc-button-background - Background color of the buttonlink\n * @cssproperty --mdc-button-border-color - Border color of the buttonlink\n * @cssproperty --mdc-button-text-color - Text color of the buttonlink\n * @cssproperty --mdc-button-line-height - Line height of the buttonlink text\n * @cssproperty --mdc-button-prefix-icon-size - Size of the prefix icon\n * @cssproperty --mdc-button-postfix-icon-size - Size of the postfix icon\n */",
6871
6883
  "customElement": true
6872
6884
  }
6873
6885
  ],
@@ -20622,7 +20634,7 @@
20622
20634
  "type": {
20623
20635
  "text": "string | undefined"
20624
20636
  },
20625
- "description": "Optional download attribute to instruct browsers to download the linked resource.",
20637
+ "description": "Optional download attribute to instruct browsers to download the linked resource.\n\nValid values:\n- empty string: browser suggests a name for the downloaded file\n- string: name of the downloaded file\n\nMore details in the [Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) docs.",
20626
20638
  "attribute": "download",
20627
20639
  "reflects": true,
20628
20640
  "inheritedFrom": {
@@ -20995,7 +21007,7 @@
20995
21007
  "type": {
20996
21008
  "text": "string | undefined"
20997
21009
  },
20998
- "description": "Optional download attribute to instruct browsers to download the linked resource.",
21010
+ "description": "Optional download attribute to instruct browsers to download the linked resource.\n\nValid values:\n- empty string: browser suggests a name for the downloaded file\n- string: name of the downloaded file\n\nMore details in the [Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) docs.",
20999
21011
  "fieldName": "download",
21000
21012
  "inheritedFrom": {
21001
21013
  "name": "Linksimple",
@@ -21372,7 +21384,7 @@
21372
21384
  "type": {
21373
21385
  "text": "boolean"
21374
21386
  },
21375
- "description": "The linkbutton can be inline or standalone.",
21387
+ "description": "Display mode of the linkbutton.\n- `false`: Standalone display (default)\n- `true`: Inline display within text flow",
21376
21388
  "default": "false",
21377
21389
  "attribute": "inline",
21378
21390
  "reflects": true
@@ -21383,7 +21395,7 @@
21383
21395
  "type": {
21384
21396
  "text": "boolean"
21385
21397
  },
21386
- "description": "The linkbutton color can be inverted by setting the inverted attribute to true.",
21398
+ "description": "Color scheme of the linkbutton.\n- `false`: Normal color scheme for light backgrounds (default)\n- `true`: Inverted color scheme for dark backgrounds",
21387
21399
  "default": "false",
21388
21400
  "attribute": "inverted",
21389
21401
  "reflects": true
@@ -21470,21 +21482,6 @@
21470
21482
  "module": "components/buttonsimple/buttonsimple.component.js"
21471
21483
  }
21472
21484
  },
21473
- {
21474
- "kind": "method",
21475
- "name": "setSize",
21476
- "privacy": "private",
21477
- "parameters": [
21478
- {
21479
- "name": "size",
21480
- "type": {
21481
- "text": "LinkButtonSize"
21482
- },
21483
- "description": "The desired link size."
21484
- }
21485
- ],
21486
- "description": "Sets the `size` attribute for the linkbutton, falling back to the default if the value is invalid."
21487
- },
21488
21485
  {
21489
21486
  "kind": "method",
21490
21487
  "name": "setSoftDisabled",
@@ -21518,7 +21515,7 @@
21518
21515
  "type": {
21519
21516
  "text": "ButtonSize"
21520
21517
  },
21521
- "description": "Sets the size of the linkbutton.\nAcceptable values:\n- 12\n- 14\n- 16",
21518
+ "description": "Size of the linkbutton text and icon.\n- **12**: 0.75rem font size\n- **14**: 0.875rem font size\n- **16**: 1rem font size (default)",
21522
21519
  "default": "16",
21523
21520
  "attribute": "size",
21524
21521
  "reflects": true,
@@ -21632,6 +21629,11 @@
21632
21629
  "name": "Buttonsimple",
21633
21630
  "module": "src/components/buttonsimple/buttonsimple.component.ts"
21634
21631
  }
21632
+ },
21633
+ {
21634
+ "description": "(React: onBlur) This event is dispatched when the linkbutton loses focus.",
21635
+ "name": "blur",
21636
+ "reactName": "onBlur"
21635
21637
  }
21636
21638
  ],
21637
21639
  "attributes": [
@@ -21640,7 +21642,7 @@
21640
21642
  "type": {
21641
21643
  "text": "ButtonSize"
21642
21644
  },
21643
- "description": "Sets the size of the linkbutton.\nAcceptable values:\n- 12\n- 14\n- 16",
21645
+ "description": "Size of the linkbutton text and icon.\n- **12**: 0.75rem font size\n- **14**: 0.875rem font size\n- **16**: 1rem font size (default)",
21644
21646
  "default": "16",
21645
21647
  "fieldName": "size",
21646
21648
  "inheritedFrom": {
@@ -21653,7 +21655,7 @@
21653
21655
  "type": {
21654
21656
  "text": "boolean"
21655
21657
  },
21656
- "description": "The linkbutton can be inline or standalone.",
21658
+ "description": "Display mode of the linkbutton.\n- `false`: Standalone display (default)\n- `true`: Inline display within text flow",
21657
21659
  "default": "false",
21658
21660
  "fieldName": "inline"
21659
21661
  },
@@ -21662,7 +21664,7 @@
21662
21664
  "type": {
21663
21665
  "text": "boolean"
21664
21666
  },
21665
- "description": "The linkbutton color can be inverted by setting the inverted attribute to true.",
21667
+ "description": "Color scheme of the linkbutton.\n- `false`: Normal color scheme for light backgrounds (default)\n- `true`: Inverted color scheme for dark backgrounds",
21666
21668
  "default": "false",
21667
21669
  "fieldName": "inverted"
21668
21670
  },
@@ -21818,7 +21820,7 @@
21818
21820
  "module": "/src/components/buttonsimple/buttonsimple.component"
21819
21821
  },
21820
21822
  "tagName": "mdc-linkbutton",
21821
- "jsDoc": "/**\n * `mdc-linkbutton` visually mimics a hyperlink while functioning as a button. It blends the appearance of `mdc-link` with the accessibility and interaction capabilities of `mdc-button`.\n *\n * ### Features:\n * - Looks like a link, behaves like a button.\n * - Supports slots for a text label and an optional trailing icon.\n * - Inherits accessibility and keyboard interaction behavior from `mdc-buttonsimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-linkbutton\n *\n * @slot - Text label of the linkbutton.\n *\n * @event click - (React: onClick) This event is dispatched when the linkbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the linkbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the linkbutton.\n * @event focus - (React: onFocus) This event is dispatched when the linkbutton receives focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the linkbutton.\n * @cssproperty --mdc-link-color-active - Color of the linkbutton’s child content in the active state.\n * @cssproperty --mdc-link-color-disabled - Color of the linkbutton’s child content in the disabled state.\n * @cssproperty --mdc-link-color-hover - Color of the linkbutton’s child content in the hover state.\n * @cssproperty --mdc-link-color-normal - Color of the linkbutton’s child content in the normal state.\n * @cssproperty --mdc-link-inverted-color-active - Color of the inverted linkbutton’s child content in the active state.\n * @cssproperty --mdc-link-inverted-color-disabled - Color of the inverted linkbutton’s child content in the disabled state.\n * @cssproperty --mdc-link-inverted-color-hover - Color of the inverted linkbutton’s child content in the hover state.\n * @cssproperty --mdc-link-inverted-color-normal - Color of the inverted linkbutton’s child content in the normal state.\n * @cssproperty --mdc-button-height - Height for button size\n */",
21823
+ "jsDoc": "/**\n * `mdc-linkbutton` visually mimics a hyperlink while functioning as a button. It blends the appearance of `mdc-link` with the accessibility and interaction capabilities of `mdc-button`.\n *\n * ### Features:\n * - Looks like a link, behaves like a button.\n * - Supports slots for a text label and an optional trailing icon.\n * - Inherits accessibility and keyboard interaction behavior from `mdc-buttonsimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-linkbutton\n *\n * @slot - Text label of the linkbutton.\n *\n * @event click - (React: onClick) This event is dispatched when the linkbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the linkbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the linkbutton.\n * @event focus - (React: onFocus) This event is dispatched when the linkbutton receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the linkbutton loses focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the linkbutton.\n * @cssproperty --mdc-link-color-active - Color of the linkbutton’s child content in the active state.\n * @cssproperty --mdc-link-color-disabled - Color of the linkbutton’s child content in the disabled state.\n * @cssproperty --mdc-link-color-hover - Color of the linkbutton’s child content in the hover state.\n * @cssproperty --mdc-link-color-normal - Color of the linkbutton’s child content in the normal state.\n * @cssproperty --mdc-link-inverted-color-active - Color of the inverted linkbutton’s child content in the active state.\n * @cssproperty --mdc-link-inverted-color-disabled - Color of the inverted linkbutton’s child content in the disabled state.\n * @cssproperty --mdc-link-inverted-color-hover - Color of the inverted linkbutton’s child content in the hover state.\n * @cssproperty --mdc-link-inverted-color-normal - Color of the inverted linkbutton’s child content in the normal state.\n * @cssproperty --mdc-button-height - Height for button size\n */",
21822
21824
  "customElement": true
21823
21825
  }
21824
21826
  ],
@@ -21922,7 +21924,7 @@
21922
21924
  "type": {
21923
21925
  "text": "string | undefined"
21924
21926
  },
21925
- "description": "Optional download attribute to instruct browsers to download the linked resource.",
21927
+ "description": "Optional download attribute to instruct browsers to download the linked resource.\n\nValid values:\n- empty string: browser suggests a name for the downloaded file\n- string: name of the downloaded file\n\nMore details in the [Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) docs.",
21926
21928
  "attribute": "download",
21927
21929
  "reflects": true
21928
21930
  },
@@ -22124,7 +22126,7 @@
22124
22126
  "type": {
22125
22127
  "text": "string | undefined"
22126
22128
  },
22127
- "description": "Optional download attribute to instruct browsers to download the linked resource.",
22129
+ "description": "Optional download attribute to instruct browsers to download the linked resource.\n\nValid values:\n- empty string: browser suggests a name for the downloaded file\n- string: name of the downloaded file\n\nMore details in the [Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download) docs.",
22128
22130
  "fieldName": "download"
22129
22131
  },
22130
22132
  {
@@ -1,22 +1,26 @@
1
1
  import Component from '../../components/appheader';
2
2
  /**
3
- * The `mdc-appheader` component provides a structured and accessible app header layout.
4
- * It consists of three primary sections: leading, center, and trailing.
3
+ * The `mdc-appheader` component provides a structured and accessible app header layout with three sections: leading, center, and trailing.
5
4
  *
6
- * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.
7
- * - The **center section** can contain a **search bar**, **icons** or action controls.
8
- * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.
5
+ * ## Layout sections
6
+ * - **Leading** - Typically holds brand logo, brand name, or menu icon
7
+ * - **Center** - Can contain search bar, icons, navigation links, or action controls
8
+ * - **Trailing** - Generally includes profile avatar, icons, settings, or additional action controls
9
+ *
10
+ * Each section automatically handles flex alignment: leading aligns left, center aligns center, trailing aligns right.
9
11
  *
10
12
  * @tagname mdc-appheader
11
13
  *
12
- * @slot leading - Slot for the leading section (e.g., brand logo, brand name).
13
- * @slot center - Slot for the center section (e.g., search bar, icons).
14
- * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).
14
+ * @slot leading - Content for the leading section (left-aligned).
15
+ * @slot center - Content for the center section (center-aligned).
16
+ * @slot trailing - Content for the trailing section (right-aligned).
17
+ *
18
+ * @cssproperty --mdc-appheader-height - Height of the app header. Default is 4rem (64px).
15
19
  *
16
- * @csspart container - The main container for styling the header.
17
- * @csspart leading-section - The leading section of the header.
18
- * @csspart center-section - The center section of the header.
19
- * @csspart trailing-section - The trailing section of the header.
20
+ * @csspart container - The main header container.
21
+ * @csspart leading-section - The leading section wrapper (left side).
22
+ * @csspart center-section - The center section wrapper (middle).
23
+ * @csspart trailing-section - The trailing section wrapper (right side).
20
24
  */
21
25
  declare const reactWrapper: import("@lit/react").ReactWebComponent<Component, {}>;
22
26
  export default reactWrapper;
@@ -3,23 +3,27 @@ import { createComponent } from '@lit/react';
3
3
  import Component from '../../components/appheader';
4
4
  import { TAG_NAME } from '../../components/appheader/appheader.constants';
5
5
  /**
6
- * The `mdc-appheader` component provides a structured and accessible app header layout.
7
- * It consists of three primary sections: leading, center, and trailing.
6
+ * The `mdc-appheader` component provides a structured and accessible app header layout with three sections: leading, center, and trailing.
8
7
  *
9
- * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.
10
- * - The **center section** can contain a **search bar**, **icons** or action controls.
11
- * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.
8
+ * ## Layout sections
9
+ * - **Leading** - Typically holds brand logo, brand name, or menu icon
10
+ * - **Center** - Can contain search bar, icons, navigation links, or action controls
11
+ * - **Trailing** - Generally includes profile avatar, icons, settings, or additional action controls
12
+ *
13
+ * Each section automatically handles flex alignment: leading aligns left, center aligns center, trailing aligns right.
12
14
  *
13
15
  * @tagname mdc-appheader
14
16
  *
15
- * @slot leading - Slot for the leading section (e.g., brand logo, brand name).
16
- * @slot center - Slot for the center section (e.g., search bar, icons).
17
- * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).
17
+ * @slot leading - Content for the leading section (left-aligned).
18
+ * @slot center - Content for the center section (center-aligned).
19
+ * @slot trailing - Content for the trailing section (right-aligned).
20
+ *
21
+ * @cssproperty --mdc-appheader-height - Height of the app header. Default is 4rem (64px).
18
22
  *
19
- * @csspart container - The main container for styling the header.
20
- * @csspart leading-section - The leading section of the header.
21
- * @csspart center-section - The center section of the header.
22
- * @csspart trailing-section - The trailing section of the header.
23
+ * @csspart container - The main header container.
24
+ * @csspart leading-section - The leading section wrapper (left side).
25
+ * @csspart center-section - The center section wrapper (middle).
26
+ * @csspart trailing-section - The trailing section wrapper (right side).
23
27
  */
24
28
  const reactWrapper = createComponent({
25
29
  tagName: TAG_NAME,
@@ -1,23 +1,30 @@
1
1
  import Component from '../../components/avatar';
2
2
  /**
3
- * The `mdc-avatar` component is used to represent a person or a space.
4
- * An avatar can be an icon, initials, counter and photo.
5
- *
6
- * To set the photo of an avatar,
7
- * you need to set "src" attribute.
8
- *
9
- * While the avatar image is loading, as a placeholder,
10
- * we will show the initials text.
11
- * If the initials are not specified then,
12
- * we will show `user-regular` icon as a placeholder.
13
- *
14
- * By default, if there are no attributes specified,
15
- * then the default avatar will be an icon with `user-regular` name.
16
- *
17
- * The avatar component is non clickable and non interactive/focusable component.
18
- * If the avatar is typing, then the loading indicator will be displayed.
19
- * If the counter type avatar is set to a negative number, then we will display 0.
20
- * The presence indicator will be hidden when the counter property is set.
3
+ * The `mdc-avatar` component represents a person or a space. It displays as a photo, initials, icon, or counter.
4
+ *
5
+ * ## Display Priority
6
+ *
7
+ * When multiple attributes are provided, the component determines what to display based on this priority:
8
+ * 1. **Photo** (`src`) - Takes highest priority
9
+ * - While loading: Shows `initials` as placeholder if provided (instant), otherwise shows icon (requires loading)
10
+ * - After loading: Shows the photo
11
+ * - On error: Placeholder remains visible (initials or icon)
12
+ * 2. **Icon** (`icon-name`) - Takes priority if no `src` is provided
13
+ * - Shows custom icon if `icon-name` is set (requires icon library to load)
14
+ * - **Note:** If both `icon-name` and `initials` are provided (without `src`), icon takes precedence and initials are ignored.
15
+ * This means users may see a delay while the icon loads, even though initials render instantly.
16
+ * - Defaults to `user-regular` icon if no other content is available
17
+ * 3. **Initials** (`initials`) - Displayed only if no `src` or `icon-name` is provided
18
+ * - Shows first two characters, converted to uppercase
19
+ * - Renders instantly (no loading required)
20
+ * 4. **Counter** (`counter`) - Displayed only if none of the above are provided
21
+ * - Shows numeric value (max 99+)
22
+ * - Negative values display as 0
23
+ *
24
+ * ## Behavior
25
+ * - Non-interactive and non-focusable component (use `mdc-avatarbutton` for clickable avatars)
26
+ * - Shows loading indicator overlay when `is-typing` is true (displays on top of existing content)
27
+ * - Presence indicator hidden when counter is set or when typing
21
28
  *
22
29
  * @dependency mdc-icon
23
30
  * @dependency mdc-presence
@@ -3,24 +3,31 @@ import { createComponent } from '@lit/react';
3
3
  import Component from '../../components/avatar';
4
4
  import { TAG_NAME } from '../../components/avatar/avatar.constants';
5
5
  /**
6
- * The `mdc-avatar` component is used to represent a person or a space.
7
- * An avatar can be an icon, initials, counter and photo.
8
- *
9
- * To set the photo of an avatar,
10
- * you need to set "src" attribute.
11
- *
12
- * While the avatar image is loading, as a placeholder,
13
- * we will show the initials text.
14
- * If the initials are not specified then,
15
- * we will show `user-regular` icon as a placeholder.
16
- *
17
- * By default, if there are no attributes specified,
18
- * then the default avatar will be an icon with `user-regular` name.
19
- *
20
- * The avatar component is non clickable and non interactive/focusable component.
21
- * If the avatar is typing, then the loading indicator will be displayed.
22
- * If the counter type avatar is set to a negative number, then we will display 0.
23
- * The presence indicator will be hidden when the counter property is set.
6
+ * The `mdc-avatar` component represents a person or a space. It displays as a photo, initials, icon, or counter.
7
+ *
8
+ * ## Display Priority
9
+ *
10
+ * When multiple attributes are provided, the component determines what to display based on this priority:
11
+ * 1. **Photo** (`src`) - Takes highest priority
12
+ * - While loading: Shows `initials` as placeholder if provided (instant), otherwise shows icon (requires loading)
13
+ * - After loading: Shows the photo
14
+ * - On error: Placeholder remains visible (initials or icon)
15
+ * 2. **Icon** (`icon-name`) - Takes priority if no `src` is provided
16
+ * - Shows custom icon if `icon-name` is set (requires icon library to load)
17
+ * - **Note:** If both `icon-name` and `initials` are provided (without `src`), icon takes precedence and initials are ignored.
18
+ * This means users may see a delay while the icon loads, even though initials render instantly.
19
+ * - Defaults to `user-regular` icon if no other content is available
20
+ * 3. **Initials** (`initials`) - Displayed only if no `src` or `icon-name` is provided
21
+ * - Shows first two characters, converted to uppercase
22
+ * - Renders instantly (no loading required)
23
+ * 4. **Counter** (`counter`) - Displayed only if none of the above are provided
24
+ * - Shows numeric value (max 99+)
25
+ * - Negative values display as 0
26
+ *
27
+ * ## Behavior
28
+ * - Non-interactive and non-focusable component (use `mdc-avatarbutton` for clickable avatars)
29
+ * - Shows loading indicator overlay when `is-typing` is true (displays on top of existing content)
30
+ * - Presence indicator hidden when counter is set or when typing
24
31
  *
25
32
  * @dependency mdc-icon
26
33
  * @dependency mdc-presence