@momentum-design/components 0.16.12 → 0.16.14
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/components/{labelandhelper/labelandhelper.component.d.ts → formfieldwrapper/formfieldwrapper.component.d.ts} +5 -5
- package/dist/components/{labelandhelper/labelandhelper.component.js → formfieldwrapper/formfieldwrapper.component.js} +13 -13
- package/dist/components/{labelandhelper/labelandhelper.constants.d.ts → formfieldwrapper/formfieldwrapper.constants.d.ts} +1 -1
- package/dist/components/{labelandhelper/labelandhelper.constants.js → formfieldwrapper/formfieldwrapper.constants.js} +1 -1
- package/dist/components/{labelandhelper/labelandhelper.types.d.ts → formfieldwrapper/formfieldwrapper.types.d.ts} +1 -1
- package/dist/components/{labelandhelper/labelandhelper.utils.d.ts → formfieldwrapper/formfieldwrapper.utils.d.ts} +1 -1
- package/dist/components/{labelandhelper/labelandhelper.utils.js → formfieldwrapper/formfieldwrapper.utils.js} +1 -1
- package/dist/components/formfieldwrapper/index.d.ts +9 -0
- package/dist/components/formfieldwrapper/index.js +6 -0
- package/dist/custom-elements.json +753 -753
- package/dist/react/{labelandhelper → formfieldwrapper}/index.d.ts +3 -3
- package/dist/react/{labelandhelper → formfieldwrapper}/index.js +5 -5
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
- package/dist/components/labelandhelper/index.d.ts +0 -9
- package/dist/components/labelandhelper/index.js +0 -6
- /package/dist/components/{labelandhelper/labelandhelper.styles.d.ts → formfieldwrapper/formfieldwrapper.styles.d.ts} +0 -0
- /package/dist/components/{labelandhelper/labelandhelper.styles.js → formfieldwrapper/formfieldwrapper.styles.js} +0 -0
- /package/dist/components/{labelandhelper/labelandhelper.types.js → formfieldwrapper/formfieldwrapper.types.js} +0 -0
@@ -244,798 +244,798 @@
|
|
244
244
|
},
|
245
245
|
{
|
246
246
|
"kind": "javascript-module",
|
247
|
-
"path": "components/
|
247
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
248
248
|
"declarations": [
|
249
249
|
{
|
250
250
|
"kind": "class",
|
251
|
-
"description": "The `mdc-
|
252
|
-
"name": "
|
251
|
+
"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.",
|
252
|
+
"name": "AvatarButton",
|
253
253
|
"members": [
|
254
254
|
{
|
255
255
|
"kind": "field",
|
256
|
-
"name": "
|
256
|
+
"name": "ariaLabel",
|
257
257
|
"type": {
|
258
|
-
"text": "
|
258
|
+
"text": "string | null"
|
259
259
|
},
|
260
|
-
"
|
261
|
-
"
|
262
|
-
"
|
260
|
+
"default": "null",
|
261
|
+
"description": "Aria-label attribute to be set for accessibility",
|
262
|
+
"attribute": "aria-label"
|
263
263
|
},
|
264
264
|
{
|
265
|
-
"kind": "
|
266
|
-
"name": "
|
267
|
-
"
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
265
|
+
"kind": "method",
|
266
|
+
"name": "setSize",
|
267
|
+
"privacy": "private",
|
268
|
+
"parameters": [
|
269
|
+
{
|
270
|
+
"name": "size",
|
271
|
+
"type": {
|
272
|
+
"text": "AvatarSize"
|
273
|
+
}
|
274
|
+
}
|
275
|
+
]
|
272
276
|
},
|
273
277
|
{
|
274
278
|
"kind": "field",
|
275
|
-
"name": "
|
279
|
+
"name": "active",
|
276
280
|
"type": {
|
277
|
-
"text": "
|
281
|
+
"text": "boolean"
|
278
282
|
},
|
279
|
-
"
|
280
|
-
"
|
281
|
-
"attribute": "
|
282
|
-
"
|
283
|
+
"default": "undefined as unknown",
|
284
|
+
"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.",
|
285
|
+
"attribute": "active",
|
286
|
+
"inheritedFrom": {
|
287
|
+
"name": "Buttonsimple",
|
288
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
289
|
+
}
|
283
290
|
},
|
284
291
|
{
|
285
292
|
"kind": "field",
|
286
|
-
"name": "
|
293
|
+
"name": "disabled",
|
287
294
|
"type": {
|
288
|
-
"text": "
|
295
|
+
"text": "boolean"
|
289
296
|
},
|
290
|
-
"
|
291
|
-
"
|
297
|
+
"default": "undefined as unknown",
|
298
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
299
|
+
"attribute": "disabled",
|
300
|
+
"reflects": true,
|
301
|
+
"inheritedFrom": {
|
302
|
+
"name": "DisabledMixin",
|
303
|
+
"module": "utils/mixins/DisabledMixin.js"
|
304
|
+
}
|
292
305
|
},
|
293
306
|
{
|
294
307
|
"kind": "field",
|
295
|
-
"name": "
|
308
|
+
"name": "softDisabled",
|
296
309
|
"type": {
|
297
|
-
"text": "
|
310
|
+
"text": "boolean"
|
298
311
|
},
|
299
|
-
"
|
300
|
-
"
|
301
|
-
"attribute": "
|
302
|
-
"
|
312
|
+
"default": "undefined as unknown",
|
313
|
+
"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.",
|
314
|
+
"attribute": "soft-disabled",
|
315
|
+
"inheritedFrom": {
|
316
|
+
"name": "Buttonsimple",
|
317
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
318
|
+
}
|
303
319
|
},
|
304
320
|
{
|
305
321
|
"kind": "field",
|
306
|
-
"name": "
|
322
|
+
"name": "role",
|
323
|
+
"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.",
|
324
|
+
"default": "'button'",
|
325
|
+
"attribute": "role",
|
326
|
+
"reflects": true,
|
307
327
|
"type": {
|
308
|
-
"text": "
|
328
|
+
"text": "string"
|
309
329
|
},
|
310
|
-
"
|
311
|
-
|
312
|
-
|
330
|
+
"inheritedFrom": {
|
331
|
+
"name": "Buttonsimple",
|
332
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
333
|
+
}
|
313
334
|
},
|
314
335
|
{
|
315
336
|
"kind": "field",
|
316
|
-
"name": "
|
337
|
+
"name": "type",
|
317
338
|
"type": {
|
318
|
-
"text": "
|
319
|
-
},
|
320
|
-
"default": "null",
|
321
|
-
"description": "Aria-label attribute to be set for accessibility",
|
322
|
-
"attribute": "aria-label"
|
323
|
-
},
|
324
|
-
{
|
325
|
-
"kind": "method",
|
326
|
-
"name": "getCounterText",
|
327
|
-
"privacy": "private",
|
328
|
-
"return": {
|
329
|
-
"type": {
|
330
|
-
"text": ""
|
331
|
-
}
|
332
|
-
},
|
333
|
-
"parameters": [
|
334
|
-
{
|
335
|
-
"name": "maxCounter",
|
336
|
-
"type": {
|
337
|
-
"text": "number"
|
338
|
-
},
|
339
|
-
"description": "the maximum limit which can be displayed on the badge"
|
340
|
-
},
|
341
|
-
{
|
342
|
-
"name": "counter",
|
343
|
-
"optional": true,
|
344
|
-
"type": {
|
345
|
-
"text": "number"
|
346
|
-
},
|
347
|
-
"description": "the number to be displayed on the badge"
|
348
|
-
}
|
349
|
-
],
|
350
|
-
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
351
|
-
},
|
352
|
-
{
|
353
|
-
"kind": "method",
|
354
|
-
"name": "getBadgeIcon",
|
355
|
-
"privacy": "private",
|
356
|
-
"return": {
|
357
|
-
"type": {
|
358
|
-
"text": ""
|
359
|
-
}
|
360
|
-
},
|
361
|
-
"parameters": [
|
362
|
-
{
|
363
|
-
"name": "iconName",
|
364
|
-
"type": {
|
365
|
-
"text": "string"
|
366
|
-
},
|
367
|
-
"description": "the name of the icon from the icon set"
|
368
|
-
},
|
369
|
-
{
|
370
|
-
"name": "backgroundClassPostfix",
|
371
|
-
"type": {
|
372
|
-
"text": "string"
|
373
|
-
},
|
374
|
-
"description": "postfix for the class to style the badge icon."
|
375
|
-
}
|
376
|
-
],
|
377
|
-
"description": "Method to generate the badge icon."
|
378
|
-
},
|
379
|
-
{
|
380
|
-
"kind": "method",
|
381
|
-
"name": "getBadgeDot",
|
382
|
-
"privacy": "private",
|
383
|
-
"return": {
|
384
|
-
"type": {
|
385
|
-
"text": ""
|
386
|
-
}
|
339
|
+
"text": "ButtonType"
|
387
340
|
},
|
388
|
-
"description": "
|
341
|
+
"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.",
|
342
|
+
"default": "button",
|
343
|
+
"attribute": "type",
|
344
|
+
"reflects": true,
|
345
|
+
"inheritedFrom": {
|
346
|
+
"name": "Buttonsimple",
|
347
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
348
|
+
}
|
389
349
|
},
|
390
350
|
{
|
391
|
-
"kind": "
|
392
|
-
"name": "
|
393
|
-
"
|
394
|
-
|
395
|
-
"type": {
|
396
|
-
"text": ""
|
397
|
-
}
|
351
|
+
"kind": "field",
|
352
|
+
"name": "src",
|
353
|
+
"type": {
|
354
|
+
"text": "string | undefined"
|
398
355
|
},
|
399
|
-
"description": "
|
356
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
357
|
+
"attribute": "src",
|
358
|
+
"inheritedFrom": {
|
359
|
+
"name": "AvatarComponentMixin",
|
360
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
361
|
+
}
|
400
362
|
},
|
401
363
|
{
|
402
|
-
"kind": "
|
403
|
-
"name": "
|
404
|
-
"
|
405
|
-
|
406
|
-
"type": {
|
407
|
-
"text": "void"
|
408
|
-
}
|
364
|
+
"kind": "field",
|
365
|
+
"name": "initials",
|
366
|
+
"type": {
|
367
|
+
"text": "string | undefined"
|
409
368
|
},
|
410
|
-
"description": "
|
369
|
+
"description": "The initials to be displayed for the avatar.",
|
370
|
+
"attribute": "initials",
|
371
|
+
"inheritedFrom": {
|
372
|
+
"name": "AvatarComponentMixin",
|
373
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
374
|
+
}
|
411
375
|
},
|
412
376
|
{
|
413
|
-
"kind": "
|
414
|
-
"name": "
|
415
|
-
"privacy": "private",
|
416
|
-
"return": {
|
417
|
-
"type": {
|
418
|
-
"text": ""
|
419
|
-
}
|
420
|
-
},
|
421
|
-
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
422
|
-
}
|
423
|
-
],
|
424
|
-
"attributes": [
|
425
|
-
{
|
426
|
-
"name": "type",
|
377
|
+
"kind": "field",
|
378
|
+
"name": "presence",
|
427
379
|
"type": {
|
428
|
-
"text": "
|
380
|
+
"text": "PresenceType | undefined"
|
429
381
|
},
|
430
|
-
"description": "
|
431
|
-
"
|
382
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
383
|
+
"attribute": "presence",
|
384
|
+
"inheritedFrom": {
|
385
|
+
"name": "AvatarComponentMixin",
|
386
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
387
|
+
}
|
432
388
|
},
|
433
389
|
{
|
434
|
-
"
|
390
|
+
"kind": "field",
|
391
|
+
"name": "size",
|
435
392
|
"type": {
|
436
|
-
"text": "
|
393
|
+
"text": "ButtonSize"
|
437
394
|
},
|
438
|
-
"description": "
|
439
|
-
"
|
395
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
396
|
+
"default": "32",
|
397
|
+
"attribute": "size",
|
398
|
+
"reflects": true,
|
399
|
+
"inheritedFrom": {
|
400
|
+
"name": "Buttonsimple",
|
401
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
402
|
+
}
|
440
403
|
},
|
441
404
|
{
|
442
|
-
"
|
405
|
+
"kind": "field",
|
406
|
+
"name": "iconName",
|
443
407
|
"type": {
|
444
|
-
"text": "
|
408
|
+
"text": "IconNames | undefined"
|
445
409
|
},
|
446
|
-
"description": "
|
447
|
-
"
|
448
|
-
"
|
410
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
411
|
+
"attribute": "icon-name",
|
412
|
+
"inheritedFrom": {
|
413
|
+
"name": "AvatarComponentMixin",
|
414
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
415
|
+
}
|
449
416
|
},
|
450
417
|
{
|
418
|
+
"kind": "field",
|
451
419
|
"name": "counter",
|
452
420
|
"type": {
|
453
421
|
"text": "number | undefined"
|
454
422
|
},
|
455
|
-
"description": "
|
456
|
-
"
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
"text": "number"
|
462
|
-
},
|
463
|
-
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
464
|
-
"default": "99",
|
465
|
-
"fieldName": "maxCounter"
|
423
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
424
|
+
"attribute": "counter",
|
425
|
+
"inheritedFrom": {
|
426
|
+
"name": "AvatarComponentMixin",
|
427
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
428
|
+
}
|
466
429
|
},
|
467
430
|
{
|
468
|
-
"
|
431
|
+
"kind": "field",
|
432
|
+
"name": "isTyping",
|
469
433
|
"type": {
|
470
434
|
"text": "boolean"
|
471
435
|
},
|
472
436
|
"default": "false",
|
473
|
-
"description": "
|
474
|
-
"
|
437
|
+
"description": "Represents the typing indicator when the user is typing.",
|
438
|
+
"attribute": "is-typing",
|
439
|
+
"inheritedFrom": {
|
440
|
+
"name": "AvatarComponentMixin",
|
441
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
442
|
+
}
|
475
443
|
},
|
476
|
-
{
|
477
|
-
"name": "aria-label",
|
478
|
-
"type": {
|
479
|
-
"text": "string | null"
|
480
|
-
},
|
481
|
-
"default": "null",
|
482
|
-
"description": "Aria-label attribute to be set for accessibility",
|
483
|
-
"fieldName": "ariaLabel"
|
484
|
-
}
|
485
|
-
],
|
486
|
-
"superclass": {
|
487
|
-
"name": "Component",
|
488
|
-
"module": "/src/models"
|
489
|
-
},
|
490
|
-
"tagName": "mdc-badge",
|
491
|
-
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n */",
|
492
|
-
"customElement": true
|
493
|
-
}
|
494
|
-
],
|
495
|
-
"exports": [
|
496
|
-
{
|
497
|
-
"kind": "js",
|
498
|
-
"name": "default",
|
499
|
-
"declaration": {
|
500
|
-
"name": "Badge",
|
501
|
-
"module": "components/badge/badge.component.js"
|
502
|
-
}
|
503
|
-
}
|
504
|
-
]
|
505
|
-
},
|
506
|
-
{
|
507
|
-
"kind": "javascript-module",
|
508
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
509
|
-
"declarations": [
|
510
|
-
{
|
511
|
-
"kind": "class",
|
512
|
-
"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.",
|
513
|
-
"name": "AvatarButton",
|
514
|
-
"members": [
|
515
444
|
{
|
516
445
|
"kind": "field",
|
517
|
-
"name": "
|
446
|
+
"name": "tabIndex",
|
518
447
|
"type": {
|
519
|
-
"text": "
|
448
|
+
"text": "number"
|
520
449
|
},
|
521
|
-
"default": "
|
522
|
-
"description": "
|
523
|
-
"attribute": "
|
450
|
+
"default": "0",
|
451
|
+
"description": "This property specifies the tab order of the element.",
|
452
|
+
"attribute": "tabIndex",
|
453
|
+
"reflects": true,
|
454
|
+
"inheritedFrom": {
|
455
|
+
"name": "TabIndexMixin",
|
456
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
457
|
+
}
|
524
458
|
},
|
525
459
|
{
|
526
460
|
"kind": "method",
|
527
|
-
"name": "
|
461
|
+
"name": "executeAction",
|
462
|
+
"privacy": "private",
|
463
|
+
"inheritedFrom": {
|
464
|
+
"name": "Buttonsimple",
|
465
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
466
|
+
}
|
467
|
+
},
|
468
|
+
{
|
469
|
+
"kind": "method",
|
470
|
+
"name": "setAriaPressed",
|
528
471
|
"privacy": "private",
|
529
472
|
"parameters": [
|
530
473
|
{
|
531
|
-
"name": "
|
474
|
+
"name": "element",
|
532
475
|
"type": {
|
533
|
-
"text": "
|
534
|
-
}
|
476
|
+
"text": "HTMLElement"
|
477
|
+
},
|
478
|
+
"description": "The target element."
|
479
|
+
},
|
480
|
+
{
|
481
|
+
"name": "active",
|
482
|
+
"type": {
|
483
|
+
"text": "boolean"
|
484
|
+
},
|
485
|
+
"description": "The active state."
|
535
486
|
}
|
536
|
-
]
|
487
|
+
],
|
488
|
+
"description": "Sets the aria-pressed attribute based on the active state.",
|
489
|
+
"inheritedFrom": {
|
490
|
+
"name": "Buttonsimple",
|
491
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
492
|
+
}
|
537
493
|
},
|
538
494
|
{
|
539
|
-
"kind": "
|
540
|
-
"name": "
|
541
|
-
"
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
495
|
+
"kind": "method",
|
496
|
+
"name": "setSoftDisabled",
|
497
|
+
"privacy": "private",
|
498
|
+
"parameters": [
|
499
|
+
{
|
500
|
+
"name": "element",
|
501
|
+
"type": {
|
502
|
+
"text": "HTMLElement"
|
503
|
+
},
|
504
|
+
"description": "The button element."
|
505
|
+
},
|
506
|
+
{
|
507
|
+
"name": "softDisabled",
|
508
|
+
"type": {
|
509
|
+
"text": "boolean"
|
510
|
+
},
|
511
|
+
"description": "The soft-disabled state."
|
512
|
+
}
|
513
|
+
],
|
514
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
547
515
|
"inheritedFrom": {
|
548
516
|
"name": "Buttonsimple",
|
549
517
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
550
518
|
}
|
551
519
|
},
|
552
520
|
{
|
553
|
-
"kind": "
|
554
|
-
"name": "
|
555
|
-
"
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
521
|
+
"kind": "method",
|
522
|
+
"name": "setDisabled",
|
523
|
+
"privacy": "private",
|
524
|
+
"parameters": [
|
525
|
+
{
|
526
|
+
"name": "element",
|
527
|
+
"type": {
|
528
|
+
"text": "HTMLElement"
|
529
|
+
},
|
530
|
+
"description": "The button element."
|
531
|
+
},
|
532
|
+
{
|
533
|
+
"name": "disabled",
|
534
|
+
"type": {
|
535
|
+
"text": "boolean"
|
536
|
+
},
|
537
|
+
"description": "The disabled state."
|
538
|
+
}
|
539
|
+
],
|
540
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
562
541
|
"inheritedFrom": {
|
563
|
-
"name": "
|
564
|
-
"module": "
|
542
|
+
"name": "Buttonsimple",
|
543
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
565
544
|
}
|
566
545
|
},
|
567
546
|
{
|
568
|
-
"kind": "
|
569
|
-
"name": "
|
570
|
-
"
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
547
|
+
"kind": "method",
|
548
|
+
"name": "triggerClickEvent",
|
549
|
+
"privacy": "private",
|
550
|
+
"inheritedFrom": {
|
551
|
+
"name": "Buttonsimple",
|
552
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
553
|
+
}
|
554
|
+
},
|
555
|
+
{
|
556
|
+
"kind": "method",
|
557
|
+
"name": "handleKeyDown",
|
558
|
+
"privacy": "private",
|
559
|
+
"parameters": [
|
560
|
+
{
|
561
|
+
"name": "event",
|
562
|
+
"type": {
|
563
|
+
"text": "KeyboardEvent"
|
564
|
+
},
|
565
|
+
"description": "The keyboard event."
|
566
|
+
}
|
567
|
+
],
|
568
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
|
576
569
|
"inheritedFrom": {
|
577
570
|
"name": "Buttonsimple",
|
578
571
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
579
572
|
}
|
580
573
|
},
|
581
574
|
{
|
582
|
-
"kind": "
|
583
|
-
"name": "
|
584
|
-
"
|
585
|
-
"
|
586
|
-
|
587
|
-
|
588
|
-
|
589
|
-
|
590
|
-
|
575
|
+
"kind": "method",
|
576
|
+
"name": "handleKeyUp",
|
577
|
+
"privacy": "private",
|
578
|
+
"parameters": [
|
579
|
+
{
|
580
|
+
"name": "event",
|
581
|
+
"type": {
|
582
|
+
"text": "KeyboardEvent"
|
583
|
+
},
|
584
|
+
"description": "The keyboard event."
|
585
|
+
}
|
586
|
+
],
|
587
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
591
588
|
"inheritedFrom": {
|
592
589
|
"name": "Buttonsimple",
|
593
590
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
594
591
|
}
|
595
|
-
}
|
592
|
+
}
|
593
|
+
],
|
594
|
+
"attributes": [
|
596
595
|
{
|
597
|
-
"
|
598
|
-
"name": "type",
|
596
|
+
"name": "aria-label",
|
599
597
|
"type": {
|
600
|
-
"text": "
|
598
|
+
"text": "string | null"
|
601
599
|
},
|
602
|
-
"
|
603
|
-
"
|
604
|
-
"
|
605
|
-
"reflects": true,
|
606
|
-
"inheritedFrom": {
|
607
|
-
"name": "Buttonsimple",
|
608
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
609
|
-
}
|
600
|
+
"default": "null",
|
601
|
+
"description": "Aria-label attribute to be set for accessibility",
|
602
|
+
"fieldName": "ariaLabel"
|
610
603
|
},
|
611
604
|
{
|
612
|
-
"kind": "field",
|
613
605
|
"name": "src",
|
614
606
|
"type": {
|
615
607
|
"text": "string | undefined"
|
616
608
|
},
|
617
609
|
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
618
|
-
"
|
610
|
+
"fieldName": "src",
|
619
611
|
"inheritedFrom": {
|
620
612
|
"name": "AvatarComponentMixin",
|
621
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
613
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
622
614
|
}
|
623
615
|
},
|
624
616
|
{
|
625
|
-
"kind": "field",
|
626
617
|
"name": "initials",
|
627
618
|
"type": {
|
628
619
|
"text": "string | undefined"
|
629
620
|
},
|
630
621
|
"description": "The initials to be displayed for the avatar.",
|
631
|
-
"
|
622
|
+
"fieldName": "initials",
|
632
623
|
"inheritedFrom": {
|
633
624
|
"name": "AvatarComponentMixin",
|
634
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
625
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
635
626
|
}
|
636
627
|
},
|
637
628
|
{
|
638
|
-
"kind": "field",
|
639
629
|
"name": "presence",
|
640
630
|
"type": {
|
641
631
|
"text": "PresenceType | undefined"
|
642
632
|
},
|
643
633
|
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
644
|
-
"
|
634
|
+
"fieldName": "presence",
|
645
635
|
"inheritedFrom": {
|
646
636
|
"name": "AvatarComponentMixin",
|
647
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
637
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
648
638
|
}
|
649
639
|
},
|
650
640
|
{
|
651
|
-
"kind": "field",
|
652
641
|
"name": "size",
|
653
642
|
"type": {
|
654
643
|
"text": "ButtonSize"
|
655
644
|
},
|
656
645
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
657
646
|
"default": "32",
|
658
|
-
"
|
659
|
-
"reflects": true,
|
647
|
+
"fieldName": "size",
|
660
648
|
"inheritedFrom": {
|
661
649
|
"name": "Buttonsimple",
|
662
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
650
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
663
651
|
}
|
664
652
|
},
|
665
653
|
{
|
666
|
-
"
|
667
|
-
"name": "iconName",
|
654
|
+
"name": "icon-name",
|
668
655
|
"type": {
|
669
656
|
"text": "IconNames | undefined"
|
670
657
|
},
|
671
658
|
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
672
|
-
"
|
659
|
+
"fieldName": "iconName",
|
673
660
|
"inheritedFrom": {
|
674
661
|
"name": "AvatarComponentMixin",
|
675
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
662
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
676
663
|
}
|
677
664
|
},
|
678
665
|
{
|
679
|
-
"kind": "field",
|
680
666
|
"name": "counter",
|
681
667
|
"type": {
|
682
668
|
"text": "number | undefined"
|
683
669
|
},
|
684
670
|
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
685
|
-
"
|
671
|
+
"fieldName": "counter",
|
686
672
|
"inheritedFrom": {
|
687
673
|
"name": "AvatarComponentMixin",
|
688
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
674
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
689
675
|
}
|
690
676
|
},
|
691
677
|
{
|
692
|
-
"
|
693
|
-
"name": "isTyping",
|
678
|
+
"name": "is-typing",
|
694
679
|
"type": {
|
695
680
|
"text": "boolean"
|
696
681
|
},
|
697
682
|
"default": "false",
|
698
683
|
"description": "Represents the typing indicator when the user is typing.",
|
699
|
-
"
|
684
|
+
"fieldName": "isTyping",
|
700
685
|
"inheritedFrom": {
|
701
686
|
"name": "AvatarComponentMixin",
|
702
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
687
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
688
|
+
}
|
689
|
+
},
|
690
|
+
{
|
691
|
+
"name": "tabIndex",
|
692
|
+
"type": {
|
693
|
+
"text": "number"
|
694
|
+
},
|
695
|
+
"default": "0",
|
696
|
+
"description": "This property specifies the tab order of the element.",
|
697
|
+
"fieldName": "tabIndex",
|
698
|
+
"inheritedFrom": {
|
699
|
+
"name": "TabIndexMixin",
|
700
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
701
|
+
}
|
702
|
+
},
|
703
|
+
{
|
704
|
+
"name": "disabled",
|
705
|
+
"type": {
|
706
|
+
"text": "boolean"
|
707
|
+
},
|
708
|
+
"default": "false",
|
709
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
710
|
+
"fieldName": "disabled",
|
711
|
+
"inheritedFrom": {
|
712
|
+
"name": "DisabledMixin",
|
713
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
714
|
+
}
|
715
|
+
},
|
716
|
+
{
|
717
|
+
"name": "active",
|
718
|
+
"type": {
|
719
|
+
"text": "boolean"
|
720
|
+
},
|
721
|
+
"default": "false",
|
722
|
+
"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.",
|
723
|
+
"fieldName": "active",
|
724
|
+
"inheritedFrom": {
|
725
|
+
"name": "Buttonsimple",
|
726
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
727
|
+
}
|
728
|
+
},
|
729
|
+
{
|
730
|
+
"name": "soft-disabled",
|
731
|
+
"type": {
|
732
|
+
"text": "boolean"
|
733
|
+
},
|
734
|
+
"default": "false",
|
735
|
+
"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.",
|
736
|
+
"fieldName": "softDisabled",
|
737
|
+
"inheritedFrom": {
|
738
|
+
"name": "Buttonsimple",
|
739
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
740
|
+
}
|
741
|
+
},
|
742
|
+
{
|
743
|
+
"name": "role",
|
744
|
+
"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.",
|
745
|
+
"default": "button",
|
746
|
+
"fieldName": "role",
|
747
|
+
"inheritedFrom": {
|
748
|
+
"name": "Buttonsimple",
|
749
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
750
|
+
}
|
751
|
+
},
|
752
|
+
{
|
753
|
+
"name": "type",
|
754
|
+
"type": {
|
755
|
+
"text": "ButtonType"
|
756
|
+
},
|
757
|
+
"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.",
|
758
|
+
"default": "button",
|
759
|
+
"fieldName": "type",
|
760
|
+
"inheritedFrom": {
|
761
|
+
"name": "Buttonsimple",
|
762
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
703
763
|
}
|
764
|
+
}
|
765
|
+
],
|
766
|
+
"mixins": [
|
767
|
+
{
|
768
|
+
"name": "AvatarComponentMixin",
|
769
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
770
|
+
}
|
771
|
+
],
|
772
|
+
"superclass": {
|
773
|
+
"name": "Buttonsimple",
|
774
|
+
"module": "/src/components/buttonsimple"
|
775
|
+
},
|
776
|
+
"tagName": "mdc-avatarbutton",
|
777
|
+
"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 * @dependency mdc-avatar\n *\n * @tagname mdc-avatarbutton\n */",
|
778
|
+
"customElement": true
|
779
|
+
}
|
780
|
+
],
|
781
|
+
"exports": [
|
782
|
+
{
|
783
|
+
"kind": "js",
|
784
|
+
"name": "default",
|
785
|
+
"declaration": {
|
786
|
+
"name": "AvatarButton",
|
787
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
788
|
+
}
|
789
|
+
}
|
790
|
+
]
|
791
|
+
},
|
792
|
+
{
|
793
|
+
"kind": "javascript-module",
|
794
|
+
"path": "components/badge/badge.component.js",
|
795
|
+
"declarations": [
|
796
|
+
{
|
797
|
+
"kind": "class",
|
798
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
799
|
+
"name": "Badge",
|
800
|
+
"members": [
|
801
|
+
{
|
802
|
+
"kind": "field",
|
803
|
+
"name": "type",
|
804
|
+
"type": {
|
805
|
+
"text": "BadgeType | undefined"
|
806
|
+
},
|
807
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
808
|
+
"attribute": "type",
|
809
|
+
"reflects": true
|
810
|
+
},
|
811
|
+
{
|
812
|
+
"kind": "field",
|
813
|
+
"name": "iconName",
|
814
|
+
"type": {
|
815
|
+
"text": "IconNames | undefined"
|
816
|
+
},
|
817
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
818
|
+
"attribute": "icon-name"
|
819
|
+
},
|
820
|
+
{
|
821
|
+
"kind": "field",
|
822
|
+
"name": "variant",
|
823
|
+
"type": {
|
824
|
+
"text": "IconVariant"
|
825
|
+
},
|
826
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
827
|
+
"default": "primary",
|
828
|
+
"attribute": "variant",
|
829
|
+
"reflects": true
|
830
|
+
},
|
831
|
+
{
|
832
|
+
"kind": "field",
|
833
|
+
"name": "counter",
|
834
|
+
"type": {
|
835
|
+
"text": "number | undefined"
|
836
|
+
},
|
837
|
+
"description": "Counter is the number which can be provided in the badge.",
|
838
|
+
"attribute": "counter"
|
839
|
+
},
|
840
|
+
{
|
841
|
+
"kind": "field",
|
842
|
+
"name": "maxCounter",
|
843
|
+
"type": {
|
844
|
+
"text": "number"
|
845
|
+
},
|
846
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
847
|
+
"default": "99",
|
848
|
+
"attribute": "max-counter",
|
849
|
+
"reflects": true
|
850
|
+
},
|
851
|
+
{
|
852
|
+
"kind": "field",
|
853
|
+
"name": "overlay",
|
854
|
+
"type": {
|
855
|
+
"text": "boolean"
|
856
|
+
},
|
857
|
+
"default": "false",
|
858
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
859
|
+
"attribute": "overlay"
|
704
860
|
},
|
705
861
|
{
|
706
862
|
"kind": "field",
|
707
|
-
"name": "
|
863
|
+
"name": "ariaLabel",
|
708
864
|
"type": {
|
709
|
-
"text": "
|
865
|
+
"text": "string | null"
|
710
866
|
},
|
711
|
-
"default": "
|
712
|
-
"description": "
|
713
|
-
"attribute": "
|
714
|
-
"reflects": true,
|
715
|
-
"inheritedFrom": {
|
716
|
-
"name": "TabIndexMixin",
|
717
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
718
|
-
}
|
719
|
-
},
|
720
|
-
{
|
721
|
-
"kind": "method",
|
722
|
-
"name": "executeAction",
|
723
|
-
"privacy": "private",
|
724
|
-
"inheritedFrom": {
|
725
|
-
"name": "Buttonsimple",
|
726
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
727
|
-
}
|
867
|
+
"default": "null",
|
868
|
+
"description": "Aria-label attribute to be set for accessibility",
|
869
|
+
"attribute": "aria-label"
|
728
870
|
},
|
729
871
|
{
|
730
872
|
"kind": "method",
|
731
|
-
"name": "
|
873
|
+
"name": "getCounterText",
|
732
874
|
"privacy": "private",
|
875
|
+
"return": {
|
876
|
+
"type": {
|
877
|
+
"text": ""
|
878
|
+
}
|
879
|
+
},
|
733
880
|
"parameters": [
|
734
881
|
{
|
735
|
-
"name": "
|
882
|
+
"name": "maxCounter",
|
736
883
|
"type": {
|
737
|
-
"text": "
|
884
|
+
"text": "number"
|
738
885
|
},
|
739
|
-
"description": "
|
886
|
+
"description": "the maximum limit which can be displayed on the badge"
|
740
887
|
},
|
741
888
|
{
|
742
|
-
"name": "
|
889
|
+
"name": "counter",
|
890
|
+
"optional": true,
|
743
891
|
"type": {
|
744
|
-
"text": "
|
892
|
+
"text": "number"
|
745
893
|
},
|
746
|
-
"description": "
|
894
|
+
"description": "the number to be displayed on the badge"
|
747
895
|
}
|
748
896
|
],
|
749
|
-
"description": "
|
750
|
-
"inheritedFrom": {
|
751
|
-
"name": "Buttonsimple",
|
752
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
753
|
-
}
|
897
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
754
898
|
},
|
755
899
|
{
|
756
900
|
"kind": "method",
|
757
|
-
"name": "
|
901
|
+
"name": "getBadgeIcon",
|
758
902
|
"privacy": "private",
|
903
|
+
"return": {
|
904
|
+
"type": {
|
905
|
+
"text": ""
|
906
|
+
}
|
907
|
+
},
|
759
908
|
"parameters": [
|
760
909
|
{
|
761
|
-
"name": "
|
910
|
+
"name": "iconName",
|
762
911
|
"type": {
|
763
|
-
"text": "
|
912
|
+
"text": "string"
|
764
913
|
},
|
765
|
-
"description": "
|
914
|
+
"description": "the name of the icon from the icon set"
|
766
915
|
},
|
767
916
|
{
|
768
|
-
"name": "
|
917
|
+
"name": "backgroundClassPostfix",
|
769
918
|
"type": {
|
770
|
-
"text": "
|
919
|
+
"text": "string"
|
771
920
|
},
|
772
|
-
"description": "
|
921
|
+
"description": "postfix for the class to style the badge icon."
|
773
922
|
}
|
774
923
|
],
|
775
|
-
"description": "
|
776
|
-
"inheritedFrom": {
|
777
|
-
"name": "Buttonsimple",
|
778
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
779
|
-
}
|
924
|
+
"description": "Method to generate the badge icon."
|
780
925
|
},
|
781
926
|
{
|
782
927
|
"kind": "method",
|
783
|
-
"name": "
|
928
|
+
"name": "getBadgeDot",
|
784
929
|
"privacy": "private",
|
785
|
-
"
|
786
|
-
{
|
787
|
-
"
|
788
|
-
"type": {
|
789
|
-
"text": "HTMLElement"
|
790
|
-
},
|
791
|
-
"description": "The button element."
|
792
|
-
},
|
793
|
-
{
|
794
|
-
"name": "disabled",
|
795
|
-
"type": {
|
796
|
-
"text": "boolean"
|
797
|
-
},
|
798
|
-
"description": "The disabled state."
|
930
|
+
"return": {
|
931
|
+
"type": {
|
932
|
+
"text": ""
|
799
933
|
}
|
800
|
-
|
801
|
-
"description": "
|
802
|
-
"inheritedFrom": {
|
803
|
-
"name": "Buttonsimple",
|
804
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
805
|
-
}
|
934
|
+
},
|
935
|
+
"description": "Method to generate the badge dot template."
|
806
936
|
},
|
807
937
|
{
|
808
938
|
"kind": "method",
|
809
|
-
"name": "
|
939
|
+
"name": "getBadgeCounterText",
|
810
940
|
"privacy": "private",
|
811
|
-
"
|
812
|
-
"
|
813
|
-
|
814
|
-
|
941
|
+
"return": {
|
942
|
+
"type": {
|
943
|
+
"text": ""
|
944
|
+
}
|
945
|
+
},
|
946
|
+
"description": "Method to generate the badge text and counter template."
|
815
947
|
},
|
816
948
|
{
|
817
949
|
"kind": "method",
|
818
|
-
"name": "
|
950
|
+
"name": "setRoleByAriaLabel",
|
819
951
|
"privacy": "private",
|
820
|
-
"
|
821
|
-
{
|
822
|
-
"
|
823
|
-
"type": {
|
824
|
-
"text": "KeyboardEvent"
|
825
|
-
},
|
826
|
-
"description": "The keyboard event."
|
952
|
+
"return": {
|
953
|
+
"type": {
|
954
|
+
"text": "void"
|
827
955
|
}
|
828
|
-
|
829
|
-
"description": "
|
830
|
-
"inheritedFrom": {
|
831
|
-
"name": "Buttonsimple",
|
832
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
833
|
-
}
|
956
|
+
},
|
957
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
834
958
|
},
|
835
959
|
{
|
836
960
|
"kind": "method",
|
837
|
-
"name": "
|
961
|
+
"name": "getBadgeContentBasedOnType",
|
838
962
|
"privacy": "private",
|
839
|
-
"
|
840
|
-
{
|
841
|
-
"
|
842
|
-
"type": {
|
843
|
-
"text": "KeyboardEvent"
|
844
|
-
},
|
845
|
-
"description": "The keyboard event."
|
963
|
+
"return": {
|
964
|
+
"type": {
|
965
|
+
"text": ""
|
846
966
|
}
|
847
|
-
|
848
|
-
"description": "
|
849
|
-
"inheritedFrom": {
|
850
|
-
"name": "Buttonsimple",
|
851
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
852
|
-
}
|
967
|
+
},
|
968
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
853
969
|
}
|
854
970
|
],
|
855
971
|
"attributes": [
|
856
972
|
{
|
857
|
-
"name": "
|
858
|
-
"type": {
|
859
|
-
"text": "string | null"
|
860
|
-
},
|
861
|
-
"default": "null",
|
862
|
-
"description": "Aria-label attribute to be set for accessibility",
|
863
|
-
"fieldName": "ariaLabel"
|
864
|
-
},
|
865
|
-
{
|
866
|
-
"name": "src",
|
867
|
-
"type": {
|
868
|
-
"text": "string | undefined"
|
869
|
-
},
|
870
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
871
|
-
"fieldName": "src",
|
872
|
-
"inheritedFrom": {
|
873
|
-
"name": "AvatarComponentMixin",
|
874
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
875
|
-
}
|
876
|
-
},
|
877
|
-
{
|
878
|
-
"name": "initials",
|
879
|
-
"type": {
|
880
|
-
"text": "string | undefined"
|
881
|
-
},
|
882
|
-
"description": "The initials to be displayed for the avatar.",
|
883
|
-
"fieldName": "initials",
|
884
|
-
"inheritedFrom": {
|
885
|
-
"name": "AvatarComponentMixin",
|
886
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
887
|
-
}
|
888
|
-
},
|
889
|
-
{
|
890
|
-
"name": "presence",
|
891
|
-
"type": {
|
892
|
-
"text": "PresenceType | undefined"
|
893
|
-
},
|
894
|
-
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
895
|
-
"fieldName": "presence",
|
896
|
-
"inheritedFrom": {
|
897
|
-
"name": "AvatarComponentMixin",
|
898
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
899
|
-
}
|
900
|
-
},
|
901
|
-
{
|
902
|
-
"name": "size",
|
973
|
+
"name": "type",
|
903
974
|
"type": {
|
904
|
-
"text": "
|
975
|
+
"text": "BadgeType | undefined"
|
905
976
|
},
|
906
|
-
"description": "
|
907
|
-
"
|
908
|
-
"fieldName": "size",
|
909
|
-
"inheritedFrom": {
|
910
|
-
"name": "Buttonsimple",
|
911
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
912
|
-
}
|
977
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
978
|
+
"fieldName": "type"
|
913
979
|
},
|
914
980
|
{
|
915
981
|
"name": "icon-name",
|
916
982
|
"type": {
|
917
983
|
"text": "IconNames | undefined"
|
918
984
|
},
|
919
|
-
"description": "Name of the icon
|
920
|
-
"fieldName": "iconName"
|
921
|
-
"inheritedFrom": {
|
922
|
-
"name": "AvatarComponentMixin",
|
923
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
924
|
-
}
|
925
|
-
},
|
926
|
-
{
|
927
|
-
"name": "counter",
|
928
|
-
"type": {
|
929
|
-
"text": "number | undefined"
|
930
|
-
},
|
931
|
-
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
932
|
-
"fieldName": "counter",
|
933
|
-
"inheritedFrom": {
|
934
|
-
"name": "AvatarComponentMixin",
|
935
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
936
|
-
}
|
937
|
-
},
|
938
|
-
{
|
939
|
-
"name": "is-typing",
|
940
|
-
"type": {
|
941
|
-
"text": "boolean"
|
942
|
-
},
|
943
|
-
"default": "false",
|
944
|
-
"description": "Represents the typing indicator when the user is typing.",
|
945
|
-
"fieldName": "isTyping",
|
946
|
-
"inheritedFrom": {
|
947
|
-
"name": "AvatarComponentMixin",
|
948
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
949
|
-
}
|
985
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
986
|
+
"fieldName": "iconName"
|
950
987
|
},
|
951
988
|
{
|
952
|
-
"name": "
|
989
|
+
"name": "variant",
|
953
990
|
"type": {
|
954
|
-
"text": "
|
991
|
+
"text": "IconVariant"
|
955
992
|
},
|
956
|
-
"
|
957
|
-
"
|
958
|
-
"fieldName": "
|
959
|
-
"inheritedFrom": {
|
960
|
-
"name": "TabIndexMixin",
|
961
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
962
|
-
}
|
993
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
994
|
+
"default": "primary",
|
995
|
+
"fieldName": "variant"
|
963
996
|
},
|
964
997
|
{
|
965
|
-
"name": "
|
998
|
+
"name": "counter",
|
966
999
|
"type": {
|
967
|
-
"text": "
|
1000
|
+
"text": "number | undefined"
|
968
1001
|
},
|
969
|
-
"
|
970
|
-
"
|
971
|
-
"fieldName": "disabled",
|
972
|
-
"inheritedFrom": {
|
973
|
-
"name": "DisabledMixin",
|
974
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
975
|
-
}
|
1002
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1003
|
+
"fieldName": "counter"
|
976
1004
|
},
|
977
1005
|
{
|
978
|
-
"name": "
|
1006
|
+
"name": "max-counter",
|
979
1007
|
"type": {
|
980
|
-
"text": "
|
1008
|
+
"text": "number"
|
981
1009
|
},
|
982
|
-
"
|
983
|
-
"
|
984
|
-
"fieldName": "
|
985
|
-
"inheritedFrom": {
|
986
|
-
"name": "Buttonsimple",
|
987
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
988
|
-
}
|
1010
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1011
|
+
"default": "99",
|
1012
|
+
"fieldName": "maxCounter"
|
989
1013
|
},
|
990
1014
|
{
|
991
|
-
"name": "
|
1015
|
+
"name": "overlay",
|
992
1016
|
"type": {
|
993
1017
|
"text": "boolean"
|
994
1018
|
},
|
995
1019
|
"default": "false",
|
996
|
-
"description": "
|
997
|
-
"fieldName": "
|
998
|
-
"inheritedFrom": {
|
999
|
-
"name": "Buttonsimple",
|
1000
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1001
|
-
}
|
1002
|
-
},
|
1003
|
-
{
|
1004
|
-
"name": "role",
|
1005
|
-
"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.",
|
1006
|
-
"default": "button",
|
1007
|
-
"fieldName": "role",
|
1008
|
-
"inheritedFrom": {
|
1009
|
-
"name": "Buttonsimple",
|
1010
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1011
|
-
}
|
1020
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1021
|
+
"fieldName": "overlay"
|
1012
1022
|
},
|
1013
1023
|
{
|
1014
|
-
"name": "
|
1024
|
+
"name": "aria-label",
|
1015
1025
|
"type": {
|
1016
|
-
"text": "
|
1026
|
+
"text": "string | null"
|
1017
1027
|
},
|
1018
|
-
"
|
1019
|
-
"
|
1020
|
-
"fieldName": "
|
1021
|
-
"inheritedFrom": {
|
1022
|
-
"name": "Buttonsimple",
|
1023
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1024
|
-
}
|
1025
|
-
}
|
1026
|
-
],
|
1027
|
-
"mixins": [
|
1028
|
-
{
|
1029
|
-
"name": "AvatarComponentMixin",
|
1030
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1028
|
+
"default": "null",
|
1029
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1030
|
+
"fieldName": "ariaLabel"
|
1031
1031
|
}
|
1032
1032
|
],
|
1033
1033
|
"superclass": {
|
1034
|
-
"name": "
|
1035
|
-
"module": "/src/
|
1034
|
+
"name": "Component",
|
1035
|
+
"module": "/src/models"
|
1036
1036
|
},
|
1037
|
-
"tagName": "mdc-
|
1038
|
-
"jsDoc": "/**\n * The `mdc-
|
1037
|
+
"tagName": "mdc-badge",
|
1038
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n */",
|
1039
1039
|
"customElement": true
|
1040
1040
|
}
|
1041
1041
|
],
|
@@ -1044,8 +1044,8 @@
|
|
1044
1044
|
"kind": "js",
|
1045
1045
|
"name": "default",
|
1046
1046
|
"declaration": {
|
1047
|
-
"name": "
|
1048
|
-
"module": "components/
|
1047
|
+
"name": "Badge",
|
1048
|
+
"module": "components/badge/badge.component.js"
|
1049
1049
|
}
|
1050
1050
|
}
|
1051
1051
|
]
|
@@ -2064,87 +2064,267 @@
|
|
2064
2064
|
"description": "The arrowDirection to set.",
|
2065
2065
|
"name": "arrowDirection"
|
2066
2066
|
}
|
2067
|
-
]
|
2067
|
+
]
|
2068
|
+
},
|
2069
|
+
{
|
2070
|
+
"kind": "method",
|
2071
|
+
"name": "setGrabberButton",
|
2072
|
+
"privacy": "private",
|
2073
|
+
"return": {
|
2074
|
+
"type": {
|
2075
|
+
"text": "void"
|
2076
|
+
}
|
2077
|
+
},
|
2078
|
+
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
2079
|
+
},
|
2080
|
+
{
|
2081
|
+
"kind": "method",
|
2082
|
+
"name": "getArrowIcon",
|
2083
|
+
"privacy": "private",
|
2084
|
+
"return": {
|
2085
|
+
"type": {
|
2086
|
+
"text": ""
|
2087
|
+
}
|
2088
|
+
},
|
2089
|
+
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
2090
|
+
},
|
2091
|
+
{
|
2092
|
+
"kind": "method",
|
2093
|
+
"name": "inferDividerType",
|
2094
|
+
"privacy": "private",
|
2095
|
+
"description": "Infers the type of divider based on the kind of slot present.",
|
2096
|
+
"parameters": [
|
2097
|
+
{
|
2098
|
+
"description": "default slot of divider",
|
2099
|
+
"name": "slot"
|
2100
|
+
}
|
2101
|
+
]
|
2102
|
+
}
|
2103
|
+
],
|
2104
|
+
"attributes": [
|
2105
|
+
{
|
2106
|
+
"name": "orientation",
|
2107
|
+
"type": {
|
2108
|
+
"text": "DividerOrientation"
|
2109
|
+
},
|
2110
|
+
"description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
|
2111
|
+
"default": "horizontal",
|
2112
|
+
"fieldName": "orientation"
|
2113
|
+
},
|
2114
|
+
{
|
2115
|
+
"name": "variant",
|
2116
|
+
"type": {
|
2117
|
+
"text": "DividerVariant"
|
2118
|
+
},
|
2119
|
+
"description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
|
2120
|
+
"default": "solid",
|
2121
|
+
"fieldName": "variant"
|
2122
|
+
},
|
2123
|
+
{
|
2124
|
+
"name": "arrow-direction",
|
2125
|
+
"type": {
|
2126
|
+
"text": "Directions"
|
2127
|
+
},
|
2128
|
+
"description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
2129
|
+
"default": "'negative'",
|
2130
|
+
"fieldName": "arrowDirection"
|
2131
|
+
},
|
2132
|
+
{
|
2133
|
+
"name": "button-position",
|
2134
|
+
"type": {
|
2135
|
+
"text": "Directions"
|
2136
|
+
},
|
2137
|
+
"description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
|
2138
|
+
"default": "'negative'",
|
2139
|
+
"fieldName": "buttonPosition"
|
2140
|
+
}
|
2141
|
+
],
|
2142
|
+
"superclass": {
|
2143
|
+
"name": "Component",
|
2144
|
+
"module": "/src/models"
|
2145
|
+
},
|
2146
|
+
"tagName": "mdc-divider",
|
2147
|
+
"jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
|
2148
|
+
"customElement": true
|
2149
|
+
}
|
2150
|
+
],
|
2151
|
+
"exports": [
|
2152
|
+
{
|
2153
|
+
"kind": "js",
|
2154
|
+
"name": "default",
|
2155
|
+
"declaration": {
|
2156
|
+
"name": "Divider",
|
2157
|
+
"module": "components/divider/divider.component.js"
|
2158
|
+
}
|
2159
|
+
}
|
2160
|
+
]
|
2161
|
+
},
|
2162
|
+
{
|
2163
|
+
"kind": "javascript-module",
|
2164
|
+
"path": "components/formfieldwrapper/formfieldwrapper.component.js",
|
2165
|
+
"declarations": [
|
2166
|
+
{
|
2167
|
+
"kind": "class",
|
2168
|
+
"description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
|
2169
|
+
"name": "FormfieldWrapper",
|
2170
|
+
"members": [
|
2171
|
+
{
|
2172
|
+
"kind": "field",
|
2173
|
+
"name": "label",
|
2174
|
+
"type": {
|
2175
|
+
"text": "string | undefined"
|
2176
|
+
},
|
2177
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2178
|
+
"attribute": "label",
|
2179
|
+
"reflects": true
|
2180
|
+
},
|
2181
|
+
{
|
2182
|
+
"kind": "field",
|
2183
|
+
"name": "id",
|
2184
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2185
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2186
|
+
"attribute": "id"
|
2187
|
+
},
|
2188
|
+
{
|
2189
|
+
"kind": "field",
|
2190
|
+
"name": "helpTextType",
|
2191
|
+
"type": {
|
2192
|
+
"text": "ValidationType"
|
2193
|
+
},
|
2194
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2195
|
+
"attribute": "help-text-type",
|
2196
|
+
"reflects": true
|
2197
|
+
},
|
2198
|
+
{
|
2199
|
+
"kind": "field",
|
2200
|
+
"name": "helpText",
|
2201
|
+
"type": {
|
2202
|
+
"text": "string | undefined"
|
2203
|
+
},
|
2204
|
+
"description": "The help text that is displayed below the input field.",
|
2205
|
+
"attribute": "help-text",
|
2206
|
+
"reflects": true
|
2207
|
+
},
|
2208
|
+
{
|
2209
|
+
"kind": "field",
|
2210
|
+
"name": "labelInfoText",
|
2211
|
+
"type": {
|
2212
|
+
"text": "string | undefined"
|
2213
|
+
},
|
2214
|
+
"attribute": "label-info-text"
|
2215
|
+
},
|
2216
|
+
{
|
2217
|
+
"kind": "method",
|
2218
|
+
"name": "renderLabelElement",
|
2219
|
+
"privacy": "protected",
|
2220
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2221
|
+
"return": {
|
2222
|
+
"type": {
|
2223
|
+
"text": ""
|
2224
|
+
}
|
2225
|
+
}
|
2226
|
+
},
|
2227
|
+
{
|
2228
|
+
"kind": "method",
|
2229
|
+
"name": "renderLabelInfoToggleTip",
|
2230
|
+
"privacy": "protected",
|
2231
|
+
"description": "displays a info icon, which when hovered over, displays the labelInfoText.\nThis is in beta and is subject to change once the toggletip component is ready.",
|
2232
|
+
"return": {
|
2233
|
+
"type": {
|
2234
|
+
"text": ""
|
2235
|
+
}
|
2236
|
+
}
|
2237
|
+
},
|
2238
|
+
{
|
2239
|
+
"kind": "method",
|
2240
|
+
"name": "renderHelpTextIcon",
|
2241
|
+
"privacy": "protected",
|
2242
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
2243
|
+
"return": {
|
2244
|
+
"type": {
|
2245
|
+
"text": ""
|
2246
|
+
}
|
2247
|
+
}
|
2068
2248
|
},
|
2069
2249
|
{
|
2070
2250
|
"kind": "method",
|
2071
|
-
"name": "
|
2072
|
-
"privacy": "
|
2251
|
+
"name": "renderHelpText",
|
2252
|
+
"privacy": "protected",
|
2253
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
2073
2254
|
"return": {
|
2074
2255
|
"type": {
|
2075
|
-
"text": "
|
2256
|
+
"text": ""
|
2076
2257
|
}
|
2077
|
-
}
|
2078
|
-
"description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
|
2258
|
+
}
|
2079
2259
|
},
|
2080
2260
|
{
|
2081
2261
|
"kind": "method",
|
2082
|
-
"name": "
|
2083
|
-
"privacy": "
|
2262
|
+
"name": "renderLabel",
|
2263
|
+
"privacy": "protected",
|
2264
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2084
2265
|
"return": {
|
2085
2266
|
"type": {
|
2086
2267
|
"text": ""
|
2087
2268
|
}
|
2088
|
-
}
|
2089
|
-
"description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
|
2269
|
+
}
|
2090
2270
|
},
|
2091
2271
|
{
|
2092
2272
|
"kind": "method",
|
2093
|
-
"name": "
|
2094
|
-
"privacy": "
|
2095
|
-
"description": "
|
2096
|
-
"
|
2097
|
-
{
|
2098
|
-
"
|
2099
|
-
"name": "slot"
|
2273
|
+
"name": "renderHelperText",
|
2274
|
+
"privacy": "protected",
|
2275
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2276
|
+
"return": {
|
2277
|
+
"type": {
|
2278
|
+
"text": ""
|
2100
2279
|
}
|
2101
|
-
|
2280
|
+
}
|
2102
2281
|
}
|
2103
2282
|
],
|
2104
2283
|
"attributes": [
|
2105
2284
|
{
|
2106
|
-
"name": "
|
2285
|
+
"name": "label",
|
2107
2286
|
"type": {
|
2108
|
-
"text": "
|
2287
|
+
"text": "string | undefined"
|
2109
2288
|
},
|
2110
|
-
"description": "
|
2111
|
-
"
|
2112
|
-
"fieldName": "orientation"
|
2289
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2290
|
+
"fieldName": "label"
|
2113
2291
|
},
|
2114
2292
|
{
|
2115
|
-
"name": "
|
2293
|
+
"name": "id",
|
2294
|
+
"default": "`mdc-input-${uuidv4()}`",
|
2295
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2296
|
+
"fieldName": "id"
|
2297
|
+
},
|
2298
|
+
{
|
2299
|
+
"name": "help-text-type",
|
2116
2300
|
"type": {
|
2117
|
-
"text": "
|
2301
|
+
"text": "ValidationType"
|
2118
2302
|
},
|
2119
|
-
"description": "
|
2120
|
-
"
|
2121
|
-
"fieldName": "variant"
|
2303
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2304
|
+
"fieldName": "helpTextType"
|
2122
2305
|
},
|
2123
2306
|
{
|
2124
|
-
"name": "
|
2307
|
+
"name": "help-text",
|
2125
2308
|
"type": {
|
2126
|
-
"text": "
|
2309
|
+
"text": "string | undefined"
|
2127
2310
|
},
|
2128
|
-
"description": "
|
2129
|
-
"
|
2130
|
-
"fieldName": "arrowDirection"
|
2311
|
+
"description": "The help text that is displayed below the input field.",
|
2312
|
+
"fieldName": "helpText"
|
2131
2313
|
},
|
2132
2314
|
{
|
2133
|
-
"name": "
|
2315
|
+
"name": "label-info-text",
|
2134
2316
|
"type": {
|
2135
|
-
"text": "
|
2317
|
+
"text": "string | undefined"
|
2136
2318
|
},
|
2137
|
-
"
|
2138
|
-
"default": "'negative'",
|
2139
|
-
"fieldName": "buttonPosition"
|
2319
|
+
"fieldName": "labelInfoText"
|
2140
2320
|
}
|
2141
2321
|
],
|
2142
2322
|
"superclass": {
|
2143
2323
|
"name": "Component",
|
2144
2324
|
"module": "/src/models"
|
2145
2325
|
},
|
2146
|
-
"tagName": "mdc-
|
2147
|
-
"jsDoc": "/**\n *
|
2326
|
+
"tagName": "mdc-formfieldwrapper",
|
2327
|
+
"jsDoc": "/**\n * formfieldwrapper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-formfieldwrapper\n *\n */",
|
2148
2328
|
"customElement": true
|
2149
2329
|
}
|
2150
2330
|
],
|
@@ -2153,8 +2333,8 @@
|
|
2153
2333
|
"kind": "js",
|
2154
2334
|
"name": "default",
|
2155
2335
|
"declaration": {
|
2156
|
-
"name": "
|
2157
|
-
"module": "components/
|
2336
|
+
"name": "FormfieldWrapper",
|
2337
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
2158
2338
|
}
|
2159
2339
|
}
|
2160
2340
|
]
|
@@ -2518,186 +2698,6 @@
|
|
2518
2698
|
}
|
2519
2699
|
]
|
2520
2700
|
},
|
2521
|
-
{
|
2522
|
-
"kind": "javascript-module",
|
2523
|
-
"path": "components/labelandhelper/labelandhelper.component.js",
|
2524
|
-
"declarations": [
|
2525
|
-
{
|
2526
|
-
"kind": "class",
|
2527
|
-
"description": "labelandhelper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
|
2528
|
-
"name": "LabelAndHelper",
|
2529
|
-
"members": [
|
2530
|
-
{
|
2531
|
-
"kind": "field",
|
2532
|
-
"name": "label",
|
2533
|
-
"type": {
|
2534
|
-
"text": "string | undefined"
|
2535
|
-
},
|
2536
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2537
|
-
"attribute": "label",
|
2538
|
-
"reflects": true
|
2539
|
-
},
|
2540
|
-
{
|
2541
|
-
"kind": "field",
|
2542
|
-
"name": "id",
|
2543
|
-
"default": "`mdc-input-${uuidv4()}`",
|
2544
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2545
|
-
"attribute": "id"
|
2546
|
-
},
|
2547
|
-
{
|
2548
|
-
"kind": "field",
|
2549
|
-
"name": "helpTextType",
|
2550
|
-
"type": {
|
2551
|
-
"text": "ValidationType"
|
2552
|
-
},
|
2553
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2554
|
-
"attribute": "help-text-type",
|
2555
|
-
"reflects": true
|
2556
|
-
},
|
2557
|
-
{
|
2558
|
-
"kind": "field",
|
2559
|
-
"name": "helpText",
|
2560
|
-
"type": {
|
2561
|
-
"text": "string | undefined"
|
2562
|
-
},
|
2563
|
-
"description": "The help text that is displayed below the input field.",
|
2564
|
-
"attribute": "help-text",
|
2565
|
-
"reflects": true
|
2566
|
-
},
|
2567
|
-
{
|
2568
|
-
"kind": "field",
|
2569
|
-
"name": "labelInfoText",
|
2570
|
-
"type": {
|
2571
|
-
"text": "string | undefined"
|
2572
|
-
},
|
2573
|
-
"attribute": "label-info-text"
|
2574
|
-
},
|
2575
|
-
{
|
2576
|
-
"kind": "method",
|
2577
|
-
"name": "renderLabelElement",
|
2578
|
-
"privacy": "protected",
|
2579
|
-
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
2580
|
-
"return": {
|
2581
|
-
"type": {
|
2582
|
-
"text": ""
|
2583
|
-
}
|
2584
|
-
}
|
2585
|
-
},
|
2586
|
-
{
|
2587
|
-
"kind": "method",
|
2588
|
-
"name": "renderLabelInfoToggleTip",
|
2589
|
-
"privacy": "protected",
|
2590
|
-
"description": "displays a info icon, which when hovered over, displays the labelInfoText.\nThis is in beta and is subject to change once the toggletip component is ready.",
|
2591
|
-
"return": {
|
2592
|
-
"type": {
|
2593
|
-
"text": ""
|
2594
|
-
}
|
2595
|
-
}
|
2596
|
-
},
|
2597
|
-
{
|
2598
|
-
"kind": "method",
|
2599
|
-
"name": "renderHelpTextIcon",
|
2600
|
-
"privacy": "protected",
|
2601
|
-
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
2602
|
-
"return": {
|
2603
|
-
"type": {
|
2604
|
-
"text": ""
|
2605
|
-
}
|
2606
|
-
}
|
2607
|
-
},
|
2608
|
-
{
|
2609
|
-
"kind": "method",
|
2610
|
-
"name": "renderHelpText",
|
2611
|
-
"privacy": "protected",
|
2612
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
2613
|
-
"return": {
|
2614
|
-
"type": {
|
2615
|
-
"text": ""
|
2616
|
-
}
|
2617
|
-
}
|
2618
|
-
},
|
2619
|
-
{
|
2620
|
-
"kind": "method",
|
2621
|
-
"name": "renderLabel",
|
2622
|
-
"privacy": "protected",
|
2623
|
-
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
2624
|
-
"return": {
|
2625
|
-
"type": {
|
2626
|
-
"text": ""
|
2627
|
-
}
|
2628
|
-
}
|
2629
|
-
},
|
2630
|
-
{
|
2631
|
-
"kind": "method",
|
2632
|
-
"name": "renderHelperText",
|
2633
|
-
"privacy": "protected",
|
2634
|
-
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
2635
|
-
"return": {
|
2636
|
-
"type": {
|
2637
|
-
"text": ""
|
2638
|
-
}
|
2639
|
-
}
|
2640
|
-
}
|
2641
|
-
],
|
2642
|
-
"attributes": [
|
2643
|
-
{
|
2644
|
-
"name": "label",
|
2645
|
-
"type": {
|
2646
|
-
"text": "string | undefined"
|
2647
|
-
},
|
2648
|
-
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
2649
|
-
"fieldName": "label"
|
2650
|
-
},
|
2651
|
-
{
|
2652
|
-
"name": "id",
|
2653
|
-
"default": "`mdc-input-${uuidv4()}`",
|
2654
|
-
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
2655
|
-
"fieldName": "id"
|
2656
|
-
},
|
2657
|
-
{
|
2658
|
-
"name": "help-text-type",
|
2659
|
-
"type": {
|
2660
|
-
"text": "ValidationType"
|
2661
|
-
},
|
2662
|
-
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
2663
|
-
"fieldName": "helpTextType"
|
2664
|
-
},
|
2665
|
-
{
|
2666
|
-
"name": "help-text",
|
2667
|
-
"type": {
|
2668
|
-
"text": "string | undefined"
|
2669
|
-
},
|
2670
|
-
"description": "The help text that is displayed below the input field.",
|
2671
|
-
"fieldName": "helpText"
|
2672
|
-
},
|
2673
|
-
{
|
2674
|
-
"name": "label-info-text",
|
2675
|
-
"type": {
|
2676
|
-
"text": "string | undefined"
|
2677
|
-
},
|
2678
|
-
"fieldName": "labelInfoText"
|
2679
|
-
}
|
2680
|
-
],
|
2681
|
-
"superclass": {
|
2682
|
-
"name": "Component",
|
2683
|
-
"module": "/src/models"
|
2684
|
-
},
|
2685
|
-
"tagName": "mdc-labelandhelper",
|
2686
|
-
"jsDoc": "/**\n * labelandhelper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-labelandhelper\n *\n */",
|
2687
|
-
"customElement": true
|
2688
|
-
}
|
2689
|
-
],
|
2690
|
-
"exports": [
|
2691
|
-
{
|
2692
|
-
"kind": "js",
|
2693
|
-
"name": "default",
|
2694
|
-
"declaration": {
|
2695
|
-
"name": "LabelAndHelper",
|
2696
|
-
"module": "components/labelandhelper/labelandhelper.component.js"
|
2697
|
-
}
|
2698
|
-
}
|
2699
|
-
]
|
2700
|
-
},
|
2701
2701
|
{
|
2702
2702
|
"kind": "javascript-module",
|
2703
2703
|
"path": "components/marker/marker.component.js",
|