@momentum-design/components 0.58.0 → 0.59.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +170 -166
- package/dist/browser/index.js.map +4 -4
- package/dist/components/button/button.component.d.ts +3 -56
- package/dist/components/button/button.component.js +3 -96
- package/dist/components/buttonlink/buttonlink.component.d.ts +59 -0
- package/dist/components/buttonlink/buttonlink.component.js +106 -0
- package/dist/components/buttonlink/buttonlink.constants.d.ts +2 -0
- package/dist/components/buttonlink/buttonlink.constants.js +3 -0
- package/dist/components/buttonlink/buttonlink.types.d.ts +7 -0
- package/dist/components/buttonlink/buttonlink.types.js +1 -0
- package/dist/components/buttonlink/index.d.ts +8 -0
- package/dist/components/buttonlink/index.js +5 -0
- package/dist/custom-elements.json +970 -150
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/buttonlink/index.d.ts +30 -0
- package/dist/react/buttonlink/index.js +38 -0
- package/dist/react/index.d.ts +1 -0
- package/dist/react/index.js +1 -0
- package/dist/utils/mixins/ButtonComponentMixin.d.ts +16 -0
- package/dist/utils/mixins/ButtonComponentMixin.js +114 -0
- package/package.json +1 -1
@@ -1948,36 +1948,6 @@
|
|
1948
1948
|
}
|
1949
1949
|
],
|
1950
1950
|
"members": [
|
1951
|
-
{
|
1952
|
-
"kind": "field",
|
1953
|
-
"name": "prefixIcon",
|
1954
|
-
"type": {
|
1955
|
-
"text": "IconNames | undefined"
|
1956
|
-
},
|
1957
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1958
|
-
"attribute": "prefix-icon",
|
1959
|
-
"reflects": true
|
1960
|
-
},
|
1961
|
-
{
|
1962
|
-
"kind": "field",
|
1963
|
-
"name": "postfixIcon",
|
1964
|
-
"type": {
|
1965
|
-
"text": "IconNames | undefined"
|
1966
|
-
},
|
1967
|
-
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1968
|
-
"attribute": "postfix-icon",
|
1969
|
-
"reflects": true
|
1970
|
-
},
|
1971
|
-
{
|
1972
|
-
"kind": "field",
|
1973
|
-
"name": "variant",
|
1974
|
-
"type": {
|
1975
|
-
"text": "ButtonVariant"
|
1976
|
-
},
|
1977
|
-
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
1978
|
-
"default": "primary",
|
1979
|
-
"attribute": "variant"
|
1980
|
-
},
|
1981
1951
|
{
|
1982
1952
|
"kind": "field",
|
1983
1953
|
"name": "size",
|
@@ -1993,16 +1963,6 @@
|
|
1993
1963
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
1994
1964
|
}
|
1995
1965
|
},
|
1996
|
-
{
|
1997
|
-
"kind": "field",
|
1998
|
-
"name": "color",
|
1999
|
-
"type": {
|
2000
|
-
"text": "ButtonColor"
|
2001
|
-
},
|
2002
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2003
|
-
"default": "default",
|
2004
|
-
"attribute": "color"
|
2005
|
-
},
|
2006
1966
|
{
|
2007
1967
|
"kind": "field",
|
2008
1968
|
"name": "role",
|
@@ -2034,10 +1994,65 @@
|
|
2034
1994
|
],
|
2035
1995
|
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
2036
1996
|
},
|
1997
|
+
{
|
1998
|
+
"kind": "field",
|
1999
|
+
"name": "prefixIcon",
|
2000
|
+
"type": {
|
2001
|
+
"text": "IconNames | undefined"
|
2002
|
+
},
|
2003
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2004
|
+
"attribute": "prefix-icon",
|
2005
|
+
"reflects": true,
|
2006
|
+
"inheritedFrom": {
|
2007
|
+
"name": "ButtonComponentMixin",
|
2008
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2009
|
+
}
|
2010
|
+
},
|
2011
|
+
{
|
2012
|
+
"kind": "field",
|
2013
|
+
"name": "postfixIcon",
|
2014
|
+
"type": {
|
2015
|
+
"text": "IconNames | undefined"
|
2016
|
+
},
|
2017
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2018
|
+
"attribute": "postfix-icon",
|
2019
|
+
"reflects": true,
|
2020
|
+
"inheritedFrom": {
|
2021
|
+
"name": "ButtonComponentMixin",
|
2022
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2023
|
+
}
|
2024
|
+
},
|
2025
|
+
{
|
2026
|
+
"kind": "field",
|
2027
|
+
"name": "variant",
|
2028
|
+
"type": {
|
2029
|
+
"text": "ButtonVariant"
|
2030
|
+
},
|
2031
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2032
|
+
"default": "primary",
|
2033
|
+
"attribute": "variant",
|
2034
|
+
"inheritedFrom": {
|
2035
|
+
"name": "ButtonComponentMixin",
|
2036
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2037
|
+
}
|
2038
|
+
},
|
2039
|
+
{
|
2040
|
+
"kind": "field",
|
2041
|
+
"name": "color",
|
2042
|
+
"type": {
|
2043
|
+
"text": "ButtonColor"
|
2044
|
+
},
|
2045
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2046
|
+
"default": "default",
|
2047
|
+
"attribute": "color",
|
2048
|
+
"inheritedFrom": {
|
2049
|
+
"name": "ButtonComponentMixin",
|
2050
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2051
|
+
}
|
2052
|
+
},
|
2037
2053
|
{
|
2038
2054
|
"kind": "method",
|
2039
2055
|
"name": "setVariant",
|
2040
|
-
"privacy": "private",
|
2041
2056
|
"parameters": [
|
2042
2057
|
{
|
2043
2058
|
"name": "variant",
|
@@ -2047,49 +2062,62 @@
|
|
2047
2062
|
"description": "The variant to set."
|
2048
2063
|
}
|
2049
2064
|
],
|
2050
|
-
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
2065
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
|
2066
|
+
"inheritedFrom": {
|
2067
|
+
"name": "ButtonComponentMixin",
|
2068
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2069
|
+
}
|
2051
2070
|
},
|
2052
2071
|
{
|
2053
2072
|
"kind": "method",
|
2054
|
-
"name": "
|
2055
|
-
"privacy": "private",
|
2073
|
+
"name": "setColor",
|
2056
2074
|
"parameters": [
|
2057
2075
|
{
|
2058
|
-
"name": "
|
2076
|
+
"name": "color",
|
2059
2077
|
"type": {
|
2060
|
-
"text": "
|
2078
|
+
"text": "ButtonColor"
|
2061
2079
|
},
|
2062
|
-
"description": "The
|
2080
|
+
"description": "The color to set."
|
2063
2081
|
}
|
2064
2082
|
],
|
2065
|
-
"description": "Sets the
|
2083
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2084
|
+
"inheritedFrom": {
|
2085
|
+
"name": "ButtonComponentMixin",
|
2086
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2087
|
+
}
|
2066
2088
|
},
|
2067
2089
|
{
|
2068
2090
|
"kind": "method",
|
2069
|
-
"name": "
|
2070
|
-
"privacy": "private",
|
2091
|
+
"name": "setSize",
|
2071
2092
|
"parameters": [
|
2072
2093
|
{
|
2073
|
-
"name": "
|
2094
|
+
"name": "size",
|
2074
2095
|
"type": {
|
2075
|
-
"text": "
|
2096
|
+
"text": "PillButtonSize | IconButtonSize"
|
2076
2097
|
},
|
2077
|
-
"description": "The
|
2098
|
+
"description": "The size to set."
|
2078
2099
|
}
|
2079
2100
|
],
|
2080
|
-
"description": "Sets the
|
2101
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
|
2102
|
+
"inheritedFrom": {
|
2103
|
+
"name": "ButtonComponentMixin",
|
2104
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2105
|
+
}
|
2081
2106
|
},
|
2082
2107
|
{
|
2083
2108
|
"kind": "method",
|
2084
2109
|
"name": "inferButtonType",
|
2085
|
-
"privacy": "private",
|
2086
2110
|
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2087
2111
|
"parameters": [
|
2088
2112
|
{
|
2089
2113
|
"description": "default slot of button",
|
2090
2114
|
"name": "slot"
|
2091
2115
|
}
|
2092
|
-
]
|
2116
|
+
],
|
2117
|
+
"inheritedFrom": {
|
2118
|
+
"name": "ButtonComponentMixin",
|
2119
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2120
|
+
}
|
2093
2121
|
},
|
2094
2122
|
{
|
2095
2123
|
"kind": "field",
|
@@ -2328,13 +2356,43 @@
|
|
2328
2356
|
}
|
2329
2357
|
],
|
2330
2358
|
"attributes": [
|
2359
|
+
{
|
2360
|
+
"name": "size",
|
2361
|
+
"type": {
|
2362
|
+
"text": "ButtonSize"
|
2363
|
+
},
|
2364
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2365
|
+
"default": "32",
|
2366
|
+
"fieldName": "size",
|
2367
|
+
"inheritedFrom": {
|
2368
|
+
"name": "Buttonsimple",
|
2369
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2370
|
+
}
|
2371
|
+
},
|
2372
|
+
{
|
2373
|
+
"name": "role",
|
2374
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2375
|
+
"default": "'button'",
|
2376
|
+
"fieldName": "role",
|
2377
|
+
"type": {
|
2378
|
+
"text": "string"
|
2379
|
+
},
|
2380
|
+
"inheritedFrom": {
|
2381
|
+
"name": "Buttonsimple",
|
2382
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2383
|
+
}
|
2384
|
+
},
|
2331
2385
|
{
|
2332
2386
|
"name": "prefix-icon",
|
2333
2387
|
"type": {
|
2334
2388
|
"text": "IconNames | undefined"
|
2335
2389
|
},
|
2336
2390
|
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2337
|
-
"fieldName": "prefixIcon"
|
2391
|
+
"fieldName": "prefixIcon",
|
2392
|
+
"inheritedFrom": {
|
2393
|
+
"name": "ButtonComponentMixin",
|
2394
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2395
|
+
}
|
2338
2396
|
},
|
2339
2397
|
{
|
2340
2398
|
"name": "postfix-icon",
|
@@ -2342,7 +2400,11 @@
|
|
2342
2400
|
"text": "IconNames | undefined"
|
2343
2401
|
},
|
2344
2402
|
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2345
|
-
"fieldName": "postfixIcon"
|
2403
|
+
"fieldName": "postfixIcon",
|
2404
|
+
"inheritedFrom": {
|
2405
|
+
"name": "ButtonComponentMixin",
|
2406
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2407
|
+
}
|
2346
2408
|
},
|
2347
2409
|
{
|
2348
2410
|
"name": "variant",
|
@@ -2351,19 +2413,10 @@
|
|
2351
2413
|
},
|
2352
2414
|
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2353
2415
|
"default": "primary",
|
2354
|
-
"fieldName": "variant"
|
2355
|
-
},
|
2356
|
-
{
|
2357
|
-
"name": "size",
|
2358
|
-
"type": {
|
2359
|
-
"text": "ButtonSize"
|
2360
|
-
},
|
2361
|
-
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2362
|
-
"default": "32",
|
2363
|
-
"fieldName": "size",
|
2416
|
+
"fieldName": "variant",
|
2364
2417
|
"inheritedFrom": {
|
2365
|
-
"name": "
|
2366
|
-
"module": "src/
|
2418
|
+
"name": "ButtonComponentMixin",
|
2419
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2367
2420
|
}
|
2368
2421
|
},
|
2369
2422
|
{
|
@@ -2373,19 +2426,10 @@
|
|
2373
2426
|
},
|
2374
2427
|
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2375
2428
|
"default": "default",
|
2376
|
-
"fieldName": "color"
|
2377
|
-
},
|
2378
|
-
{
|
2379
|
-
"name": "role",
|
2380
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2381
|
-
"default": "'button'",
|
2382
|
-
"fieldName": "role",
|
2383
|
-
"type": {
|
2384
|
-
"text": "string"
|
2385
|
-
},
|
2429
|
+
"fieldName": "color",
|
2386
2430
|
"inheritedFrom": {
|
2387
|
-
"name": "
|
2388
|
-
"module": "src/
|
2431
|
+
"name": "ButtonComponentMixin",
|
2432
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2389
2433
|
}
|
2390
2434
|
},
|
2391
2435
|
{
|
@@ -2415,100 +2459,716 @@
|
|
2415
2459
|
}
|
2416
2460
|
},
|
2417
2461
|
{
|
2418
|
-
"name": "active",
|
2419
|
-
"type": {
|
2420
|
-
"text": "boolean | undefined"
|
2421
|
-
},
|
2422
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2423
|
-
"default": "undefined",
|
2424
|
-
"fieldName": "active",
|
2462
|
+
"name": "active",
|
2463
|
+
"type": {
|
2464
|
+
"text": "boolean | undefined"
|
2465
|
+
},
|
2466
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2467
|
+
"default": "undefined",
|
2468
|
+
"fieldName": "active",
|
2469
|
+
"inheritedFrom": {
|
2470
|
+
"name": "Buttonsimple",
|
2471
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2472
|
+
}
|
2473
|
+
},
|
2474
|
+
{
|
2475
|
+
"name": "soft-disabled",
|
2476
|
+
"type": {
|
2477
|
+
"text": "boolean | undefined"
|
2478
|
+
},
|
2479
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2480
|
+
"default": "undefined",
|
2481
|
+
"fieldName": "softDisabled",
|
2482
|
+
"inheritedFrom": {
|
2483
|
+
"name": "Buttonsimple",
|
2484
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2485
|
+
}
|
2486
|
+
},
|
2487
|
+
{
|
2488
|
+
"name": "ariaStateKey",
|
2489
|
+
"type": {
|
2490
|
+
"text": "string | undefined"
|
2491
|
+
},
|
2492
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2493
|
+
"default": "'aria-pressed' (when)",
|
2494
|
+
"fieldName": "ariaStateKey",
|
2495
|
+
"inheritedFrom": {
|
2496
|
+
"name": "Buttonsimple",
|
2497
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2498
|
+
}
|
2499
|
+
},
|
2500
|
+
{
|
2501
|
+
"name": "type",
|
2502
|
+
"type": {
|
2503
|
+
"text": "ButtonType"
|
2504
|
+
},
|
2505
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2506
|
+
"default": "button",
|
2507
|
+
"fieldName": "type",
|
2508
|
+
"inheritedFrom": {
|
2509
|
+
"name": "Buttonsimple",
|
2510
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2511
|
+
}
|
2512
|
+
}
|
2513
|
+
],
|
2514
|
+
"mixins": [
|
2515
|
+
{
|
2516
|
+
"name": "ButtonComponentMixin",
|
2517
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
2518
|
+
}
|
2519
|
+
],
|
2520
|
+
"superclass": {
|
2521
|
+
"name": "Buttonsimple",
|
2522
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2523
|
+
},
|
2524
|
+
"tagName": "mdc-button",
|
2525
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2526
|
+
"customElement": true,
|
2527
|
+
"events": [
|
2528
|
+
{
|
2529
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2530
|
+
"name": "click",
|
2531
|
+
"reactName": "onClick",
|
2532
|
+
"inheritedFrom": {
|
2533
|
+
"name": "Buttonsimple",
|
2534
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2535
|
+
}
|
2536
|
+
},
|
2537
|
+
{
|
2538
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2539
|
+
"name": "keydown",
|
2540
|
+
"reactName": "onKeyDown",
|
2541
|
+
"inheritedFrom": {
|
2542
|
+
"name": "Buttonsimple",
|
2543
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2544
|
+
}
|
2545
|
+
},
|
2546
|
+
{
|
2547
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2548
|
+
"name": "keyup",
|
2549
|
+
"reactName": "onKeyUp",
|
2550
|
+
"inheritedFrom": {
|
2551
|
+
"name": "Buttonsimple",
|
2552
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2553
|
+
}
|
2554
|
+
},
|
2555
|
+
{
|
2556
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2557
|
+
"name": "focus",
|
2558
|
+
"reactName": "onFocus",
|
2559
|
+
"inheritedFrom": {
|
2560
|
+
"name": "Buttonsimple",
|
2561
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2562
|
+
}
|
2563
|
+
}
|
2564
|
+
]
|
2565
|
+
}
|
2566
|
+
],
|
2567
|
+
"exports": [
|
2568
|
+
{
|
2569
|
+
"kind": "js",
|
2570
|
+
"name": "default",
|
2571
|
+
"declaration": {
|
2572
|
+
"name": "Button",
|
2573
|
+
"module": "components/button/button.component.js"
|
2574
|
+
}
|
2575
|
+
}
|
2576
|
+
]
|
2577
|
+
},
|
2578
|
+
{
|
2579
|
+
"kind": "javascript-module",
|
2580
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
2581
|
+
"declarations": [
|
2582
|
+
{
|
2583
|
+
"kind": "class",
|
2584
|
+
"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`.",
|
2585
|
+
"name": "ButtonLink",
|
2586
|
+
"members": [
|
2587
|
+
{
|
2588
|
+
"kind": "field",
|
2589
|
+
"name": "size",
|
2590
|
+
"type": {
|
2591
|
+
"text": "PillButtonSize | IconButtonSize"
|
2592
|
+
},
|
2593
|
+
"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.",
|
2594
|
+
"default": "32",
|
2595
|
+
"attribute": "size",
|
2596
|
+
"reflects": true
|
2597
|
+
},
|
2598
|
+
{
|
2599
|
+
"kind": "field",
|
2600
|
+
"name": "softDisabled",
|
2601
|
+
"type": {
|
2602
|
+
"text": "boolean | undefined"
|
2603
|
+
},
|
2604
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2605
|
+
"default": "undefined",
|
2606
|
+
"attribute": "soft-disabled",
|
2607
|
+
"reflects": true
|
2608
|
+
},
|
2609
|
+
{
|
2610
|
+
"kind": "method",
|
2611
|
+
"name": "setSoftDisabled",
|
2612
|
+
"privacy": "private",
|
2613
|
+
"parameters": [
|
2614
|
+
{
|
2615
|
+
"name": "element",
|
2616
|
+
"type": {
|
2617
|
+
"text": "HTMLElement"
|
2618
|
+
},
|
2619
|
+
"description": "The buttonlink element."
|
2620
|
+
},
|
2621
|
+
{
|
2622
|
+
"name": "softDisabled",
|
2623
|
+
"optional": true,
|
2624
|
+
"type": {
|
2625
|
+
"text": "boolean"
|
2626
|
+
},
|
2627
|
+
"description": "The soft-disabled state."
|
2628
|
+
}
|
2629
|
+
],
|
2630
|
+
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
2631
|
+
},
|
2632
|
+
{
|
2633
|
+
"kind": "field",
|
2634
|
+
"name": "prefixIcon",
|
2635
|
+
"type": {
|
2636
|
+
"text": "IconNames | undefined"
|
2637
|
+
},
|
2638
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2639
|
+
"attribute": "prefix-icon",
|
2640
|
+
"reflects": true,
|
2641
|
+
"inheritedFrom": {
|
2642
|
+
"name": "ButtonComponentMixin",
|
2643
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2644
|
+
}
|
2645
|
+
},
|
2646
|
+
{
|
2647
|
+
"kind": "field",
|
2648
|
+
"name": "postfixIcon",
|
2649
|
+
"type": {
|
2650
|
+
"text": "IconNames | undefined"
|
2651
|
+
},
|
2652
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2653
|
+
"attribute": "postfix-icon",
|
2654
|
+
"reflects": true,
|
2655
|
+
"inheritedFrom": {
|
2656
|
+
"name": "ButtonComponentMixin",
|
2657
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2658
|
+
}
|
2659
|
+
},
|
2660
|
+
{
|
2661
|
+
"kind": "field",
|
2662
|
+
"name": "variant",
|
2663
|
+
"type": {
|
2664
|
+
"text": "ButtonVariant"
|
2665
|
+
},
|
2666
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2667
|
+
"default": "primary",
|
2668
|
+
"attribute": "variant",
|
2669
|
+
"inheritedFrom": {
|
2670
|
+
"name": "ButtonComponentMixin",
|
2671
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2672
|
+
}
|
2673
|
+
},
|
2674
|
+
{
|
2675
|
+
"kind": "field",
|
2676
|
+
"name": "color",
|
2677
|
+
"type": {
|
2678
|
+
"text": "ButtonColor"
|
2679
|
+
},
|
2680
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2681
|
+
"default": "default",
|
2682
|
+
"attribute": "color",
|
2683
|
+
"inheritedFrom": {
|
2684
|
+
"name": "ButtonComponentMixin",
|
2685
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2686
|
+
}
|
2687
|
+
},
|
2688
|
+
{
|
2689
|
+
"kind": "method",
|
2690
|
+
"name": "setVariant",
|
2691
|
+
"parameters": [
|
2692
|
+
{
|
2693
|
+
"name": "variant",
|
2694
|
+
"type": {
|
2695
|
+
"text": "ButtonVariant"
|
2696
|
+
},
|
2697
|
+
"description": "The variant to set."
|
2698
|
+
}
|
2699
|
+
],
|
2700
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
|
2701
|
+
"inheritedFrom": {
|
2702
|
+
"name": "ButtonComponentMixin",
|
2703
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2704
|
+
}
|
2705
|
+
},
|
2706
|
+
{
|
2707
|
+
"kind": "method",
|
2708
|
+
"name": "setColor",
|
2709
|
+
"parameters": [
|
2710
|
+
{
|
2711
|
+
"name": "color",
|
2712
|
+
"type": {
|
2713
|
+
"text": "ButtonColor"
|
2714
|
+
},
|
2715
|
+
"description": "The color to set."
|
2716
|
+
}
|
2717
|
+
],
|
2718
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2719
|
+
"inheritedFrom": {
|
2720
|
+
"name": "ButtonComponentMixin",
|
2721
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2722
|
+
}
|
2723
|
+
},
|
2724
|
+
{
|
2725
|
+
"kind": "method",
|
2726
|
+
"name": "setSize",
|
2727
|
+
"parameters": [
|
2728
|
+
{
|
2729
|
+
"name": "size",
|
2730
|
+
"type": {
|
2731
|
+
"text": "PillButtonSize | IconButtonSize"
|
2732
|
+
},
|
2733
|
+
"description": "The size to set."
|
2734
|
+
}
|
2735
|
+
],
|
2736
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
|
2737
|
+
"inheritedFrom": {
|
2738
|
+
"name": "ButtonComponentMixin",
|
2739
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2740
|
+
}
|
2741
|
+
},
|
2742
|
+
{
|
2743
|
+
"kind": "method",
|
2744
|
+
"name": "inferButtonType",
|
2745
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2746
|
+
"parameters": [
|
2747
|
+
{
|
2748
|
+
"description": "default slot of button",
|
2749
|
+
"name": "slot"
|
2750
|
+
}
|
2751
|
+
],
|
2752
|
+
"inheritedFrom": {
|
2753
|
+
"name": "ButtonComponentMixin",
|
2754
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2755
|
+
}
|
2756
|
+
},
|
2757
|
+
{
|
2758
|
+
"kind": "field",
|
2759
|
+
"name": "disabled",
|
2760
|
+
"type": {
|
2761
|
+
"text": "boolean | undefined"
|
2762
|
+
},
|
2763
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2764
|
+
"default": "undefined",
|
2765
|
+
"attribute": "disabled",
|
2766
|
+
"reflects": true,
|
2767
|
+
"inheritedFrom": {
|
2768
|
+
"name": "DisabledMixin",
|
2769
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2770
|
+
}
|
2771
|
+
},
|
2772
|
+
{
|
2773
|
+
"kind": "field",
|
2774
|
+
"name": "tabIndex",
|
2775
|
+
"type": {
|
2776
|
+
"text": "number"
|
2777
|
+
},
|
2778
|
+
"default": "0",
|
2779
|
+
"description": "This property specifies the tab order of the element.",
|
2780
|
+
"attribute": "tabIndex",
|
2781
|
+
"reflects": true,
|
2782
|
+
"inheritedFrom": {
|
2783
|
+
"name": "TabIndexMixin",
|
2784
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
2785
|
+
}
|
2786
|
+
},
|
2787
|
+
{
|
2788
|
+
"kind": "field",
|
2789
|
+
"name": "inline",
|
2790
|
+
"type": {
|
2791
|
+
"text": "boolean"
|
2792
|
+
},
|
2793
|
+
"description": "The link can be inline or standalone.",
|
2794
|
+
"default": "false",
|
2795
|
+
"attribute": "inline",
|
2796
|
+
"reflects": true,
|
2797
|
+
"inheritedFrom": {
|
2798
|
+
"name": "Linksimple",
|
2799
|
+
"module": "components/linksimple/linksimple.component.js"
|
2800
|
+
}
|
2801
|
+
},
|
2802
|
+
{
|
2803
|
+
"kind": "field",
|
2804
|
+
"name": "inverted",
|
2805
|
+
"type": {
|
2806
|
+
"text": "boolean"
|
2807
|
+
},
|
2808
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
2809
|
+
"default": "false",
|
2810
|
+
"attribute": "inverted",
|
2811
|
+
"reflects": true,
|
2812
|
+
"inheritedFrom": {
|
2813
|
+
"name": "Linksimple",
|
2814
|
+
"module": "components/linksimple/linksimple.component.js"
|
2815
|
+
}
|
2816
|
+
},
|
2817
|
+
{
|
2818
|
+
"kind": "field",
|
2819
|
+
"name": "href",
|
2820
|
+
"type": {
|
2821
|
+
"text": "string"
|
2822
|
+
},
|
2823
|
+
"default": "'#'",
|
2824
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
2825
|
+
"attribute": "href",
|
2826
|
+
"reflects": true,
|
2827
|
+
"inheritedFrom": {
|
2828
|
+
"name": "Linksimple",
|
2829
|
+
"module": "components/linksimple/linksimple.component.js"
|
2830
|
+
}
|
2831
|
+
},
|
2832
|
+
{
|
2833
|
+
"kind": "field",
|
2834
|
+
"name": "target",
|
2835
|
+
"type": {
|
2836
|
+
"text": "string"
|
2837
|
+
},
|
2838
|
+
"default": "'_self'",
|
2839
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
2840
|
+
"attribute": "target",
|
2841
|
+
"reflects": true,
|
2842
|
+
"inheritedFrom": {
|
2843
|
+
"name": "Linksimple",
|
2844
|
+
"module": "components/linksimple/linksimple.component.js"
|
2845
|
+
}
|
2846
|
+
},
|
2847
|
+
{
|
2848
|
+
"kind": "field",
|
2849
|
+
"name": "rel",
|
2850
|
+
"type": {
|
2851
|
+
"text": "string | undefined"
|
2852
|
+
},
|
2853
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
2854
|
+
"attribute": "rel",
|
2855
|
+
"reflects": true,
|
2856
|
+
"inheritedFrom": {
|
2857
|
+
"name": "Linksimple",
|
2858
|
+
"module": "components/linksimple/linksimple.component.js"
|
2859
|
+
}
|
2860
|
+
},
|
2861
|
+
{
|
2862
|
+
"kind": "field",
|
2863
|
+
"name": "handleNavigation",
|
2864
|
+
"privacy": "private",
|
2865
|
+
"inheritedFrom": {
|
2866
|
+
"name": "Linksimple",
|
2867
|
+
"module": "components/linksimple/linksimple.component.js"
|
2868
|
+
}
|
2869
|
+
},
|
2870
|
+
{
|
2871
|
+
"kind": "method",
|
2872
|
+
"name": "setDisabled",
|
2873
|
+
"privacy": "private",
|
2874
|
+
"parameters": [
|
2875
|
+
{
|
2876
|
+
"name": "disabled",
|
2877
|
+
"type": {
|
2878
|
+
"text": "boolean"
|
2879
|
+
},
|
2880
|
+
"description": "Whether the element should be disabled"
|
2881
|
+
}
|
2882
|
+
],
|
2883
|
+
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored.",
|
2884
|
+
"inheritedFrom": {
|
2885
|
+
"name": "Linksimple",
|
2886
|
+
"module": "components/linksimple/linksimple.component.js"
|
2887
|
+
}
|
2888
|
+
}
|
2889
|
+
],
|
2890
|
+
"events": [
|
2891
|
+
{
|
2892
|
+
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
2893
|
+
"name": "click",
|
2894
|
+
"reactName": "onClick",
|
2895
|
+
"inheritedFrom": {
|
2896
|
+
"name": "Linksimple",
|
2897
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2898
|
+
}
|
2899
|
+
},
|
2900
|
+
{
|
2901
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
2902
|
+
"name": "keydown",
|
2903
|
+
"reactName": "onKeyDown",
|
2904
|
+
"inheritedFrom": {
|
2905
|
+
"name": "Linksimple",
|
2906
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2907
|
+
}
|
2908
|
+
},
|
2909
|
+
{
|
2910
|
+
"description": "(React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.",
|
2911
|
+
"name": "focus",
|
2912
|
+
"reactName": "onFocus",
|
2913
|
+
"inheritedFrom": {
|
2914
|
+
"name": "Linksimple",
|
2915
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2916
|
+
}
|
2917
|
+
},
|
2918
|
+
{
|
2919
|
+
"description": "(React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.",
|
2920
|
+
"name": "blur",
|
2921
|
+
"reactName": "onBlur",
|
2922
|
+
"inheritedFrom": {
|
2923
|
+
"name": "Linksimple",
|
2924
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2925
|
+
}
|
2926
|
+
}
|
2927
|
+
],
|
2928
|
+
"attributes": [
|
2929
|
+
{
|
2930
|
+
"name": "size",
|
2931
|
+
"type": {
|
2932
|
+
"text": "PillButtonSize | IconButtonSize"
|
2933
|
+
},
|
2934
|
+
"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.",
|
2935
|
+
"default": "32",
|
2936
|
+
"fieldName": "size"
|
2937
|
+
},
|
2938
|
+
{
|
2939
|
+
"name": "soft-disabled",
|
2940
|
+
"type": {
|
2941
|
+
"text": "boolean | undefined"
|
2942
|
+
},
|
2943
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2944
|
+
"default": "undefined",
|
2945
|
+
"fieldName": "softDisabled"
|
2946
|
+
},
|
2947
|
+
{
|
2948
|
+
"name": "prefix-icon",
|
2949
|
+
"type": {
|
2950
|
+
"text": "IconNames | undefined"
|
2951
|
+
},
|
2952
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2953
|
+
"fieldName": "prefixIcon",
|
2954
|
+
"inheritedFrom": {
|
2955
|
+
"name": "ButtonComponentMixin",
|
2956
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2957
|
+
}
|
2958
|
+
},
|
2959
|
+
{
|
2960
|
+
"name": "postfix-icon",
|
2961
|
+
"type": {
|
2962
|
+
"text": "IconNames | undefined"
|
2963
|
+
},
|
2964
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2965
|
+
"fieldName": "postfixIcon",
|
2966
|
+
"inheritedFrom": {
|
2967
|
+
"name": "ButtonComponentMixin",
|
2968
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2969
|
+
}
|
2970
|
+
},
|
2971
|
+
{
|
2972
|
+
"name": "variant",
|
2973
|
+
"type": {
|
2974
|
+
"text": "ButtonVariant"
|
2975
|
+
},
|
2976
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2977
|
+
"default": "primary",
|
2978
|
+
"fieldName": "variant",
|
2979
|
+
"inheritedFrom": {
|
2980
|
+
"name": "ButtonComponentMixin",
|
2981
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2982
|
+
}
|
2983
|
+
},
|
2984
|
+
{
|
2985
|
+
"name": "color",
|
2986
|
+
"type": {
|
2987
|
+
"text": "ButtonColor"
|
2988
|
+
},
|
2989
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2990
|
+
"default": "default",
|
2991
|
+
"fieldName": "color",
|
2992
|
+
"inheritedFrom": {
|
2993
|
+
"name": "ButtonComponentMixin",
|
2994
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2995
|
+
}
|
2996
|
+
},
|
2997
|
+
{
|
2998
|
+
"name": "disabled",
|
2999
|
+
"type": {
|
3000
|
+
"text": "boolean | undefined"
|
3001
|
+
},
|
3002
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3003
|
+
"default": "undefined",
|
3004
|
+
"fieldName": "disabled",
|
3005
|
+
"inheritedFrom": {
|
3006
|
+
"name": "DisabledMixin",
|
3007
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
3008
|
+
}
|
3009
|
+
},
|
3010
|
+
{
|
3011
|
+
"name": "tabIndex",
|
3012
|
+
"type": {
|
3013
|
+
"text": "number"
|
3014
|
+
},
|
3015
|
+
"default": "0",
|
3016
|
+
"description": "This property specifies the tab order of the element.",
|
3017
|
+
"fieldName": "tabIndex",
|
3018
|
+
"inheritedFrom": {
|
3019
|
+
"name": "TabIndexMixin",
|
3020
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
3021
|
+
}
|
3022
|
+
},
|
3023
|
+
{
|
3024
|
+
"name": "inline",
|
3025
|
+
"type": {
|
3026
|
+
"text": "boolean"
|
3027
|
+
},
|
3028
|
+
"description": "The link can be inline or standalone.",
|
3029
|
+
"default": "false",
|
3030
|
+
"fieldName": "inline",
|
3031
|
+
"inheritedFrom": {
|
3032
|
+
"name": "Linksimple",
|
3033
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3034
|
+
}
|
3035
|
+
},
|
3036
|
+
{
|
3037
|
+
"name": "inverted",
|
3038
|
+
"type": {
|
3039
|
+
"text": "boolean"
|
3040
|
+
},
|
3041
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3042
|
+
"default": "false",
|
3043
|
+
"fieldName": "inverted",
|
3044
|
+
"inheritedFrom": {
|
3045
|
+
"name": "Linksimple",
|
3046
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3047
|
+
}
|
3048
|
+
},
|
3049
|
+
{
|
3050
|
+
"name": "href",
|
3051
|
+
"type": {
|
3052
|
+
"text": "string"
|
3053
|
+
},
|
3054
|
+
"default": "'#'",
|
3055
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
3056
|
+
"fieldName": "href",
|
3057
|
+
"inheritedFrom": {
|
3058
|
+
"name": "Linksimple",
|
3059
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3060
|
+
}
|
3061
|
+
},
|
3062
|
+
{
|
3063
|
+
"name": "target",
|
3064
|
+
"type": {
|
3065
|
+
"text": "string"
|
3066
|
+
},
|
3067
|
+
"default": "'_self'",
|
3068
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
3069
|
+
"fieldName": "target",
|
3070
|
+
"inheritedFrom": {
|
3071
|
+
"name": "Linksimple",
|
3072
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3073
|
+
}
|
3074
|
+
},
|
3075
|
+
{
|
3076
|
+
"name": "rel",
|
3077
|
+
"type": {
|
3078
|
+
"text": "string | undefined"
|
3079
|
+
},
|
3080
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
3081
|
+
"fieldName": "rel",
|
3082
|
+
"inheritedFrom": {
|
3083
|
+
"name": "Linksimple",
|
3084
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3085
|
+
}
|
3086
|
+
}
|
3087
|
+
],
|
3088
|
+
"mixins": [
|
3089
|
+
{
|
3090
|
+
"name": "ButtonComponentMixin",
|
3091
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
3092
|
+
}
|
3093
|
+
],
|
3094
|
+
"superclass": {
|
3095
|
+
"name": "Linksimple",
|
3096
|
+
"module": "/src/components/linksimple/linksimple.component"
|
3097
|
+
},
|
3098
|
+
"tagName": "mdc-buttonlink",
|
3099
|
+
"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 */",
|
3100
|
+
"customElement": true,
|
3101
|
+
"cssProperties": [
|
3102
|
+
{
|
3103
|
+
"description": "Border radius of the link.",
|
3104
|
+
"name": "--mdc-link-border-radius",
|
3105
|
+
"inheritedFrom": {
|
3106
|
+
"name": "Linksimple",
|
3107
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
3108
|
+
}
|
3109
|
+
},
|
3110
|
+
{
|
3111
|
+
"description": "Color of the link’s child content in the active state.",
|
3112
|
+
"name": "--mdc-link-color-active",
|
2425
3113
|
"inheritedFrom": {
|
2426
|
-
"name": "
|
2427
|
-
"module": "src/components/
|
3114
|
+
"name": "Linksimple",
|
3115
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2428
3116
|
}
|
2429
3117
|
},
|
2430
3118
|
{
|
2431
|
-
"
|
2432
|
-
"
|
2433
|
-
"text": "boolean | undefined"
|
2434
|
-
},
|
2435
|
-
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2436
|
-
"default": "undefined",
|
2437
|
-
"fieldName": "softDisabled",
|
3119
|
+
"description": "Color of the link’s child content in the disabled state.",
|
3120
|
+
"name": "--mdc-link-color-disabled",
|
2438
3121
|
"inheritedFrom": {
|
2439
|
-
"name": "
|
2440
|
-
"module": "src/components/
|
3122
|
+
"name": "Linksimple",
|
3123
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2441
3124
|
}
|
2442
3125
|
},
|
2443
3126
|
{
|
2444
|
-
"
|
2445
|
-
"
|
2446
|
-
"text": "string | undefined"
|
2447
|
-
},
|
2448
|
-
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2449
|
-
"default": "'aria-pressed' (when)",
|
2450
|
-
"fieldName": "ariaStateKey",
|
3127
|
+
"description": "Color of the link’s child content in the hover state.",
|
3128
|
+
"name": "--mdc-link-color-hover",
|
2451
3129
|
"inheritedFrom": {
|
2452
|
-
"name": "
|
2453
|
-
"module": "src/components/
|
3130
|
+
"name": "Linksimple",
|
3131
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2454
3132
|
}
|
2455
3133
|
},
|
2456
3134
|
{
|
2457
|
-
"
|
2458
|
-
"
|
2459
|
-
"text": "ButtonType"
|
2460
|
-
},
|
2461
|
-
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2462
|
-
"default": "button",
|
2463
|
-
"fieldName": "type",
|
3135
|
+
"description": "Color of the link’s child content in the normal state.",
|
3136
|
+
"name": "--mdc-link-color-normal",
|
2464
3137
|
"inheritedFrom": {
|
2465
|
-
"name": "
|
2466
|
-
"module": "src/components/
|
3138
|
+
"name": "Linksimple",
|
3139
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2467
3140
|
}
|
2468
|
-
}
|
2469
|
-
],
|
2470
|
-
"superclass": {
|
2471
|
-
"name": "Buttonsimple",
|
2472
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2473
|
-
},
|
2474
|
-
"tagName": "mdc-button",
|
2475
|
-
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2476
|
-
"customElement": true,
|
2477
|
-
"events": [
|
3141
|
+
},
|
2478
3142
|
{
|
2479
|
-
"description": "
|
2480
|
-
"name": "
|
2481
|
-
"reactName": "onClick",
|
3143
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
3144
|
+
"name": "--mdc-link-inverted-color-active",
|
2482
3145
|
"inheritedFrom": {
|
2483
|
-
"name": "
|
2484
|
-
"module": "src/components/
|
3146
|
+
"name": "Linksimple",
|
3147
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2485
3148
|
}
|
2486
3149
|
},
|
2487
3150
|
{
|
2488
|
-
"description": "
|
2489
|
-
"name": "
|
2490
|
-
"reactName": "onKeyDown",
|
3151
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
3152
|
+
"name": "--mdc-link-inverted-color-disabled",
|
2491
3153
|
"inheritedFrom": {
|
2492
|
-
"name": "
|
2493
|
-
"module": "src/components/
|
3154
|
+
"name": "Linksimple",
|
3155
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2494
3156
|
}
|
2495
3157
|
},
|
2496
3158
|
{
|
2497
|
-
"description": "
|
2498
|
-
"name": "
|
2499
|
-
"reactName": "onKeyUp",
|
3159
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
3160
|
+
"name": "--mdc-link-inverted-color-hover",
|
2500
3161
|
"inheritedFrom": {
|
2501
|
-
"name": "
|
2502
|
-
"module": "src/components/
|
3162
|
+
"name": "Linksimple",
|
3163
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2503
3164
|
}
|
2504
3165
|
},
|
2505
3166
|
{
|
2506
|
-
"description": "
|
2507
|
-
"name": "
|
2508
|
-
"reactName": "onFocus",
|
3167
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
3168
|
+
"name": "--mdc-link-inverted-color-normal",
|
2509
3169
|
"inheritedFrom": {
|
2510
|
-
"name": "
|
2511
|
-
"module": "src/components/
|
3170
|
+
"name": "Linksimple",
|
3171
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
2512
3172
|
}
|
2513
3173
|
}
|
2514
3174
|
]
|
@@ -2519,8 +3179,8 @@
|
|
2519
3179
|
"kind": "js",
|
2520
3180
|
"name": "default",
|
2521
3181
|
"declaration": {
|
2522
|
-
"name": "
|
2523
|
-
"module": "components/
|
3182
|
+
"name": "ButtonLink",
|
3183
|
+
"module": "components/buttonlink/buttonlink.component.js"
|
2524
3184
|
}
|
2525
3185
|
}
|
2526
3186
|
]
|
@@ -23484,6 +24144,166 @@
|
|
23484
24144
|
}
|
23485
24145
|
]
|
23486
24146
|
},
|
24147
|
+
{
|
24148
|
+
"kind": "javascript-module",
|
24149
|
+
"path": "utils/mixins/ButtonComponentMixin.js",
|
24150
|
+
"declarations": [
|
24151
|
+
{
|
24152
|
+
"kind": "mixin",
|
24153
|
+
"description": "",
|
24154
|
+
"name": "ButtonComponentMixin",
|
24155
|
+
"members": [
|
24156
|
+
{
|
24157
|
+
"kind": "field",
|
24158
|
+
"name": "prefixIcon",
|
24159
|
+
"type": {
|
24160
|
+
"text": "IconNames | undefined"
|
24161
|
+
},
|
24162
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
24163
|
+
"attribute": "prefix-icon",
|
24164
|
+
"reflects": true
|
24165
|
+
},
|
24166
|
+
{
|
24167
|
+
"kind": "field",
|
24168
|
+
"name": "postfixIcon",
|
24169
|
+
"type": {
|
24170
|
+
"text": "IconNames | undefined"
|
24171
|
+
},
|
24172
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
24173
|
+
"attribute": "postfix-icon",
|
24174
|
+
"reflects": true
|
24175
|
+
},
|
24176
|
+
{
|
24177
|
+
"kind": "field",
|
24178
|
+
"name": "variant",
|
24179
|
+
"type": {
|
24180
|
+
"text": "ButtonVariant"
|
24181
|
+
},
|
24182
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
24183
|
+
"default": "primary",
|
24184
|
+
"attribute": "variant"
|
24185
|
+
},
|
24186
|
+
{
|
24187
|
+
"kind": "field",
|
24188
|
+
"name": "color",
|
24189
|
+
"type": {
|
24190
|
+
"text": "ButtonColor"
|
24191
|
+
},
|
24192
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
24193
|
+
"default": "default",
|
24194
|
+
"attribute": "color"
|
24195
|
+
},
|
24196
|
+
{
|
24197
|
+
"kind": "method",
|
24198
|
+
"name": "setVariant",
|
24199
|
+
"parameters": [
|
24200
|
+
{
|
24201
|
+
"name": "variant",
|
24202
|
+
"type": {
|
24203
|
+
"text": "ButtonVariant"
|
24204
|
+
},
|
24205
|
+
"description": "The variant to set."
|
24206
|
+
}
|
24207
|
+
],
|
24208
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
24209
|
+
},
|
24210
|
+
{
|
24211
|
+
"kind": "method",
|
24212
|
+
"name": "setColor",
|
24213
|
+
"parameters": [
|
24214
|
+
{
|
24215
|
+
"name": "color",
|
24216
|
+
"type": {
|
24217
|
+
"text": "ButtonColor"
|
24218
|
+
},
|
24219
|
+
"description": "The color to set."
|
24220
|
+
}
|
24221
|
+
],
|
24222
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button."
|
24223
|
+
},
|
24224
|
+
{
|
24225
|
+
"kind": "method",
|
24226
|
+
"name": "setSize",
|
24227
|
+
"parameters": [
|
24228
|
+
{
|
24229
|
+
"name": "size",
|
24230
|
+
"type": {
|
24231
|
+
"text": "PillButtonSize | IconButtonSize"
|
24232
|
+
},
|
24233
|
+
"description": "The size to set."
|
24234
|
+
}
|
24235
|
+
],
|
24236
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
|
24237
|
+
},
|
24238
|
+
{
|
24239
|
+
"kind": "method",
|
24240
|
+
"name": "inferButtonType",
|
24241
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
24242
|
+
"parameters": [
|
24243
|
+
{
|
24244
|
+
"description": "default slot of button",
|
24245
|
+
"name": "slot"
|
24246
|
+
}
|
24247
|
+
]
|
24248
|
+
}
|
24249
|
+
],
|
24250
|
+
"attributes": [
|
24251
|
+
{
|
24252
|
+
"name": "prefix-icon",
|
24253
|
+
"type": {
|
24254
|
+
"text": "IconNames | undefined"
|
24255
|
+
},
|
24256
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
24257
|
+
"fieldName": "prefixIcon"
|
24258
|
+
},
|
24259
|
+
{
|
24260
|
+
"name": "postfix-icon",
|
24261
|
+
"type": {
|
24262
|
+
"text": "IconNames | undefined"
|
24263
|
+
},
|
24264
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
24265
|
+
"fieldName": "postfixIcon"
|
24266
|
+
},
|
24267
|
+
{
|
24268
|
+
"name": "variant",
|
24269
|
+
"type": {
|
24270
|
+
"text": "ButtonVariant"
|
24271
|
+
},
|
24272
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
24273
|
+
"default": "primary",
|
24274
|
+
"fieldName": "variant"
|
24275
|
+
},
|
24276
|
+
{
|
24277
|
+
"name": "color",
|
24278
|
+
"type": {
|
24279
|
+
"text": "ButtonColor"
|
24280
|
+
},
|
24281
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
24282
|
+
"default": "default",
|
24283
|
+
"fieldName": "color"
|
24284
|
+
}
|
24285
|
+
],
|
24286
|
+
"parameters": [
|
24287
|
+
{
|
24288
|
+
"name": "superClass",
|
24289
|
+
"type": {
|
24290
|
+
"text": "T"
|
24291
|
+
}
|
24292
|
+
}
|
24293
|
+
]
|
24294
|
+
}
|
24295
|
+
],
|
24296
|
+
"exports": [
|
24297
|
+
{
|
24298
|
+
"kind": "js",
|
24299
|
+
"name": "ButtonComponentMixin",
|
24300
|
+
"declaration": {
|
24301
|
+
"name": "ButtonComponentMixin",
|
24302
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
24303
|
+
}
|
24304
|
+
}
|
24305
|
+
]
|
24306
|
+
},
|
23487
24307
|
{
|
23488
24308
|
"kind": "javascript-module",
|
23489
24309
|
"path": "utils/mixins/DataAriaLabelMixin.js",
|