@momentum-design/components 0.18.5 → 0.18.7
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 +460 -113
- package/dist/browser/index.js.map +4 -4
- package/dist/components/formfieldwrapper/formfieldwrapper.constants.d.ts +3 -3
- package/dist/components/formfieldwrapper/formfieldwrapper.constants.js +3 -3
- package/dist/components/formfieldwrapper/formfieldwrapper.utils.js +4 -4
- package/dist/components/iconprovider/iconprovider.constants.js +2 -1
- package/dist/components/input/index.d.ts +10 -0
- package/dist/components/input/index.js +7 -0
- package/dist/components/input/input.component.d.ts +208 -0
- package/dist/components/input/input.component.js +401 -0
- package/dist/components/input/input.constants.d.ts +25 -0
- package/dist/components/input/input.constants.js +29 -0
- package/dist/components/input/input.styles.d.ts +2 -0
- package/dist/components/input/input.styles.js +118 -0
- package/dist/components/input/input.types.d.ts +4 -0
- package/dist/components/input/input.types.js +1 -0
- package/dist/components/toggle/index.d.ts +8 -0
- package/dist/components/toggle/index.js +5 -0
- package/dist/components/toggle/toggle.component.d.ts +84 -0
- package/dist/components/toggle/toggle.component.js +166 -0
- package/dist/components/toggle/toggle.constants.d.ts +17 -0
- package/dist/components/toggle/toggle.constants.js +18 -0
- package/dist/components/toggle/toggle.styles.d.ts +2 -0
- package/dist/components/toggle/toggle.styles.js +148 -0
- package/dist/components/toggle/toggle.types.d.ts +4 -0
- package/dist/components/toggle/toggle.types.js +1 -0
- package/dist/custom-elements.json +2329 -1013
- package/dist/index.d.ts +3 -1
- package/dist/index.js +3 -1
- package/dist/react/index.d.ts +3 -1
- package/dist/react/index.js +3 -1
- package/dist/react/input/index.d.ts +39 -0
- package/dist/react/input/index.js +48 -0
- package/dist/react/toggle/index.d.ts +34 -0
- package/dist/react/toggle/index.js +43 -0
- package/package.json +1 -1
@@ -244,844 +244,844 @@
|
|
244
244
|
},
|
245
245
|
{
|
246
246
|
"kind": "javascript-module",
|
247
|
-
"path": "components/
|
247
|
+
"path": "components/badge/badge.component.js",
|
248
248
|
"declarations": [
|
249
249
|
{
|
250
250
|
"kind": "class",
|
251
|
-
"description": "The `mdc-
|
252
|
-
"name": "
|
253
|
-
"
|
251
|
+
"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.",
|
252
|
+
"name": "Badge",
|
253
|
+
"cssProperties": [
|
254
254
|
{
|
255
|
-
"
|
256
|
-
"name": "
|
257
|
-
"type": {
|
258
|
-
"text": "string | null"
|
259
|
-
},
|
260
|
-
"default": "null",
|
261
|
-
"description": "Aria-label attribute to be set for accessibility",
|
262
|
-
"attribute": "aria-label"
|
255
|
+
"description": "The foreground color of the primary badge.",
|
256
|
+
"name": "--mdc-badge-primary-foreground-color"
|
263
257
|
},
|
264
258
|
{
|
265
|
-
"
|
266
|
-
"name": "
|
267
|
-
"privacy": "private",
|
268
|
-
"parameters": [
|
269
|
-
{
|
270
|
-
"name": "size",
|
271
|
-
"type": {
|
272
|
-
"text": "AvatarSize"
|
273
|
-
}
|
274
|
-
}
|
275
|
-
]
|
259
|
+
"description": "The background color of the primary badge.",
|
260
|
+
"name": "--mdc-badge-primary-background-color"
|
276
261
|
},
|
277
262
|
{
|
278
|
-
"
|
279
|
-
"name": "
|
280
|
-
"type": {
|
281
|
-
"text": "boolean"
|
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
|
-
}
|
263
|
+
"description": "The foreground color of the secondary badge.",
|
264
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
290
265
|
},
|
291
266
|
{
|
292
|
-
"
|
293
|
-
"name": "
|
294
|
-
"type": {
|
295
|
-
"text": "boolean"
|
296
|
-
},
|
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
|
-
}
|
267
|
+
"description": "The background color of the secondary badge.",
|
268
|
+
"name": "--mdc-badge-secondary-background-color"
|
305
269
|
},
|
306
270
|
{
|
307
|
-
"
|
308
|
-
"name": "
|
309
|
-
"type": {
|
310
|
-
"text": "boolean"
|
311
|
-
},
|
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
|
-
}
|
271
|
+
"description": "The foreground color of the success badge.",
|
272
|
+
"name": "--mdc-badge-success-foreground-color"
|
319
273
|
},
|
320
274
|
{
|
321
|
-
"
|
322
|
-
"name": "
|
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,
|
327
|
-
"type": {
|
328
|
-
"text": "string"
|
329
|
-
},
|
330
|
-
"inheritedFrom": {
|
331
|
-
"name": "Buttonsimple",
|
332
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
333
|
-
}
|
275
|
+
"description": "The background color of the success badge.",
|
276
|
+
"name": "--mdc-badge-success-background-color"
|
334
277
|
},
|
335
278
|
{
|
336
|
-
"
|
337
|
-
"name": "
|
338
|
-
"type": {
|
339
|
-
"text": "ButtonType"
|
340
|
-
},
|
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
|
-
}
|
279
|
+
"description": "The foreground color of the warning badge.",
|
280
|
+
"name": "--mdc-badge-warning-foreground-color"
|
349
281
|
},
|
350
282
|
{
|
351
|
-
"
|
352
|
-
"name": "
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
"
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
}
|
283
|
+
"description": "The background color of the warning badge.",
|
284
|
+
"name": "--mdc-badge-warning-background-color"
|
285
|
+
},
|
286
|
+
{
|
287
|
+
"description": "The foreground color of the error badge.",
|
288
|
+
"name": "--mdc-badge-error-foreground-color"
|
289
|
+
},
|
290
|
+
{
|
291
|
+
"description": "The background color of the error badge.",
|
292
|
+
"name": "--mdc-badge-error-background-color"
|
362
293
|
},
|
294
|
+
{
|
295
|
+
"description": "The background color of the badge overlay.",
|
296
|
+
"name": "--mdc-badge-overlay-background-color"
|
297
|
+
}
|
298
|
+
],
|
299
|
+
"members": [
|
363
300
|
{
|
364
301
|
"kind": "field",
|
365
|
-
"name": "
|
302
|
+
"name": "type",
|
366
303
|
"type": {
|
367
|
-
"text": "
|
304
|
+
"text": "BadgeType | undefined"
|
368
305
|
},
|
369
|
-
"description": "
|
370
|
-
"attribute": "
|
371
|
-
"
|
372
|
-
"name": "AvatarComponentMixin",
|
373
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
374
|
-
}
|
306
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
307
|
+
"attribute": "type",
|
308
|
+
"reflects": true
|
375
309
|
},
|
376
310
|
{
|
377
311
|
"kind": "field",
|
378
|
-
"name": "
|
312
|
+
"name": "iconName",
|
379
313
|
"type": {
|
380
|
-
"text": "
|
314
|
+
"text": "IconNames | undefined"
|
381
315
|
},
|
382
|
-
"description": "
|
383
|
-
"attribute": "
|
384
|
-
"inheritedFrom": {
|
385
|
-
"name": "AvatarComponentMixin",
|
386
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
387
|
-
}
|
316
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
317
|
+
"attribute": "icon-name"
|
388
318
|
},
|
389
319
|
{
|
390
320
|
"kind": "field",
|
391
|
-
"name": "
|
321
|
+
"name": "variant",
|
392
322
|
"type": {
|
393
|
-
"text": "
|
323
|
+
"text": "IconVariant"
|
394
324
|
},
|
395
|
-
"description": "
|
396
|
-
"default": "
|
397
|
-
"attribute": "
|
398
|
-
"reflects": true
|
399
|
-
"inheritedFrom": {
|
400
|
-
"name": "Buttonsimple",
|
401
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
402
|
-
}
|
325
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
326
|
+
"default": "primary",
|
327
|
+
"attribute": "variant",
|
328
|
+
"reflects": true
|
403
329
|
},
|
404
330
|
{
|
405
331
|
"kind": "field",
|
406
|
-
"name": "
|
332
|
+
"name": "counter",
|
407
333
|
"type": {
|
408
|
-
"text": "
|
334
|
+
"text": "number | undefined"
|
409
335
|
},
|
410
|
-
"description": "
|
411
|
-
"attribute": "
|
412
|
-
"inheritedFrom": {
|
413
|
-
"name": "AvatarComponentMixin",
|
414
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
415
|
-
}
|
336
|
+
"description": "Counter is the number which can be provided in the badge.",
|
337
|
+
"attribute": "counter"
|
416
338
|
},
|
417
339
|
{
|
418
340
|
"kind": "field",
|
419
|
-
"name": "
|
341
|
+
"name": "maxCounter",
|
420
342
|
"type": {
|
421
|
-
"text": "number
|
343
|
+
"text": "number"
|
422
344
|
},
|
423
|
-
"description": "The
|
424
|
-
"
|
425
|
-
"
|
426
|
-
|
427
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
428
|
-
}
|
345
|
+
"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`.",
|
346
|
+
"default": "99",
|
347
|
+
"attribute": "max-counter",
|
348
|
+
"reflects": true
|
429
349
|
},
|
430
350
|
{
|
431
351
|
"kind": "field",
|
432
|
-
"name": "
|
352
|
+
"name": "overlay",
|
433
353
|
"type": {
|
434
354
|
"text": "boolean"
|
435
355
|
},
|
436
356
|
"default": "false",
|
437
|
-
"description": "
|
438
|
-
"attribute": "
|
439
|
-
"inheritedFrom": {
|
440
|
-
"name": "AvatarComponentMixin",
|
441
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
442
|
-
}
|
357
|
+
"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.",
|
358
|
+
"attribute": "overlay"
|
443
359
|
},
|
444
360
|
{
|
445
361
|
"kind": "field",
|
446
|
-
"name": "
|
362
|
+
"name": "ariaLabel",
|
447
363
|
"type": {
|
448
|
-
"text": "
|
364
|
+
"text": "string | null"
|
449
365
|
},
|
450
|
-
"default": "
|
451
|
-
"description": "
|
452
|
-
"attribute": "
|
453
|
-
"reflects": true,
|
454
|
-
"inheritedFrom": {
|
455
|
-
"name": "TabIndexMixin",
|
456
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
457
|
-
}
|
458
|
-
},
|
459
|
-
{
|
460
|
-
"kind": "method",
|
461
|
-
"name": "executeAction",
|
462
|
-
"privacy": "private",
|
463
|
-
"inheritedFrom": {
|
464
|
-
"name": "Buttonsimple",
|
465
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
466
|
-
}
|
366
|
+
"default": "null",
|
367
|
+
"description": "Aria-label attribute to be set for accessibility",
|
368
|
+
"attribute": "aria-label"
|
467
369
|
},
|
468
370
|
{
|
469
371
|
"kind": "method",
|
470
|
-
"name": "
|
372
|
+
"name": "getCounterText",
|
471
373
|
"privacy": "private",
|
374
|
+
"return": {
|
375
|
+
"type": {
|
376
|
+
"text": ""
|
377
|
+
}
|
378
|
+
},
|
472
379
|
"parameters": [
|
473
380
|
{
|
474
|
-
"name": "
|
381
|
+
"name": "maxCounter",
|
475
382
|
"type": {
|
476
|
-
"text": "
|
383
|
+
"text": "number"
|
477
384
|
},
|
478
|
-
"description": "
|
385
|
+
"description": "the maximum limit which can be displayed on the badge"
|
479
386
|
},
|
480
387
|
{
|
481
|
-
"name": "
|
388
|
+
"name": "counter",
|
389
|
+
"optional": true,
|
482
390
|
"type": {
|
483
|
-
"text": "
|
391
|
+
"text": "number"
|
484
392
|
},
|
485
|
-
"description": "
|
393
|
+
"description": "the number to be displayed on the badge"
|
486
394
|
}
|
487
395
|
],
|
488
|
-
"description": "
|
489
|
-
"inheritedFrom": {
|
490
|
-
"name": "Buttonsimple",
|
491
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
492
|
-
}
|
396
|
+
"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."
|
493
397
|
},
|
494
398
|
{
|
495
399
|
"kind": "method",
|
496
|
-
"name": "
|
400
|
+
"name": "getBadgeIcon",
|
497
401
|
"privacy": "private",
|
402
|
+
"return": {
|
403
|
+
"type": {
|
404
|
+
"text": ""
|
405
|
+
}
|
406
|
+
},
|
498
407
|
"parameters": [
|
499
408
|
{
|
500
|
-
"name": "
|
409
|
+
"name": "iconName",
|
501
410
|
"type": {
|
502
|
-
"text": "
|
411
|
+
"text": "string"
|
503
412
|
},
|
504
|
-
"description": "
|
413
|
+
"description": "the name of the icon from the icon set"
|
505
414
|
},
|
506
415
|
{
|
507
|
-
"name": "
|
416
|
+
"name": "backgroundClassPostfix",
|
508
417
|
"type": {
|
509
|
-
"text": "
|
418
|
+
"text": "string"
|
510
419
|
},
|
511
|
-
"description": "
|
420
|
+
"description": "postfix for the class to style the badge icon."
|
512
421
|
}
|
513
422
|
],
|
514
|
-
"description": "
|
515
|
-
"inheritedFrom": {
|
516
|
-
"name": "Buttonsimple",
|
517
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
518
|
-
}
|
423
|
+
"description": "Method to generate the badge icon."
|
519
424
|
},
|
520
425
|
{
|
521
426
|
"kind": "method",
|
522
|
-
"name": "
|
427
|
+
"name": "getBadgeDot",
|
523
428
|
"privacy": "private",
|
524
|
-
"
|
525
|
-
{
|
526
|
-
"
|
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."
|
429
|
+
"return": {
|
430
|
+
"type": {
|
431
|
+
"text": ""
|
538
432
|
}
|
539
|
-
|
540
|
-
"description": "
|
541
|
-
"inheritedFrom": {
|
542
|
-
"name": "Buttonsimple",
|
543
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
544
|
-
}
|
433
|
+
},
|
434
|
+
"description": "Method to generate the badge dot template."
|
545
435
|
},
|
546
436
|
{
|
547
437
|
"kind": "method",
|
548
|
-
"name": "
|
438
|
+
"name": "getBadgeCounterText",
|
549
439
|
"privacy": "private",
|
550
|
-
"
|
551
|
-
"
|
552
|
-
|
553
|
-
|
440
|
+
"return": {
|
441
|
+
"type": {
|
442
|
+
"text": ""
|
443
|
+
}
|
444
|
+
},
|
445
|
+
"description": "Method to generate the badge text and counter template."
|
554
446
|
},
|
555
447
|
{
|
556
448
|
"kind": "method",
|
557
|
-
"name": "
|
449
|
+
"name": "setRoleByAriaLabel",
|
558
450
|
"privacy": "private",
|
559
|
-
"
|
560
|
-
{
|
561
|
-
"
|
562
|
-
"type": {
|
563
|
-
"text": "KeyboardEvent"
|
564
|
-
},
|
565
|
-
"description": "The keyboard event."
|
451
|
+
"return": {
|
452
|
+
"type": {
|
453
|
+
"text": "void"
|
566
454
|
}
|
567
|
-
|
568
|
-
"description": "
|
569
|
-
"inheritedFrom": {
|
570
|
-
"name": "Buttonsimple",
|
571
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
572
|
-
}
|
455
|
+
},
|
456
|
+
"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."
|
573
457
|
},
|
574
458
|
{
|
575
459
|
"kind": "method",
|
576
|
-
"name": "
|
460
|
+
"name": "getBadgeContentBasedOnType",
|
577
461
|
"privacy": "private",
|
578
|
-
"
|
579
|
-
{
|
580
|
-
"
|
581
|
-
"type": {
|
582
|
-
"text": "KeyboardEvent"
|
583
|
-
},
|
584
|
-
"description": "The keyboard event."
|
462
|
+
"return": {
|
463
|
+
"type": {
|
464
|
+
"text": ""
|
585
465
|
}
|
586
|
-
|
587
|
-
"description": "
|
588
|
-
"inheritedFrom": {
|
589
|
-
"name": "Buttonsimple",
|
590
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
591
|
-
}
|
466
|
+
},
|
467
|
+
"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."
|
592
468
|
}
|
593
469
|
],
|
594
470
|
"attributes": [
|
595
471
|
{
|
596
|
-
"name": "
|
472
|
+
"name": "type",
|
597
473
|
"type": {
|
598
|
-
"text": "
|
474
|
+
"text": "BadgeType | undefined"
|
599
475
|
},
|
600
|
-
"
|
601
|
-
"
|
602
|
-
"fieldName": "ariaLabel"
|
476
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
477
|
+
"fieldName": "type"
|
603
478
|
},
|
604
479
|
{
|
605
|
-
"name": "
|
480
|
+
"name": "icon-name",
|
606
481
|
"type": {
|
607
|
-
"text": "
|
482
|
+
"text": "IconNames | undefined"
|
608
483
|
},
|
609
|
-
"description": "
|
610
|
-
"fieldName": "
|
611
|
-
"inheritedFrom": {
|
612
|
-
"name": "AvatarComponentMixin",
|
613
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
614
|
-
}
|
484
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
485
|
+
"fieldName": "iconName"
|
615
486
|
},
|
616
487
|
{
|
617
|
-
"name": "
|
488
|
+
"name": "variant",
|
618
489
|
"type": {
|
619
|
-
"text": "
|
490
|
+
"text": "IconVariant"
|
620
491
|
},
|
621
|
-
"description": "
|
622
|
-
"
|
623
|
-
"
|
624
|
-
"name": "AvatarComponentMixin",
|
625
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
626
|
-
}
|
492
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
493
|
+
"default": "primary",
|
494
|
+
"fieldName": "variant"
|
627
495
|
},
|
628
496
|
{
|
629
|
-
"name": "
|
497
|
+
"name": "counter",
|
630
498
|
"type": {
|
631
|
-
"text": "
|
499
|
+
"text": "number | undefined"
|
632
500
|
},
|
633
|
-
"description": "
|
634
|
-
"fieldName": "
|
635
|
-
"inheritedFrom": {
|
636
|
-
"name": "AvatarComponentMixin",
|
637
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
638
|
-
}
|
501
|
+
"description": "Counter is the number which can be provided in the badge.",
|
502
|
+
"fieldName": "counter"
|
639
503
|
},
|
640
504
|
{
|
641
|
-
"name": "
|
505
|
+
"name": "max-counter",
|
642
506
|
"type": {
|
643
|
-
"text": "
|
507
|
+
"text": "number"
|
644
508
|
},
|
645
|
-
"description": "
|
646
|
-
"default": "
|
647
|
-
"fieldName": "
|
648
|
-
"inheritedFrom": {
|
649
|
-
"name": "Buttonsimple",
|
650
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
651
|
-
}
|
509
|
+
"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`.",
|
510
|
+
"default": "99",
|
511
|
+
"fieldName": "maxCounter"
|
652
512
|
},
|
653
513
|
{
|
654
|
-
"name": "
|
514
|
+
"name": "overlay",
|
655
515
|
"type": {
|
656
|
-
"text": "
|
516
|
+
"text": "boolean"
|
657
517
|
},
|
658
|
-
"
|
659
|
-
"
|
660
|
-
"
|
661
|
-
"name": "AvatarComponentMixin",
|
662
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
663
|
-
}
|
518
|
+
"default": "false",
|
519
|
+
"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.",
|
520
|
+
"fieldName": "overlay"
|
664
521
|
},
|
665
522
|
{
|
666
|
-
"name": "
|
523
|
+
"name": "aria-label",
|
667
524
|
"type": {
|
668
|
-
"text": "
|
525
|
+
"text": "string | null"
|
669
526
|
},
|
670
|
-
"
|
671
|
-
"
|
672
|
-
"
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
527
|
+
"default": "null",
|
528
|
+
"description": "Aria-label attribute to be set for accessibility",
|
529
|
+
"fieldName": "ariaLabel"
|
530
|
+
}
|
531
|
+
],
|
532
|
+
"superclass": {
|
533
|
+
"name": "Component",
|
534
|
+
"module": "/src/models"
|
535
|
+
},
|
536
|
+
"tagName": "mdc-badge",
|
537
|
+
"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 *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
538
|
+
"customElement": true
|
539
|
+
}
|
540
|
+
],
|
541
|
+
"exports": [
|
542
|
+
{
|
543
|
+
"kind": "js",
|
544
|
+
"name": "default",
|
545
|
+
"declaration": {
|
546
|
+
"name": "Badge",
|
547
|
+
"module": "components/badge/badge.component.js"
|
548
|
+
}
|
549
|
+
}
|
550
|
+
]
|
551
|
+
},
|
552
|
+
{
|
553
|
+
"kind": "javascript-module",
|
554
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
555
|
+
"declarations": [
|
556
|
+
{
|
557
|
+
"kind": "class",
|
558
|
+
"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.",
|
559
|
+
"name": "AvatarButton",
|
560
|
+
"members": [
|
677
561
|
{
|
678
|
-
"
|
562
|
+
"kind": "field",
|
563
|
+
"name": "ariaLabel",
|
679
564
|
"type": {
|
680
|
-
"text": "
|
565
|
+
"text": "string | null"
|
681
566
|
},
|
682
|
-
"default": "
|
683
|
-
"description": "
|
684
|
-
"
|
685
|
-
"inheritedFrom": {
|
686
|
-
"name": "AvatarComponentMixin",
|
687
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
688
|
-
}
|
567
|
+
"default": "null",
|
568
|
+
"description": "Aria-label attribute to be set for accessibility",
|
569
|
+
"attribute": "aria-label"
|
689
570
|
},
|
690
571
|
{
|
691
|
-
"
|
572
|
+
"kind": "method",
|
573
|
+
"name": "setSize",
|
574
|
+
"privacy": "private",
|
575
|
+
"parameters": [
|
576
|
+
{
|
577
|
+
"name": "size",
|
578
|
+
"type": {
|
579
|
+
"text": "AvatarSize"
|
580
|
+
}
|
581
|
+
}
|
582
|
+
]
|
583
|
+
},
|
584
|
+
{
|
585
|
+
"kind": "field",
|
586
|
+
"name": "active",
|
692
587
|
"type": {
|
693
|
-
"text": "
|
588
|
+
"text": "boolean"
|
694
589
|
},
|
695
|
-
"default": "
|
696
|
-
"description": "
|
697
|
-
"
|
590
|
+
"default": "undefined as unknown",
|
591
|
+
"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.",
|
592
|
+
"attribute": "active",
|
698
593
|
"inheritedFrom": {
|
699
|
-
"name": "
|
700
|
-
"module": "
|
594
|
+
"name": "Buttonsimple",
|
595
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
701
596
|
}
|
702
597
|
},
|
703
598
|
{
|
599
|
+
"kind": "field",
|
704
600
|
"name": "disabled",
|
705
601
|
"type": {
|
706
602
|
"text": "boolean"
|
707
603
|
},
|
708
|
-
"default": "
|
604
|
+
"default": "undefined as unknown",
|
709
605
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
710
|
-
"
|
606
|
+
"attribute": "disabled",
|
607
|
+
"reflects": true,
|
711
608
|
"inheritedFrom": {
|
712
609
|
"name": "DisabledMixin",
|
713
|
-
"module": "
|
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"
|
610
|
+
"module": "utils/mixins/DisabledMixin.js"
|
727
611
|
}
|
728
612
|
},
|
729
613
|
{
|
730
|
-
"
|
614
|
+
"kind": "field",
|
615
|
+
"name": "softDisabled",
|
731
616
|
"type": {
|
732
617
|
"text": "boolean"
|
733
618
|
},
|
734
|
-
"default": "
|
619
|
+
"default": "undefined as unknown",
|
735
620
|
"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
|
-
"
|
621
|
+
"attribute": "soft-disabled",
|
737
622
|
"inheritedFrom": {
|
738
623
|
"name": "Buttonsimple",
|
739
|
-
"module": "
|
624
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
740
625
|
}
|
741
626
|
},
|
742
627
|
{
|
628
|
+
"kind": "field",
|
743
629
|
"name": "role",
|
744
630
|
"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
|
-
"
|
631
|
+
"default": "'button'",
|
632
|
+
"attribute": "role",
|
633
|
+
"reflects": true,
|
634
|
+
"type": {
|
635
|
+
"text": "string"
|
636
|
+
},
|
747
637
|
"inheritedFrom": {
|
748
638
|
"name": "Buttonsimple",
|
749
|
-
"module": "
|
639
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
750
640
|
}
|
751
641
|
},
|
752
642
|
{
|
643
|
+
"kind": "field",
|
753
644
|
"name": "type",
|
754
645
|
"type": {
|
755
646
|
"text": "ButtonType"
|
756
647
|
},
|
757
648
|
"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
649
|
"default": "button",
|
759
|
-
"
|
650
|
+
"attribute": "type",
|
651
|
+
"reflects": true,
|
760
652
|
"inheritedFrom": {
|
761
653
|
"name": "Buttonsimple",
|
762
|
-
"module": "
|
654
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
763
655
|
}
|
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/buttonsimple.component"
|
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
|
-
"cssProperties": [
|
801
|
-
{
|
802
|
-
"description": "The foreground color of the primary badge.",
|
803
|
-
"name": "--mdc-badge-primary-foreground-color"
|
804
|
-
},
|
805
|
-
{
|
806
|
-
"description": "The background color of the primary badge.",
|
807
|
-
"name": "--mdc-badge-primary-background-color"
|
808
|
-
},
|
809
|
-
{
|
810
|
-
"description": "The foreground color of the secondary badge.",
|
811
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
812
|
-
},
|
813
|
-
{
|
814
|
-
"description": "The background color of the secondary badge.",
|
815
|
-
"name": "--mdc-badge-secondary-background-color"
|
816
|
-
},
|
817
|
-
{
|
818
|
-
"description": "The foreground color of the success badge.",
|
819
|
-
"name": "--mdc-badge-success-foreground-color"
|
820
|
-
},
|
821
|
-
{
|
822
|
-
"description": "The background color of the success badge.",
|
823
|
-
"name": "--mdc-badge-success-background-color"
|
824
|
-
},
|
825
|
-
{
|
826
|
-
"description": "The foreground color of the warning badge.",
|
827
|
-
"name": "--mdc-badge-warning-foreground-color"
|
828
|
-
},
|
829
|
-
{
|
830
|
-
"description": "The background color of the warning badge.",
|
831
|
-
"name": "--mdc-badge-warning-background-color"
|
832
|
-
},
|
833
|
-
{
|
834
|
-
"description": "The foreground color of the error badge.",
|
835
|
-
"name": "--mdc-badge-error-foreground-color"
|
836
656
|
},
|
837
657
|
{
|
838
|
-
"
|
839
|
-
"name": "
|
658
|
+
"kind": "field",
|
659
|
+
"name": "src",
|
660
|
+
"type": {
|
661
|
+
"text": "string | undefined"
|
662
|
+
},
|
663
|
+
"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.",
|
664
|
+
"attribute": "src",
|
665
|
+
"inheritedFrom": {
|
666
|
+
"name": "AvatarComponentMixin",
|
667
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
668
|
+
}
|
840
669
|
},
|
841
|
-
{
|
842
|
-
"description": "The background color of the badge overlay.",
|
843
|
-
"name": "--mdc-badge-overlay-background-color"
|
844
|
-
}
|
845
|
-
],
|
846
|
-
"members": [
|
847
670
|
{
|
848
671
|
"kind": "field",
|
849
|
-
"name": "
|
672
|
+
"name": "initials",
|
850
673
|
"type": {
|
851
|
-
"text": "
|
674
|
+
"text": "string | undefined"
|
852
675
|
},
|
853
|
-
"description": "
|
854
|
-
"attribute": "
|
855
|
-
"
|
676
|
+
"description": "The initials to be displayed for the avatar.",
|
677
|
+
"attribute": "initials",
|
678
|
+
"inheritedFrom": {
|
679
|
+
"name": "AvatarComponentMixin",
|
680
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
681
|
+
}
|
856
682
|
},
|
857
683
|
{
|
858
684
|
"kind": "field",
|
859
|
-
"name": "
|
685
|
+
"name": "presence",
|
860
686
|
"type": {
|
861
|
-
"text": "
|
687
|
+
"text": "PresenceType | undefined"
|
862
688
|
},
|
863
|
-
"description": "
|
864
|
-
"attribute": "
|
689
|
+
"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`",
|
690
|
+
"attribute": "presence",
|
691
|
+
"inheritedFrom": {
|
692
|
+
"name": "AvatarComponentMixin",
|
693
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
694
|
+
}
|
865
695
|
},
|
866
696
|
{
|
867
697
|
"kind": "field",
|
868
|
-
"name": "
|
698
|
+
"name": "size",
|
869
699
|
"type": {
|
870
|
-
"text": "
|
700
|
+
"text": "ButtonSize"
|
871
701
|
},
|
872
|
-
"description": "
|
873
|
-
"default": "
|
874
|
-
"attribute": "
|
875
|
-
"reflects": true
|
702
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
703
|
+
"default": "32",
|
704
|
+
"attribute": "size",
|
705
|
+
"reflects": true,
|
706
|
+
"inheritedFrom": {
|
707
|
+
"name": "Buttonsimple",
|
708
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
709
|
+
}
|
876
710
|
},
|
877
711
|
{
|
878
712
|
"kind": "field",
|
879
|
-
"name": "
|
713
|
+
"name": "iconName",
|
880
714
|
"type": {
|
881
|
-
"text": "
|
715
|
+
"text": "IconNames | undefined"
|
882
716
|
},
|
883
|
-
"description": "
|
884
|
-
"attribute": "
|
717
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
718
|
+
"attribute": "icon-name",
|
719
|
+
"inheritedFrom": {
|
720
|
+
"name": "AvatarComponentMixin",
|
721
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
722
|
+
}
|
885
723
|
},
|
886
724
|
{
|
887
725
|
"kind": "field",
|
888
|
-
"name": "
|
726
|
+
"name": "counter",
|
889
727
|
"type": {
|
890
|
-
"text": "number"
|
728
|
+
"text": "number | undefined"
|
891
729
|
},
|
892
|
-
"description": "The
|
893
|
-
"
|
894
|
-
"
|
895
|
-
|
730
|
+
"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`.",
|
731
|
+
"attribute": "counter",
|
732
|
+
"inheritedFrom": {
|
733
|
+
"name": "AvatarComponentMixin",
|
734
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
735
|
+
}
|
896
736
|
},
|
897
737
|
{
|
898
738
|
"kind": "field",
|
899
|
-
"name": "
|
739
|
+
"name": "isTyping",
|
900
740
|
"type": {
|
901
741
|
"text": "boolean"
|
902
742
|
},
|
903
743
|
"default": "false",
|
904
|
-
"description": "
|
905
|
-
"attribute": "
|
744
|
+
"description": "Represents the typing indicator when the user is typing.",
|
745
|
+
"attribute": "is-typing",
|
746
|
+
"inheritedFrom": {
|
747
|
+
"name": "AvatarComponentMixin",
|
748
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
749
|
+
}
|
906
750
|
},
|
907
751
|
{
|
908
752
|
"kind": "field",
|
909
|
-
"name": "
|
753
|
+
"name": "tabIndex",
|
910
754
|
"type": {
|
911
|
-
"text": "
|
755
|
+
"text": "number"
|
912
756
|
},
|
913
|
-
"default": "
|
914
|
-
"description": "
|
915
|
-
"attribute": "
|
757
|
+
"default": "0",
|
758
|
+
"description": "This property specifies the tab order of the element.",
|
759
|
+
"attribute": "tabIndex",
|
760
|
+
"reflects": true,
|
761
|
+
"inheritedFrom": {
|
762
|
+
"name": "TabIndexMixin",
|
763
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
764
|
+
}
|
916
765
|
},
|
917
766
|
{
|
918
767
|
"kind": "method",
|
919
|
-
"name": "
|
768
|
+
"name": "executeAction",
|
920
769
|
"privacy": "private",
|
921
|
-
"
|
922
|
-
"
|
923
|
-
|
924
|
-
|
925
|
-
|
926
|
-
|
927
|
-
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
},
|
932
|
-
"description": "the maximum limit which can be displayed on the badge"
|
933
|
-
},
|
770
|
+
"inheritedFrom": {
|
771
|
+
"name": "Buttonsimple",
|
772
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
773
|
+
}
|
774
|
+
},
|
775
|
+
{
|
776
|
+
"kind": "method",
|
777
|
+
"name": "setAriaPressed",
|
778
|
+
"privacy": "private",
|
779
|
+
"parameters": [
|
934
780
|
{
|
935
|
-
"name": "
|
936
|
-
"optional": true,
|
781
|
+
"name": "element",
|
937
782
|
"type": {
|
938
|
-
"text": "
|
783
|
+
"text": "HTMLElement"
|
939
784
|
},
|
940
|
-
"description": "
|
785
|
+
"description": "The target element."
|
786
|
+
},
|
787
|
+
{
|
788
|
+
"name": "active",
|
789
|
+
"type": {
|
790
|
+
"text": "boolean"
|
791
|
+
},
|
792
|
+
"description": "The active state."
|
941
793
|
}
|
942
794
|
],
|
943
|
-
"description": "
|
795
|
+
"description": "Sets the aria-pressed attribute based on the active state.",
|
796
|
+
"inheritedFrom": {
|
797
|
+
"name": "Buttonsimple",
|
798
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
799
|
+
}
|
944
800
|
},
|
945
801
|
{
|
946
802
|
"kind": "method",
|
947
|
-
"name": "
|
803
|
+
"name": "setSoftDisabled",
|
948
804
|
"privacy": "private",
|
949
|
-
"return": {
|
950
|
-
"type": {
|
951
|
-
"text": ""
|
952
|
-
}
|
953
|
-
},
|
954
805
|
"parameters": [
|
955
806
|
{
|
956
|
-
"name": "
|
807
|
+
"name": "element",
|
957
808
|
"type": {
|
958
|
-
"text": "
|
809
|
+
"text": "HTMLElement"
|
959
810
|
},
|
960
|
-
"description": "
|
811
|
+
"description": "The button element."
|
961
812
|
},
|
962
813
|
{
|
963
|
-
"name": "
|
814
|
+
"name": "softDisabled",
|
964
815
|
"type": {
|
965
|
-
"text": "
|
816
|
+
"text": "boolean"
|
966
817
|
},
|
967
|
-
"description": "
|
818
|
+
"description": "The soft-disabled state."
|
968
819
|
}
|
969
820
|
],
|
970
|
-
"description": "
|
821
|
+
"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.",
|
822
|
+
"inheritedFrom": {
|
823
|
+
"name": "Buttonsimple",
|
824
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
825
|
+
}
|
971
826
|
},
|
972
827
|
{
|
973
828
|
"kind": "method",
|
974
|
-
"name": "
|
829
|
+
"name": "setDisabled",
|
975
830
|
"privacy": "private",
|
976
|
-
"
|
977
|
-
|
978
|
-
"
|
831
|
+
"parameters": [
|
832
|
+
{
|
833
|
+
"name": "element",
|
834
|
+
"type": {
|
835
|
+
"text": "HTMLElement"
|
836
|
+
},
|
837
|
+
"description": "The button element."
|
838
|
+
},
|
839
|
+
{
|
840
|
+
"name": "disabled",
|
841
|
+
"type": {
|
842
|
+
"text": "boolean"
|
843
|
+
},
|
844
|
+
"description": "The disabled state."
|
979
845
|
}
|
980
|
-
|
981
|
-
"description": "
|
846
|
+
],
|
847
|
+
"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.",
|
848
|
+
"inheritedFrom": {
|
849
|
+
"name": "Buttonsimple",
|
850
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
851
|
+
}
|
982
852
|
},
|
983
853
|
{
|
984
854
|
"kind": "method",
|
985
|
-
"name": "
|
855
|
+
"name": "triggerClickEvent",
|
986
856
|
"privacy": "private",
|
987
|
-
"
|
988
|
-
"
|
989
|
-
|
990
|
-
|
991
|
-
},
|
992
|
-
"description": "Method to generate the badge text and counter template."
|
857
|
+
"inheritedFrom": {
|
858
|
+
"name": "Buttonsimple",
|
859
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
860
|
+
}
|
993
861
|
},
|
994
862
|
{
|
995
863
|
"kind": "method",
|
996
|
-
"name": "
|
864
|
+
"name": "handleKeyDown",
|
997
865
|
"privacy": "private",
|
998
|
-
"
|
999
|
-
|
1000
|
-
"
|
866
|
+
"parameters": [
|
867
|
+
{
|
868
|
+
"name": "event",
|
869
|
+
"type": {
|
870
|
+
"text": "KeyboardEvent"
|
871
|
+
},
|
872
|
+
"description": "The keyboard event."
|
1001
873
|
}
|
1002
|
-
|
1003
|
-
"description": "
|
874
|
+
],
|
875
|
+
"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.",
|
876
|
+
"inheritedFrom": {
|
877
|
+
"name": "Buttonsimple",
|
878
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
879
|
+
}
|
1004
880
|
},
|
1005
881
|
{
|
1006
882
|
"kind": "method",
|
1007
|
-
"name": "
|
883
|
+
"name": "handleKeyUp",
|
1008
884
|
"privacy": "private",
|
1009
|
-
"
|
1010
|
-
|
1011
|
-
"
|
885
|
+
"parameters": [
|
886
|
+
{
|
887
|
+
"name": "event",
|
888
|
+
"type": {
|
889
|
+
"text": "KeyboardEvent"
|
890
|
+
},
|
891
|
+
"description": "The keyboard event."
|
1012
892
|
}
|
1013
|
-
|
1014
|
-
"description": "
|
893
|
+
],
|
894
|
+
"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.",
|
895
|
+
"inheritedFrom": {
|
896
|
+
"name": "Buttonsimple",
|
897
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
898
|
+
}
|
1015
899
|
}
|
1016
900
|
],
|
1017
901
|
"attributes": [
|
1018
902
|
{
|
1019
|
-
"name": "
|
903
|
+
"name": "aria-label",
|
1020
904
|
"type": {
|
1021
|
-
"text": "
|
905
|
+
"text": "string | null"
|
1022
906
|
},
|
1023
|
-
"
|
1024
|
-
"
|
907
|
+
"default": "null",
|
908
|
+
"description": "Aria-label attribute to be set for accessibility",
|
909
|
+
"fieldName": "ariaLabel"
|
1025
910
|
},
|
1026
911
|
{
|
1027
|
-
"name": "
|
912
|
+
"name": "src",
|
1028
913
|
"type": {
|
1029
|
-
"text": "
|
914
|
+
"text": "string | undefined"
|
1030
915
|
},
|
1031
|
-
"description": "
|
1032
|
-
"fieldName": "
|
916
|
+
"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.",
|
917
|
+
"fieldName": "src",
|
918
|
+
"inheritedFrom": {
|
919
|
+
"name": "AvatarComponentMixin",
|
920
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
921
|
+
}
|
1033
922
|
},
|
1034
923
|
{
|
1035
|
-
"name": "
|
924
|
+
"name": "initials",
|
1036
925
|
"type": {
|
1037
|
-
"text": "
|
926
|
+
"text": "string | undefined"
|
1038
927
|
},
|
1039
|
-
"description": "
|
1040
|
-
"
|
1041
|
-
"
|
928
|
+
"description": "The initials to be displayed for the avatar.",
|
929
|
+
"fieldName": "initials",
|
930
|
+
"inheritedFrom": {
|
931
|
+
"name": "AvatarComponentMixin",
|
932
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
933
|
+
}
|
934
|
+
},
|
935
|
+
{
|
936
|
+
"name": "presence",
|
937
|
+
"type": {
|
938
|
+
"text": "PresenceType | undefined"
|
939
|
+
},
|
940
|
+
"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`",
|
941
|
+
"fieldName": "presence",
|
942
|
+
"inheritedFrom": {
|
943
|
+
"name": "AvatarComponentMixin",
|
944
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
945
|
+
}
|
946
|
+
},
|
947
|
+
{
|
948
|
+
"name": "size",
|
949
|
+
"type": {
|
950
|
+
"text": "ButtonSize"
|
951
|
+
},
|
952
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
953
|
+
"default": "32",
|
954
|
+
"fieldName": "size",
|
955
|
+
"inheritedFrom": {
|
956
|
+
"name": "Buttonsimple",
|
957
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
958
|
+
}
|
959
|
+
},
|
960
|
+
{
|
961
|
+
"name": "icon-name",
|
962
|
+
"type": {
|
963
|
+
"text": "IconNames | undefined"
|
964
|
+
},
|
965
|
+
"description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
|
966
|
+
"fieldName": "iconName",
|
967
|
+
"inheritedFrom": {
|
968
|
+
"name": "AvatarComponentMixin",
|
969
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
970
|
+
}
|
1042
971
|
},
|
1043
972
|
{
|
1044
973
|
"name": "counter",
|
1045
974
|
"type": {
|
1046
975
|
"text": "number | undefined"
|
1047
976
|
},
|
1048
|
-
"description": "
|
1049
|
-
"fieldName": "counter"
|
977
|
+
"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`.",
|
978
|
+
"fieldName": "counter",
|
979
|
+
"inheritedFrom": {
|
980
|
+
"name": "AvatarComponentMixin",
|
981
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
982
|
+
}
|
1050
983
|
},
|
1051
984
|
{
|
1052
|
-
"name": "
|
985
|
+
"name": "is-typing",
|
986
|
+
"type": {
|
987
|
+
"text": "boolean"
|
988
|
+
},
|
989
|
+
"default": "false",
|
990
|
+
"description": "Represents the typing indicator when the user is typing.",
|
991
|
+
"fieldName": "isTyping",
|
992
|
+
"inheritedFrom": {
|
993
|
+
"name": "AvatarComponentMixin",
|
994
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
995
|
+
}
|
996
|
+
},
|
997
|
+
{
|
998
|
+
"name": "tabIndex",
|
1053
999
|
"type": {
|
1054
1000
|
"text": "number"
|
1055
1001
|
},
|
1056
|
-
"
|
1057
|
-
"
|
1058
|
-
"fieldName": "
|
1002
|
+
"default": "0",
|
1003
|
+
"description": "This property specifies the tab order of the element.",
|
1004
|
+
"fieldName": "tabIndex",
|
1005
|
+
"inheritedFrom": {
|
1006
|
+
"name": "TabIndexMixin",
|
1007
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1008
|
+
}
|
1059
1009
|
},
|
1060
1010
|
{
|
1061
|
-
"name": "
|
1011
|
+
"name": "disabled",
|
1062
1012
|
"type": {
|
1063
1013
|
"text": "boolean"
|
1064
1014
|
},
|
1065
1015
|
"default": "false",
|
1066
|
-
"description": "
|
1067
|
-
"fieldName": "
|
1016
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1017
|
+
"fieldName": "disabled",
|
1018
|
+
"inheritedFrom": {
|
1019
|
+
"name": "DisabledMixin",
|
1020
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1021
|
+
}
|
1068
1022
|
},
|
1069
1023
|
{
|
1070
|
-
"name": "
|
1024
|
+
"name": "active",
|
1071
1025
|
"type": {
|
1072
|
-
"text": "
|
1026
|
+
"text": "boolean"
|
1073
1027
|
},
|
1074
|
-
"default": "
|
1075
|
-
"description": "
|
1076
|
-
"fieldName": "
|
1077
|
-
|
1028
|
+
"default": "false",
|
1029
|
+
"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.",
|
1030
|
+
"fieldName": "active",
|
1031
|
+
"inheritedFrom": {
|
1032
|
+
"name": "Buttonsimple",
|
1033
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1034
|
+
}
|
1035
|
+
},
|
1036
|
+
{
|
1037
|
+
"name": "soft-disabled",
|
1038
|
+
"type": {
|
1039
|
+
"text": "boolean"
|
1040
|
+
},
|
1041
|
+
"default": "false",
|
1042
|
+
"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.",
|
1043
|
+
"fieldName": "softDisabled",
|
1044
|
+
"inheritedFrom": {
|
1045
|
+
"name": "Buttonsimple",
|
1046
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1047
|
+
}
|
1048
|
+
},
|
1049
|
+
{
|
1050
|
+
"name": "role",
|
1051
|
+
"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.",
|
1052
|
+
"default": "button",
|
1053
|
+
"fieldName": "role",
|
1054
|
+
"inheritedFrom": {
|
1055
|
+
"name": "Buttonsimple",
|
1056
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1057
|
+
}
|
1058
|
+
},
|
1059
|
+
{
|
1060
|
+
"name": "type",
|
1061
|
+
"type": {
|
1062
|
+
"text": "ButtonType"
|
1063
|
+
},
|
1064
|
+
"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.",
|
1065
|
+
"default": "button",
|
1066
|
+
"fieldName": "type",
|
1067
|
+
"inheritedFrom": {
|
1068
|
+
"name": "Buttonsimple",
|
1069
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1070
|
+
}
|
1071
|
+
}
|
1072
|
+
],
|
1073
|
+
"mixins": [
|
1074
|
+
{
|
1075
|
+
"name": "AvatarComponentMixin",
|
1076
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1077
|
+
}
|
1078
1078
|
],
|
1079
1079
|
"superclass": {
|
1080
|
-
"name": "
|
1081
|
-
"module": "/src/
|
1080
|
+
"name": "Buttonsimple",
|
1081
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1082
1082
|
},
|
1083
|
-
"tagName": "mdc-
|
1084
|
-
"jsDoc": "/**\n * The `mdc-
|
1083
|
+
"tagName": "mdc-avatarbutton",
|
1084
|
+
"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 */",
|
1085
1085
|
"customElement": true
|
1086
1086
|
}
|
1087
1087
|
],
|
@@ -1090,8 +1090,8 @@
|
|
1090
1090
|
"kind": "js",
|
1091
1091
|
"name": "default",
|
1092
1092
|
"declaration": {
|
1093
|
-
"name": "
|
1094
|
-
"module": "components/
|
1093
|
+
"name": "AvatarButton",
|
1094
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1095
1095
|
}
|
1096
1096
|
}
|
1097
1097
|
]
|
@@ -3226,282 +3226,1465 @@
|
|
3226
3226
|
},
|
3227
3227
|
{
|
3228
3228
|
"kind": "javascript-module",
|
3229
|
-
"path": "components/
|
3229
|
+
"path": "components/input/input.component.js",
|
3230
3230
|
"declarations": [
|
3231
3231
|
{
|
3232
3232
|
"kind": "class",
|
3233
|
-
"description": "
|
3234
|
-
"name": "
|
3233
|
+
"description": "mdc-input is a component that allows users to input text.\n It contains:\n- label field - describe the input field.\n- input field - contains the value\n- help text or validation message - displayed below the input field.\n- trailing button - it displays a clear the input field.\n- prefix text - displayed before the input field.\n- leading icon - displayed before the input field.\n- clear-aria-label - aria label for the trailing button.\n- all the attributes of the input field.",
|
3234
|
+
"name": "Input",
|
3235
3235
|
"cssProperties": [
|
3236
3236
|
{
|
3237
|
-
"description": "Border
|
3238
|
-
"name": "--mdc-
|
3237
|
+
"description": "Border color for the input container when disabled",
|
3238
|
+
"name": "--mdc-input-disabled-border-color"
|
3239
3239
|
},
|
3240
3240
|
{
|
3241
|
-
"description": "Text
|
3242
|
-
"name": "--mdc-
|
3241
|
+
"description": "Text color for the input field when disabled",
|
3242
|
+
"name": "--mdc-input-disabled-text-color"
|
3243
3243
|
},
|
3244
3244
|
{
|
3245
|
-
"description": "
|
3246
|
-
"name": "--mdc-
|
3245
|
+
"description": "Background color for the input field when disabled",
|
3246
|
+
"name": "--mdc-input-disabled-background-color"
|
3247
3247
|
},
|
3248
3248
|
{
|
3249
|
-
"description": "
|
3250
|
-
"name": "--mdc-
|
3249
|
+
"description": "Border color for the input container",
|
3250
|
+
"name": "--mdc-input-border-color"
|
3251
3251
|
},
|
3252
3252
|
{
|
3253
|
-
"description": "Text
|
3254
|
-
"name": "--mdc-
|
3253
|
+
"description": "Text color for the input field",
|
3254
|
+
"name": "--mdc-input-text-color"
|
3255
3255
|
},
|
3256
3256
|
{
|
3257
|
-
"description": "
|
3258
|
-
"name": "--mdc-
|
3257
|
+
"description": "Background color for the input field",
|
3258
|
+
"name": "--mdc-input-background-color"
|
3259
3259
|
},
|
3260
3260
|
{
|
3261
|
-
"description": "
|
3262
|
-
"name": "--mdc-
|
3261
|
+
"description": "Background color for the selected text",
|
3262
|
+
"name": "--mdc-input-selection-background-color"
|
3263
3263
|
},
|
3264
3264
|
{
|
3265
|
-
"description": "Text
|
3266
|
-
"name": "--mdc-
|
3265
|
+
"description": "Text color for the selected text",
|
3266
|
+
"name": "--mdc-input-selection-text-color"
|
3267
3267
|
},
|
3268
3268
|
{
|
3269
|
-
"description": "Text
|
3270
|
-
"name": "--mdc-
|
3269
|
+
"description": "Text color for the help text",
|
3270
|
+
"name": "--mdc-input-support-text-color"
|
3271
3271
|
},
|
3272
3272
|
{
|
3273
|
-
"description": "
|
3274
|
-
"name": "--mdc-
|
3273
|
+
"description": "Background color for the input field when hovered",
|
3274
|
+
"name": "--mdc-input-hover-background-color"
|
3275
3275
|
},
|
3276
3276
|
{
|
3277
|
-
"description": "
|
3278
|
-
"name": "--mdc-
|
3277
|
+
"description": "Background color for the input field when focused",
|
3278
|
+
"name": "--mdc-input-focused-background-color"
|
3279
|
+
},
|
3280
|
+
{
|
3281
|
+
"description": "Border color for the input container when focused",
|
3282
|
+
"name": "--mdc-input-focused-border-color"
|
3283
|
+
},
|
3284
|
+
{
|
3285
|
+
"description": "Border color for the input container when error",
|
3286
|
+
"name": "--mdc-input-error-border-color"
|
3287
|
+
},
|
3288
|
+
{
|
3289
|
+
"description": "Border color for the input container when warning",
|
3290
|
+
"name": "--mdc-input-warning-border-color"
|
3291
|
+
},
|
3292
|
+
{
|
3293
|
+
"description": "Border color for the input container when success",
|
3294
|
+
"name": "--mdc-input-success-border-color"
|
3295
|
+
},
|
3296
|
+
{
|
3297
|
+
"description": "Border color for the input container when primary",
|
3298
|
+
"name": "--mdc-input-primary-border-color"
|
3279
3299
|
}
|
3280
3300
|
],
|
3281
3301
|
"members": [
|
3282
3302
|
{
|
3283
3303
|
"kind": "field",
|
3284
|
-
"name": "
|
3304
|
+
"name": "placeholder",
|
3285
3305
|
"type": {
|
3286
|
-
"text": "
|
3306
|
+
"text": "string"
|
3287
3307
|
},
|
3288
|
-
"
|
3289
|
-
"
|
3308
|
+
"default": "''",
|
3309
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
3310
|
+
"attribute": "placeholder"
|
3290
3311
|
},
|
3291
3312
|
{
|
3292
3313
|
"kind": "field",
|
3293
|
-
"name": "
|
3314
|
+
"name": "required",
|
3294
3315
|
"type": {
|
3295
3316
|
"text": "boolean"
|
3296
3317
|
},
|
3297
|
-
"description": "The link can be inline or standalone.",
|
3298
3318
|
"default": "false",
|
3299
|
-
"
|
3300
|
-
"
|
3319
|
+
"description": "required attribute of the input field.\nIf true, the consumer should indicate it on the label that the input field is required.",
|
3320
|
+
"attribute": "required"
|
3301
3321
|
},
|
3302
3322
|
{
|
3303
3323
|
"kind": "field",
|
3304
|
-
"name": "
|
3324
|
+
"name": "readonly",
|
3305
3325
|
"type": {
|
3306
3326
|
"text": "boolean"
|
3307
3327
|
},
|
3308
|
-
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
3309
3328
|
"default": "false",
|
3310
|
-
"
|
3311
|
-
"
|
3329
|
+
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
3330
|
+
"attribute": "readonly"
|
3312
3331
|
},
|
3313
3332
|
{
|
3314
3333
|
"kind": "field",
|
3315
|
-
"name": "
|
3334
|
+
"name": "prefixText",
|
3316
3335
|
"type": {
|
3317
|
-
"text": "
|
3336
|
+
"text": "string | undefined"
|
3318
3337
|
},
|
3319
|
-
"description": "
|
3320
|
-
"
|
3321
|
-
"attribute": "size",
|
3322
|
-
"reflects": true
|
3338
|
+
"description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
|
3339
|
+
"attribute": "prefix-text"
|
3323
3340
|
},
|
3324
3341
|
{
|
3325
|
-
"kind": "
|
3326
|
-
"name": "
|
3327
|
-
"
|
3328
|
-
|
3329
|
-
"type": {
|
3330
|
-
"text": ""
|
3331
|
-
}
|
3342
|
+
"kind": "field",
|
3343
|
+
"name": "leadingIcon",
|
3344
|
+
"type": {
|
3345
|
+
"text": "IconNames | undefined"
|
3332
3346
|
},
|
3333
|
-
"description": "
|
3334
|
-
|
3335
|
-
{
|
3336
|
-
"kind": "method",
|
3337
|
-
"name": "setDisabled",
|
3338
|
-
"privacy": "private",
|
3339
|
-
"parameters": [
|
3340
|
-
{
|
3341
|
-
"name": "disabled",
|
3342
|
-
"type": {
|
3343
|
-
"text": "boolean"
|
3344
|
-
},
|
3345
|
-
"description": "The disabled state of icon"
|
3346
|
-
}
|
3347
|
-
],
|
3348
|
-
"description": "Updates the tabindex of the host element to disable or enable the link.\nWhen disabled, the link is not focusable or clickable, and tabindex is set to -1\nand aria-disabled attribute is set to true\nWhen link is not disabled, the previous tabindex of the host element is restored\nand aria-disabled attribute is removed."
|
3349
|
-
},
|
3350
|
-
{
|
3351
|
-
"kind": "method",
|
3352
|
-
"name": "updateTrailingIcon",
|
3353
|
-
"privacy": "private",
|
3354
|
-
"description": "Method to create and append trailing icon to the first anchor element in the slot.\nIf no icon name is provided, no icon will be rendered."
|
3347
|
+
"description": "The leading icon that is displayed before the input field.",
|
3348
|
+
"attribute": "leading-icon"
|
3355
3349
|
},
|
3356
3350
|
{
|
3357
3351
|
"kind": "field",
|
3358
|
-
"name": "
|
3352
|
+
"name": "trailingButton",
|
3359
3353
|
"type": {
|
3360
3354
|
"text": "boolean"
|
3361
3355
|
},
|
3362
3356
|
"default": "false",
|
3363
|
-
"description": "
|
3364
|
-
"attribute": "
|
3365
|
-
|
3366
|
-
"inheritedFrom": {
|
3367
|
-
"name": "DisabledMixin",
|
3368
|
-
"module": "utils/mixins/DisabledMixin.js"
|
3369
|
-
}
|
3370
|
-
}
|
3371
|
-
],
|
3372
|
-
"attributes": [
|
3357
|
+
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
3358
|
+
"attribute": "trailing-button"
|
3359
|
+
},
|
3373
3360
|
{
|
3374
|
-
"
|
3361
|
+
"kind": "field",
|
3362
|
+
"name": "maxlength",
|
3375
3363
|
"type": {
|
3376
|
-
"text": "
|
3364
|
+
"text": "number | undefined"
|
3377
3365
|
},
|
3378
|
-
"description": "
|
3379
|
-
"
|
3366
|
+
"description": "The maximum number of characters that the input field can accept.",
|
3367
|
+
"attribute": "maxlength"
|
3380
3368
|
},
|
3381
3369
|
{
|
3382
|
-
"
|
3370
|
+
"kind": "field",
|
3371
|
+
"name": "minlength",
|
3383
3372
|
"type": {
|
3384
|
-
"text": "
|
3373
|
+
"text": "number | undefined"
|
3385
3374
|
},
|
3386
|
-
"description": "The
|
3387
|
-
"
|
3388
|
-
"fieldName": "inline"
|
3375
|
+
"description": "The minimum number of characters that the input field can accept.",
|
3376
|
+
"attribute": "minlength"
|
3389
3377
|
},
|
3390
3378
|
{
|
3391
|
-
"
|
3379
|
+
"kind": "field",
|
3380
|
+
"name": "autocapitalize",
|
3392
3381
|
"type": {
|
3393
|
-
"text": "
|
3382
|
+
"text": "AutoCapitalizeType"
|
3394
3383
|
},
|
3395
|
-
"description": "The
|
3396
|
-
"default": "
|
3397
|
-
"
|
3384
|
+
"description": "The autocapitalize attribute of the input field.",
|
3385
|
+
"default": "'off'",
|
3386
|
+
"attribute": "autocapitalize"
|
3398
3387
|
},
|
3399
3388
|
{
|
3400
|
-
"
|
3389
|
+
"kind": "field",
|
3390
|
+
"name": "autocomplete",
|
3401
3391
|
"type": {
|
3402
|
-
"text": "
|
3392
|
+
"text": "any"
|
3403
3393
|
},
|
3404
|
-
"
|
3405
|
-
"
|
3406
|
-
"
|
3394
|
+
"default": "'off'",
|
3395
|
+
"description": "The autocomplete attribute of the input field.",
|
3396
|
+
"attribute": "autocomplete"
|
3407
3397
|
},
|
3408
3398
|
{
|
3409
|
-
"
|
3399
|
+
"kind": "field",
|
3400
|
+
"name": "autofocus",
|
3410
3401
|
"type": {
|
3411
3402
|
"text": "boolean"
|
3412
3403
|
},
|
3413
3404
|
"default": "false",
|
3414
|
-
"description": "
|
3415
|
-
"
|
3416
|
-
"inheritedFrom": {
|
3417
|
-
"name": "DisabledMixin",
|
3418
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
3419
|
-
}
|
3420
|
-
}
|
3421
|
-
],
|
3422
|
-
"mixins": [
|
3423
|
-
{
|
3424
|
-
"name": "DisabledMixin",
|
3425
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
3426
|
-
}
|
3427
|
-
],
|
3428
|
-
"superclass": {
|
3429
|
-
"name": "Component",
|
3430
|
-
"module": "/src/models"
|
3431
|
-
},
|
3432
|
-
"tagName": "mdc-link",
|
3433
|
-
"jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be an anchor element\n * containing the text, href, and other attributes.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link\n * @cssproperty --mdc-link-color-active - Text and icon color of the link in active state\n * @cssproperty --mdc-link-color-disabled - Text and icon color of the link in disabled state\n * @cssproperty --mdc-link-color-hover - Text and icon color of the link in hover state\n * @cssproperty --mdc-link-color-normal - Text and icon color of the link in normal state\n * @cssproperty --mdc-link-icon-margin-left - Gap between the text and icon (only applicable when an icon is set)\n * @cssproperty --mdc-link-inverted-color-active - Text and icon color of the inverted link in active state\n * @cssproperty --mdc-link-inverted-color-disabled - Text and icon color of the inverted link in disabled state\n * @cssproperty --mdc-link-inverted-color-hover - Text and icon color of the inverted link in hover state\n * @cssproperty --mdc-link-inverted-color-normal - Text and icon color of the inverted link in normal state\n * @cssproperty --mdc-link-text-decoration-disabled - Text decoration of the link in disabled state for all variants\n */",
|
3434
|
-
"customElement": true
|
3435
|
-
}
|
3436
|
-
],
|
3437
|
-
"exports": [
|
3438
|
-
{
|
3439
|
-
"kind": "js",
|
3440
|
-
"name": "default",
|
3441
|
-
"declaration": {
|
3442
|
-
"name": "Link",
|
3443
|
-
"module": "components/link/link.component.js"
|
3444
|
-
}
|
3445
|
-
}
|
3446
|
-
]
|
3447
|
-
},
|
3448
|
-
{
|
3449
|
-
"kind": "javascript-module",
|
3450
|
-
"path": "components/marker/marker.component.js",
|
3451
|
-
"declarations": [
|
3452
|
-
{
|
3453
|
-
"kind": "class",
|
3454
|
-
"description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
3455
|
-
"name": "Marker",
|
3456
|
-
"cssProperties": [
|
3457
|
-
{
|
3458
|
-
"description": "Allows customization of the default background color in solid variant.",
|
3459
|
-
"name": "--mdc-marker-solid-background-color"
|
3405
|
+
"description": "If true, the input field is focused when the component is rendered.",
|
3406
|
+
"attribute": "autofocus"
|
3460
3407
|
},
|
3461
3408
|
{
|
3462
|
-
"
|
3463
|
-
"name": "
|
3409
|
+
"kind": "field",
|
3410
|
+
"name": "dirname",
|
3411
|
+
"type": {
|
3412
|
+
"text": "string | undefined"
|
3413
|
+
},
|
3414
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
3415
|
+
"attribute": "dirname"
|
3464
3416
|
},
|
3465
3417
|
{
|
3466
|
-
"
|
3467
|
-
"name": "
|
3418
|
+
"kind": "field",
|
3419
|
+
"name": "pattern",
|
3420
|
+
"type": {
|
3421
|
+
"text": "string | undefined"
|
3422
|
+
},
|
3423
|
+
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
3424
|
+
"attribute": "pattern"
|
3468
3425
|
},
|
3469
|
-
{
|
3470
|
-
"description": "Allows customization of the default width.",
|
3471
|
-
"name": "--mdc-marker-width"
|
3472
|
-
}
|
3473
|
-
],
|
3474
|
-
"members": [
|
3475
3426
|
{
|
3476
3427
|
"kind": "field",
|
3477
|
-
"name": "
|
3428
|
+
"name": "list",
|
3429
|
+
"type": {
|
3430
|
+
"text": "string | undefined"
|
3431
|
+
},
|
3432
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
3433
|
+
"attribute": "list"
|
3434
|
+
},
|
3435
|
+
{
|
3436
|
+
"kind": "field",
|
3437
|
+
"name": "size",
|
3438
|
+
"type": {
|
3439
|
+
"text": "number | undefined | undefined"
|
3440
|
+
},
|
3441
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
3442
|
+
"default": "undefined",
|
3443
|
+
"attribute": "size"
|
3444
|
+
},
|
3445
|
+
{
|
3446
|
+
"kind": "field",
|
3447
|
+
"name": "clearAriaLabel",
|
3448
|
+
"type": {
|
3449
|
+
"text": "string"
|
3450
|
+
},
|
3451
|
+
"default": "''",
|
3452
|
+
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
3453
|
+
"attribute": "clear-aria-label"
|
3454
|
+
},
|
3455
|
+
{
|
3456
|
+
"kind": "method",
|
3457
|
+
"name": "checkValidity",
|
3458
|
+
"return": {
|
3459
|
+
"type": {
|
3460
|
+
"text": "boolean"
|
3461
|
+
}
|
3462
|
+
}
|
3463
|
+
},
|
3464
|
+
{
|
3465
|
+
"kind": "method",
|
3466
|
+
"name": "reportValidity"
|
3467
|
+
},
|
3468
|
+
{
|
3469
|
+
"kind": "method",
|
3470
|
+
"name": "handleValueChange",
|
3471
|
+
"description": "Handles the value change of the input field.\nSets the form value and updates the validity of the input field.",
|
3472
|
+
"return": {
|
3473
|
+
"type": {
|
3474
|
+
"text": ""
|
3475
|
+
}
|
3476
|
+
}
|
3477
|
+
},
|
3478
|
+
{
|
3479
|
+
"kind": "method",
|
3480
|
+
"name": "setValidityFromInput",
|
3481
|
+
"privacy": "private",
|
3482
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
3483
|
+
"return": {
|
3484
|
+
"type": {
|
3485
|
+
"text": ""
|
3486
|
+
}
|
3487
|
+
}
|
3488
|
+
},
|
3489
|
+
{
|
3490
|
+
"kind": "method",
|
3491
|
+
"name": "updateValue",
|
3492
|
+
"privacy": "private",
|
3493
|
+
"description": "Updates the value of the input field.\nSets the form value.",
|
3494
|
+
"return": {
|
3495
|
+
"type": {
|
3496
|
+
"text": ""
|
3497
|
+
}
|
3498
|
+
}
|
3499
|
+
},
|
3500
|
+
{
|
3501
|
+
"kind": "method",
|
3502
|
+
"name": "onInput",
|
3503
|
+
"privacy": "private",
|
3504
|
+
"description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field."
|
3505
|
+
},
|
3506
|
+
{
|
3507
|
+
"kind": "method",
|
3508
|
+
"name": "onChange",
|
3509
|
+
"privacy": "private",
|
3510
|
+
"parameters": [
|
3511
|
+
{
|
3512
|
+
"name": "event",
|
3513
|
+
"type": {
|
3514
|
+
"text": "Event"
|
3515
|
+
},
|
3516
|
+
"description": "Event which contains information about the value change."
|
3517
|
+
}
|
3518
|
+
],
|
3519
|
+
"description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
|
3520
|
+
},
|
3521
|
+
{
|
3522
|
+
"kind": "method",
|
3523
|
+
"name": "renderLeadingIcon",
|
3524
|
+
"privacy": "protected",
|
3525
|
+
"description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
|
3526
|
+
"return": {
|
3527
|
+
"type": {
|
3528
|
+
"text": ""
|
3529
|
+
}
|
3530
|
+
}
|
3531
|
+
},
|
3532
|
+
{
|
3533
|
+
"kind": "method",
|
3534
|
+
"name": "renderPrefixText",
|
3535
|
+
"privacy": "protected",
|
3536
|
+
"description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
|
3537
|
+
"return": {
|
3538
|
+
"type": {
|
3539
|
+
"text": ""
|
3540
|
+
}
|
3541
|
+
}
|
3542
|
+
},
|
3543
|
+
{
|
3544
|
+
"kind": "method",
|
3545
|
+
"name": "clearInputText",
|
3546
|
+
"privacy": "private",
|
3547
|
+
"description": "Clears the input field."
|
3548
|
+
},
|
3549
|
+
{
|
3550
|
+
"kind": "method",
|
3551
|
+
"name": "renderTrailingButton",
|
3552
|
+
"privacy": "protected",
|
3553
|
+
"description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
|
3554
|
+
"return": {
|
3555
|
+
"type": {
|
3556
|
+
"text": ""
|
3557
|
+
}
|
3558
|
+
}
|
3559
|
+
},
|
3560
|
+
{
|
3561
|
+
"kind": "field",
|
3562
|
+
"name": "dataAriaLabel",
|
3563
|
+
"type": {
|
3564
|
+
"text": "string | null"
|
3565
|
+
},
|
3566
|
+
"default": "null",
|
3567
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
3568
|
+
"attribute": "data-aria-label",
|
3569
|
+
"reflects": true,
|
3570
|
+
"inheritedFrom": {
|
3571
|
+
"name": "DataAriaLabelMixin",
|
3572
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
3573
|
+
}
|
3574
|
+
},
|
3575
|
+
{
|
3576
|
+
"kind": "field",
|
3577
|
+
"name": "value",
|
3578
|
+
"type": {
|
3579
|
+
"text": "string"
|
3580
|
+
},
|
3581
|
+
"default": "''",
|
3582
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
3583
|
+
"attribute": "value",
|
3584
|
+
"reflects": true,
|
3585
|
+
"inheritedFrom": {
|
3586
|
+
"name": "ValueMixin",
|
3587
|
+
"module": "utils/mixins/ValueMixin.js"
|
3588
|
+
}
|
3589
|
+
},
|
3590
|
+
{
|
3591
|
+
"kind": "field",
|
3592
|
+
"name": "name",
|
3593
|
+
"type": {
|
3594
|
+
"text": "string"
|
3595
|
+
},
|
3596
|
+
"default": "''",
|
3597
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
3598
|
+
"attribute": "name",
|
3599
|
+
"reflects": true,
|
3600
|
+
"inheritedFrom": {
|
3601
|
+
"name": "NameMixin",
|
3602
|
+
"module": "utils/mixins/NameMixin.js"
|
3603
|
+
}
|
3604
|
+
},
|
3605
|
+
{
|
3606
|
+
"kind": "field",
|
3607
|
+
"name": "disabled",
|
3608
|
+
"type": {
|
3609
|
+
"text": "boolean"
|
3610
|
+
},
|
3611
|
+
"default": "false",
|
3612
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3613
|
+
"attribute": "disabled",
|
3614
|
+
"reflects": true,
|
3615
|
+
"inheritedFrom": {
|
3616
|
+
"name": "FormfieldWrapper",
|
3617
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3618
|
+
}
|
3619
|
+
},
|
3620
|
+
{
|
3621
|
+
"kind": "field",
|
3622
|
+
"name": "label",
|
3623
|
+
"type": {
|
3624
|
+
"text": "string | undefined"
|
3625
|
+
},
|
3626
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3627
|
+
"attribute": "label",
|
3628
|
+
"reflects": true,
|
3629
|
+
"inheritedFrom": {
|
3630
|
+
"name": "FormfieldWrapper",
|
3631
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3632
|
+
}
|
3633
|
+
},
|
3634
|
+
{
|
3635
|
+
"kind": "field",
|
3636
|
+
"name": "id",
|
3637
|
+
"default": "`mdc-input-${uuidv4()}`",
|
3638
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3639
|
+
"attribute": "id",
|
3640
|
+
"inheritedFrom": {
|
3641
|
+
"name": "FormfieldWrapper",
|
3642
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3643
|
+
}
|
3644
|
+
},
|
3645
|
+
{
|
3646
|
+
"kind": "field",
|
3647
|
+
"name": "helpTextType",
|
3648
|
+
"type": {
|
3649
|
+
"text": "ValidationType"
|
3650
|
+
},
|
3651
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3652
|
+
"attribute": "help-text-type",
|
3653
|
+
"reflects": true,
|
3654
|
+
"inheritedFrom": {
|
3655
|
+
"name": "FormfieldWrapper",
|
3656
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3657
|
+
}
|
3658
|
+
},
|
3659
|
+
{
|
3660
|
+
"kind": "field",
|
3661
|
+
"name": "helpText",
|
3662
|
+
"type": {
|
3663
|
+
"text": "string | undefined"
|
3664
|
+
},
|
3665
|
+
"description": "The help text that is displayed below the input field.",
|
3666
|
+
"attribute": "help-text",
|
3667
|
+
"reflects": true,
|
3668
|
+
"inheritedFrom": {
|
3669
|
+
"name": "FormfieldWrapper",
|
3670
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3671
|
+
}
|
3672
|
+
},
|
3673
|
+
{
|
3674
|
+
"kind": "method",
|
3675
|
+
"name": "renderLabelElement",
|
3676
|
+
"privacy": "protected",
|
3677
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
3678
|
+
"return": {
|
3679
|
+
"type": {
|
3680
|
+
"text": ""
|
3681
|
+
}
|
3682
|
+
},
|
3683
|
+
"inheritedFrom": {
|
3684
|
+
"name": "FormfieldWrapper",
|
3685
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3686
|
+
}
|
3687
|
+
},
|
3688
|
+
{
|
3689
|
+
"kind": "method",
|
3690
|
+
"name": "renderHelpTextIcon",
|
3691
|
+
"privacy": "protected",
|
3692
|
+
"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.",
|
3693
|
+
"return": {
|
3694
|
+
"type": {
|
3695
|
+
"text": ""
|
3696
|
+
}
|
3697
|
+
},
|
3698
|
+
"inheritedFrom": {
|
3699
|
+
"name": "FormfieldWrapper",
|
3700
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3701
|
+
}
|
3702
|
+
},
|
3703
|
+
{
|
3704
|
+
"kind": "method",
|
3705
|
+
"name": "renderHelpText",
|
3706
|
+
"privacy": "protected",
|
3707
|
+
"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.",
|
3708
|
+
"return": {
|
3709
|
+
"type": {
|
3710
|
+
"text": ""
|
3711
|
+
}
|
3712
|
+
},
|
3713
|
+
"inheritedFrom": {
|
3714
|
+
"name": "FormfieldWrapper",
|
3715
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3716
|
+
}
|
3717
|
+
},
|
3718
|
+
{
|
3719
|
+
"kind": "method",
|
3720
|
+
"name": "renderLabel",
|
3721
|
+
"privacy": "protected",
|
3722
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
3723
|
+
"return": {
|
3724
|
+
"type": {
|
3725
|
+
"text": ""
|
3726
|
+
}
|
3727
|
+
},
|
3728
|
+
"inheritedFrom": {
|
3729
|
+
"name": "FormfieldWrapper",
|
3730
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3731
|
+
}
|
3732
|
+
},
|
3733
|
+
{
|
3734
|
+
"kind": "method",
|
3735
|
+
"name": "renderHelperText",
|
3736
|
+
"privacy": "protected",
|
3737
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
3738
|
+
"return": {
|
3739
|
+
"type": {
|
3740
|
+
"text": ""
|
3741
|
+
}
|
3742
|
+
},
|
3743
|
+
"inheritedFrom": {
|
3744
|
+
"name": "FormfieldWrapper",
|
3745
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
3746
|
+
}
|
3747
|
+
}
|
3748
|
+
],
|
3749
|
+
"events": [
|
3750
|
+
{
|
3751
|
+
"type": {
|
3752
|
+
"text": "EventConstructor"
|
3753
|
+
}
|
3754
|
+
}
|
3755
|
+
],
|
3756
|
+
"attributes": [
|
3757
|
+
{
|
3758
|
+
"name": "placeholder",
|
3759
|
+
"type": {
|
3760
|
+
"text": "string"
|
3761
|
+
},
|
3762
|
+
"default": "''",
|
3763
|
+
"description": "The placeholder text that is displayed when the input field is empty.",
|
3764
|
+
"fieldName": "placeholder"
|
3765
|
+
},
|
3766
|
+
{
|
3767
|
+
"name": "required",
|
3768
|
+
"type": {
|
3769
|
+
"text": "boolean"
|
3770
|
+
},
|
3771
|
+
"default": "false",
|
3772
|
+
"description": "required attribute of the input field.\nIf true, the consumer should indicate it on the label that the input field is required.",
|
3773
|
+
"fieldName": "required"
|
3774
|
+
},
|
3775
|
+
{
|
3776
|
+
"name": "readonly",
|
3777
|
+
"type": {
|
3778
|
+
"text": "boolean"
|
3779
|
+
},
|
3780
|
+
"default": "false",
|
3781
|
+
"description": "readonly attribute of the input field. If true, the input field is read-only.",
|
3782
|
+
"fieldName": "readonly"
|
3783
|
+
},
|
3784
|
+
{
|
3785
|
+
"name": "prefix-text",
|
3786
|
+
"type": {
|
3787
|
+
"text": "string | undefined"
|
3788
|
+
},
|
3789
|
+
"description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
|
3790
|
+
"fieldName": "prefixText"
|
3791
|
+
},
|
3792
|
+
{
|
3793
|
+
"name": "leading-icon",
|
3794
|
+
"type": {
|
3795
|
+
"text": "IconNames | undefined"
|
3796
|
+
},
|
3797
|
+
"description": "The leading icon that is displayed before the input field.",
|
3798
|
+
"fieldName": "leadingIcon"
|
3799
|
+
},
|
3800
|
+
{
|
3801
|
+
"name": "trailing-button",
|
3802
|
+
"type": {
|
3803
|
+
"text": "boolean"
|
3804
|
+
},
|
3805
|
+
"default": "false",
|
3806
|
+
"description": "The trailing button when set to true, shows a clear button that clears the input field.",
|
3807
|
+
"fieldName": "trailingButton"
|
3808
|
+
},
|
3809
|
+
{
|
3810
|
+
"name": "maxlength",
|
3811
|
+
"type": {
|
3812
|
+
"text": "number | undefined"
|
3813
|
+
},
|
3814
|
+
"description": "The maximum number of characters that the input field can accept.",
|
3815
|
+
"fieldName": "maxlength"
|
3816
|
+
},
|
3817
|
+
{
|
3818
|
+
"name": "minlength",
|
3819
|
+
"type": {
|
3820
|
+
"text": "number | undefined"
|
3821
|
+
},
|
3822
|
+
"description": "The minimum number of characters that the input field can accept.",
|
3823
|
+
"fieldName": "minlength"
|
3824
|
+
},
|
3825
|
+
{
|
3826
|
+
"name": "autocapitalize",
|
3827
|
+
"type": {
|
3828
|
+
"text": "AutoCapitalizeType"
|
3829
|
+
},
|
3830
|
+
"description": "The autocapitalize attribute of the input field.",
|
3831
|
+
"default": "'off'",
|
3832
|
+
"fieldName": "autocapitalize"
|
3833
|
+
},
|
3834
|
+
{
|
3835
|
+
"name": "autocomplete",
|
3836
|
+
"type": {
|
3837
|
+
"text": "any"
|
3838
|
+
},
|
3839
|
+
"default": "'off'",
|
3840
|
+
"description": "The autocomplete attribute of the input field.",
|
3841
|
+
"fieldName": "autocomplete"
|
3842
|
+
},
|
3843
|
+
{
|
3844
|
+
"name": "autofocus",
|
3845
|
+
"type": {
|
3846
|
+
"text": "boolean"
|
3847
|
+
},
|
3848
|
+
"default": "false",
|
3849
|
+
"description": "If true, the input field is focused when the component is rendered.",
|
3850
|
+
"fieldName": "autofocus"
|
3851
|
+
},
|
3852
|
+
{
|
3853
|
+
"name": "dirname",
|
3854
|
+
"type": {
|
3855
|
+
"text": "string | undefined"
|
3856
|
+
},
|
3857
|
+
"description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
|
3858
|
+
"fieldName": "dirname"
|
3859
|
+
},
|
3860
|
+
{
|
3861
|
+
"name": "pattern",
|
3862
|
+
"type": {
|
3863
|
+
"text": "string | undefined"
|
3864
|
+
},
|
3865
|
+
"description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
|
3866
|
+
"fieldName": "pattern"
|
3867
|
+
},
|
3868
|
+
{
|
3869
|
+
"name": "list",
|
3870
|
+
"type": {
|
3871
|
+
"text": "string | undefined"
|
3872
|
+
},
|
3873
|
+
"description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
|
3874
|
+
"fieldName": "list"
|
3875
|
+
},
|
3876
|
+
{
|
3877
|
+
"name": "size",
|
3878
|
+
"type": {
|
3879
|
+
"text": "number | undefined | undefined"
|
3880
|
+
},
|
3881
|
+
"description": "The size attribute of the input field.\nSpecifies the width of the input field.",
|
3882
|
+
"default": "undefined",
|
3883
|
+
"fieldName": "size"
|
3884
|
+
},
|
3885
|
+
{
|
3886
|
+
"name": "clear-aria-label",
|
3887
|
+
"type": {
|
3888
|
+
"text": "string"
|
3889
|
+
},
|
3890
|
+
"default": "''",
|
3891
|
+
"description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
|
3892
|
+
"fieldName": "clearAriaLabel"
|
3893
|
+
},
|
3894
|
+
{
|
3895
|
+
"name": "data-aria-label",
|
3896
|
+
"type": {
|
3897
|
+
"text": "string | null"
|
3898
|
+
},
|
3899
|
+
"default": "null",
|
3900
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
3901
|
+
"fieldName": "dataAriaLabel",
|
3902
|
+
"inheritedFrom": {
|
3903
|
+
"name": "DataAriaLabelMixin",
|
3904
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
3905
|
+
}
|
3906
|
+
},
|
3907
|
+
{
|
3908
|
+
"name": "value",
|
3909
|
+
"type": {
|
3910
|
+
"text": "string"
|
3911
|
+
},
|
3912
|
+
"default": "''",
|
3913
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
3914
|
+
"fieldName": "value",
|
3915
|
+
"inheritedFrom": {
|
3916
|
+
"name": "ValueMixin",
|
3917
|
+
"module": "src/utils/mixins/ValueMixin.ts"
|
3918
|
+
}
|
3919
|
+
},
|
3920
|
+
{
|
3921
|
+
"name": "name",
|
3922
|
+
"type": {
|
3923
|
+
"text": "string"
|
3924
|
+
},
|
3925
|
+
"default": "''",
|
3926
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
3927
|
+
"fieldName": "name",
|
3928
|
+
"inheritedFrom": {
|
3929
|
+
"name": "NameMixin",
|
3930
|
+
"module": "src/utils/mixins/NameMixin.ts"
|
3931
|
+
}
|
3932
|
+
},
|
3933
|
+
{
|
3934
|
+
"name": "disabled",
|
3935
|
+
"type": {
|
3936
|
+
"text": "boolean"
|
3937
|
+
},
|
3938
|
+
"default": "false",
|
3939
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3940
|
+
"fieldName": "disabled",
|
3941
|
+
"inheritedFrom": {
|
3942
|
+
"name": "FormfieldWrapper",
|
3943
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3944
|
+
}
|
3945
|
+
},
|
3946
|
+
{
|
3947
|
+
"name": "label",
|
3948
|
+
"type": {
|
3949
|
+
"text": "string | undefined"
|
3950
|
+
},
|
3951
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
3952
|
+
"fieldName": "label",
|
3953
|
+
"inheritedFrom": {
|
3954
|
+
"name": "FormfieldWrapper",
|
3955
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3956
|
+
}
|
3957
|
+
},
|
3958
|
+
{
|
3959
|
+
"name": "id",
|
3960
|
+
"default": "`mdc-input-${uuidv4()}`",
|
3961
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
3962
|
+
"fieldName": "id",
|
3963
|
+
"inheritedFrom": {
|
3964
|
+
"name": "FormfieldWrapper",
|
3965
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3966
|
+
}
|
3967
|
+
},
|
3968
|
+
{
|
3969
|
+
"name": "help-text-type",
|
3970
|
+
"type": {
|
3971
|
+
"text": "ValidationType"
|
3972
|
+
},
|
3973
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
3974
|
+
"fieldName": "helpTextType",
|
3975
|
+
"inheritedFrom": {
|
3976
|
+
"name": "FormfieldWrapper",
|
3977
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3978
|
+
}
|
3979
|
+
},
|
3980
|
+
{
|
3981
|
+
"name": "help-text",
|
3982
|
+
"type": {
|
3983
|
+
"text": "string | undefined"
|
3984
|
+
},
|
3985
|
+
"description": "The help text that is displayed below the input field.",
|
3986
|
+
"fieldName": "helpText",
|
3987
|
+
"inheritedFrom": {
|
3988
|
+
"name": "FormfieldWrapper",
|
3989
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
3990
|
+
}
|
3991
|
+
}
|
3992
|
+
],
|
3993
|
+
"mixins": [
|
3994
|
+
{
|
3995
|
+
"name": "DataAriaLabelMixin",
|
3996
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
3997
|
+
},
|
3998
|
+
{
|
3999
|
+
"name": "ValueMixin",
|
4000
|
+
"module": "/src/utils/mixins/ValueMixin"
|
4001
|
+
},
|
4002
|
+
{
|
4003
|
+
"name": "NameMixin",
|
4004
|
+
"module": "/src/utils/mixins/NameMixin"
|
4005
|
+
}
|
4006
|
+
],
|
4007
|
+
"superclass": {
|
4008
|
+
"name": "FormfieldWrapper",
|
4009
|
+
"module": "/src/components/formfieldwrapper"
|
4010
|
+
},
|
4011
|
+
"tagName": "mdc-input",
|
4012
|
+
"jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
|
4013
|
+
"customElement": true,
|
4014
|
+
"slots": [
|
4015
|
+
{
|
4016
|
+
"description": "slot to add the label info icon",
|
4017
|
+
"name": "label-info",
|
4018
|
+
"inheritedFrom": {
|
4019
|
+
"name": "FormfieldWrapper",
|
4020
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
4021
|
+
}
|
4022
|
+
}
|
4023
|
+
]
|
4024
|
+
}
|
4025
|
+
],
|
4026
|
+
"exports": [
|
4027
|
+
{
|
4028
|
+
"kind": "js",
|
4029
|
+
"name": "default",
|
4030
|
+
"declaration": {
|
4031
|
+
"name": "Input",
|
4032
|
+
"module": "components/input/input.component.js"
|
4033
|
+
}
|
4034
|
+
}
|
4035
|
+
]
|
4036
|
+
},
|
4037
|
+
{
|
4038
|
+
"kind": "javascript-module",
|
4039
|
+
"path": "components/link/link.component.js",
|
4040
|
+
"declarations": [
|
4041
|
+
{
|
4042
|
+
"kind": "class",
|
4043
|
+
"description": "`mdc-link` component can be used to navigate to a different page\nwithin the application or to an external site. It can be used to link to\nemails or phone numbers.\n\nThe `children` of the link component is expected to be an anchor element\ncontaining the text, href, and other attributes.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.",
|
4044
|
+
"name": "Link",
|
4045
|
+
"cssProperties": [
|
4046
|
+
{
|
4047
|
+
"description": "Border radius of the link",
|
4048
|
+
"name": "--mdc-link-border-radius"
|
4049
|
+
},
|
4050
|
+
{
|
4051
|
+
"description": "Text and icon color of the link in active state",
|
4052
|
+
"name": "--mdc-link-color-active"
|
4053
|
+
},
|
4054
|
+
{
|
4055
|
+
"description": "Text and icon color of the link in disabled state",
|
4056
|
+
"name": "--mdc-link-color-disabled"
|
4057
|
+
},
|
4058
|
+
{
|
4059
|
+
"description": "Text and icon color of the link in hover state",
|
4060
|
+
"name": "--mdc-link-color-hover"
|
4061
|
+
},
|
4062
|
+
{
|
4063
|
+
"description": "Text and icon color of the link in normal state",
|
4064
|
+
"name": "--mdc-link-color-normal"
|
4065
|
+
},
|
4066
|
+
{
|
4067
|
+
"description": "Gap between the text and icon (only applicable when an icon is set)",
|
4068
|
+
"name": "--mdc-link-icon-margin-left"
|
4069
|
+
},
|
4070
|
+
{
|
4071
|
+
"description": "Text and icon color of the inverted link in active state",
|
4072
|
+
"name": "--mdc-link-inverted-color-active"
|
4073
|
+
},
|
4074
|
+
{
|
4075
|
+
"description": "Text and icon color of the inverted link in disabled state",
|
4076
|
+
"name": "--mdc-link-inverted-color-disabled"
|
4077
|
+
},
|
4078
|
+
{
|
4079
|
+
"description": "Text and icon color of the inverted link in hover state",
|
4080
|
+
"name": "--mdc-link-inverted-color-hover"
|
4081
|
+
},
|
4082
|
+
{
|
4083
|
+
"description": "Text and icon color of the inverted link in normal state",
|
4084
|
+
"name": "--mdc-link-inverted-color-normal"
|
4085
|
+
},
|
4086
|
+
{
|
4087
|
+
"description": "Text decoration of the link in disabled state for all variants",
|
4088
|
+
"name": "--mdc-link-text-decoration-disabled"
|
4089
|
+
}
|
4090
|
+
],
|
4091
|
+
"members": [
|
4092
|
+
{
|
4093
|
+
"kind": "field",
|
4094
|
+
"name": "iconName",
|
4095
|
+
"type": {
|
4096
|
+
"text": "IconNames | undefined"
|
4097
|
+
},
|
4098
|
+
"description": "Name of the icon (= filename) to be used as trailing icon for link.\n\nIf no `icon` is provided, no icon will be rendered.",
|
4099
|
+
"attribute": "icon-name"
|
4100
|
+
},
|
4101
|
+
{
|
4102
|
+
"kind": "field",
|
4103
|
+
"name": "inline",
|
4104
|
+
"type": {
|
4105
|
+
"text": "boolean"
|
4106
|
+
},
|
4107
|
+
"description": "The link can be inline or standalone.",
|
4108
|
+
"default": "false",
|
4109
|
+
"attribute": "inline",
|
4110
|
+
"reflects": true
|
4111
|
+
},
|
4112
|
+
{
|
4113
|
+
"kind": "field",
|
4114
|
+
"name": "inverted",
|
4115
|
+
"type": {
|
4116
|
+
"text": "boolean"
|
4117
|
+
},
|
4118
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
4119
|
+
"default": "false",
|
4120
|
+
"attribute": "inverted",
|
4121
|
+
"reflects": true
|
4122
|
+
},
|
4123
|
+
{
|
4124
|
+
"kind": "field",
|
4125
|
+
"name": "size",
|
4126
|
+
"type": {
|
4127
|
+
"text": "LinkSize"
|
4128
|
+
},
|
4129
|
+
"description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
|
4130
|
+
"default": "large",
|
4131
|
+
"attribute": "size",
|
4132
|
+
"reflects": true
|
4133
|
+
},
|
4134
|
+
{
|
4135
|
+
"kind": "method",
|
4136
|
+
"name": "getIconSize",
|
4137
|
+
"privacy": "private",
|
4138
|
+
"return": {
|
4139
|
+
"type": {
|
4140
|
+
"text": ""
|
4141
|
+
}
|
4142
|
+
},
|
4143
|
+
"description": "Method to get the size of the trailing icon based on the link size."
|
4144
|
+
},
|
4145
|
+
{
|
4146
|
+
"kind": "method",
|
4147
|
+
"name": "setDisabled",
|
4148
|
+
"privacy": "private",
|
4149
|
+
"parameters": [
|
4150
|
+
{
|
4151
|
+
"name": "disabled",
|
4152
|
+
"type": {
|
4153
|
+
"text": "boolean"
|
4154
|
+
},
|
4155
|
+
"description": "The disabled state of icon"
|
4156
|
+
}
|
4157
|
+
],
|
4158
|
+
"description": "Updates the tabindex of the host element to disable or enable the link.\nWhen disabled, the link is not focusable or clickable, and tabindex is set to -1\nand aria-disabled attribute is set to true\nWhen link is not disabled, the previous tabindex of the host element is restored\nand aria-disabled attribute is removed."
|
4159
|
+
},
|
4160
|
+
{
|
4161
|
+
"kind": "method",
|
4162
|
+
"name": "updateTrailingIcon",
|
4163
|
+
"privacy": "private",
|
4164
|
+
"description": "Method to create and append trailing icon to the first anchor element in the slot.\nIf no icon name is provided, no icon will be rendered."
|
4165
|
+
},
|
4166
|
+
{
|
4167
|
+
"kind": "field",
|
4168
|
+
"name": "disabled",
|
4169
|
+
"type": {
|
4170
|
+
"text": "boolean"
|
4171
|
+
},
|
4172
|
+
"default": "false",
|
4173
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
4174
|
+
"attribute": "disabled",
|
4175
|
+
"reflects": true,
|
4176
|
+
"inheritedFrom": {
|
4177
|
+
"name": "DisabledMixin",
|
4178
|
+
"module": "utils/mixins/DisabledMixin.js"
|
4179
|
+
}
|
4180
|
+
}
|
4181
|
+
],
|
4182
|
+
"attributes": [
|
4183
|
+
{
|
4184
|
+
"name": "icon-name",
|
4185
|
+
"type": {
|
4186
|
+
"text": "IconNames | undefined"
|
4187
|
+
},
|
4188
|
+
"description": "Name of the icon (= filename) to be used as trailing icon for link.\n\nIf no `icon` is provided, no icon will be rendered.",
|
4189
|
+
"fieldName": "iconName"
|
4190
|
+
},
|
4191
|
+
{
|
4192
|
+
"name": "inline",
|
4193
|
+
"type": {
|
4194
|
+
"text": "boolean"
|
4195
|
+
},
|
4196
|
+
"description": "The link can be inline or standalone.",
|
4197
|
+
"default": "false",
|
4198
|
+
"fieldName": "inline"
|
4199
|
+
},
|
4200
|
+
{
|
4201
|
+
"name": "inverted",
|
4202
|
+
"type": {
|
4203
|
+
"text": "boolean"
|
4204
|
+
},
|
4205
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
4206
|
+
"default": "false",
|
4207
|
+
"fieldName": "inverted"
|
4208
|
+
},
|
4209
|
+
{
|
4210
|
+
"name": "size",
|
4211
|
+
"type": {
|
4212
|
+
"text": "LinkSize"
|
4213
|
+
},
|
4214
|
+
"description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
|
4215
|
+
"default": "large",
|
4216
|
+
"fieldName": "size"
|
4217
|
+
},
|
4218
|
+
{
|
4219
|
+
"name": "disabled",
|
4220
|
+
"type": {
|
4221
|
+
"text": "boolean"
|
4222
|
+
},
|
4223
|
+
"default": "false",
|
4224
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
4225
|
+
"fieldName": "disabled",
|
4226
|
+
"inheritedFrom": {
|
4227
|
+
"name": "DisabledMixin",
|
4228
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
4229
|
+
}
|
4230
|
+
}
|
4231
|
+
],
|
4232
|
+
"mixins": [
|
4233
|
+
{
|
4234
|
+
"name": "DisabledMixin",
|
4235
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
4236
|
+
}
|
4237
|
+
],
|
4238
|
+
"superclass": {
|
4239
|
+
"name": "Component",
|
4240
|
+
"module": "/src/models"
|
4241
|
+
},
|
4242
|
+
"tagName": "mdc-link",
|
4243
|
+
"jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be an anchor element\n * containing the text, href, and other attributes.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link\n * @cssproperty --mdc-link-color-active - Text and icon color of the link in active state\n * @cssproperty --mdc-link-color-disabled - Text and icon color of the link in disabled state\n * @cssproperty --mdc-link-color-hover - Text and icon color of the link in hover state\n * @cssproperty --mdc-link-color-normal - Text and icon color of the link in normal state\n * @cssproperty --mdc-link-icon-margin-left - Gap between the text and icon (only applicable when an icon is set)\n * @cssproperty --mdc-link-inverted-color-active - Text and icon color of the inverted link in active state\n * @cssproperty --mdc-link-inverted-color-disabled - Text and icon color of the inverted link in disabled state\n * @cssproperty --mdc-link-inverted-color-hover - Text and icon color of the inverted link in hover state\n * @cssproperty --mdc-link-inverted-color-normal - Text and icon color of the inverted link in normal state\n * @cssproperty --mdc-link-text-decoration-disabled - Text decoration of the link in disabled state for all variants\n */",
|
4244
|
+
"customElement": true
|
4245
|
+
}
|
4246
|
+
],
|
4247
|
+
"exports": [
|
4248
|
+
{
|
4249
|
+
"kind": "js",
|
4250
|
+
"name": "default",
|
4251
|
+
"declaration": {
|
4252
|
+
"name": "Link",
|
4253
|
+
"module": "components/link/link.component.js"
|
4254
|
+
}
|
4255
|
+
}
|
4256
|
+
]
|
4257
|
+
},
|
4258
|
+
{
|
4259
|
+
"kind": "javascript-module",
|
4260
|
+
"path": "components/marker/marker.component.js",
|
4261
|
+
"declarations": [
|
4262
|
+
{
|
4263
|
+
"kind": "class",
|
4264
|
+
"description": "`mdc-marker`, which is a vertical line and\nused to draw attention to specific parts of\nthe content or to signify important information.\n\n**Marker Variants**:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
4265
|
+
"name": "Marker",
|
4266
|
+
"cssProperties": [
|
4267
|
+
{
|
4268
|
+
"description": "Allows customization of the default background color in solid variant.",
|
4269
|
+
"name": "--mdc-marker-solid-background-color"
|
4270
|
+
},
|
4271
|
+
{
|
4272
|
+
"description": "Allows customization of the default stripes in striped variant.",
|
4273
|
+
"name": "--mdc-marker-striped-color"
|
4274
|
+
},
|
4275
|
+
{
|
4276
|
+
"description": "Allows customization of the default background color in striped variant.",
|
4277
|
+
"name": "--mdc-marker-striped-background-color"
|
4278
|
+
},
|
4279
|
+
{
|
4280
|
+
"description": "Allows customization of the default width.",
|
4281
|
+
"name": "--mdc-marker-width"
|
4282
|
+
}
|
4283
|
+
],
|
4284
|
+
"members": [
|
4285
|
+
{
|
4286
|
+
"kind": "field",
|
4287
|
+
"name": "variant",
|
4288
|
+
"type": {
|
4289
|
+
"text": "MarkerVariants"
|
4290
|
+
},
|
4291
|
+
"privacy": "public",
|
4292
|
+
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
4293
|
+
"default": "solid",
|
4294
|
+
"attribute": "variant",
|
4295
|
+
"reflects": true
|
4296
|
+
}
|
4297
|
+
],
|
4298
|
+
"attributes": [
|
4299
|
+
{
|
4300
|
+
"name": "variant",
|
3478
4301
|
"type": {
|
3479
4302
|
"text": "MarkerVariants"
|
3480
4303
|
},
|
4304
|
+
"description": "There are two variants of markers, each with a width of 0.25rem:\n- **solid**: Solid marker.\n- **striped**: Striped marker.",
|
4305
|
+
"default": "solid",
|
4306
|
+
"fieldName": "variant"
|
4307
|
+
}
|
4308
|
+
],
|
4309
|
+
"superclass": {
|
4310
|
+
"name": "Component",
|
4311
|
+
"module": "/src/models"
|
4312
|
+
},
|
4313
|
+
"tagName": "mdc-marker",
|
4314
|
+
"jsDoc": "/**\n * `mdc-marker`, which is a vertical line and\n * used to draw attention to specific parts of\n * the content or to signify important information.\n *\n * **Marker Variants**:\n * - **solid**: Solid marker.\n * - **striped**: Striped marker.\n *\n * @tagname mdc-marker\n *\n * @cssproperty --mdc-marker-solid-background-color - Allows customization of the default background color\n * in solid variant.\n * @cssproperty --mdc-marker-striped-color - Allows customization of the default stripes in striped variant.\n * @cssproperty --mdc-marker-striped-background-color - Allows customization of the default background color\n * in striped variant.\n * @cssproperty --mdc-marker-width - Allows customization of the default width.\n */",
|
4315
|
+
"customElement": true
|
4316
|
+
}
|
4317
|
+
],
|
4318
|
+
"exports": [
|
4319
|
+
{
|
4320
|
+
"kind": "js",
|
4321
|
+
"name": "default",
|
4322
|
+
"declaration": {
|
4323
|
+
"name": "Marker",
|
4324
|
+
"module": "components/marker/marker.component.js"
|
4325
|
+
}
|
4326
|
+
}
|
4327
|
+
]
|
4328
|
+
},
|
4329
|
+
{
|
4330
|
+
"kind": "javascript-module",
|
4331
|
+
"path": "components/modalcontainer/modalcontainer.component.js",
|
4332
|
+
"declarations": [
|
4333
|
+
{
|
4334
|
+
"kind": "class",
|
4335
|
+
"description": "The `mdc-modalcontainer` component is an element used to\ndisplay a modal container that can further be used in popover.",
|
4336
|
+
"name": "Modalcontainer",
|
4337
|
+
"cssProperties": [
|
4338
|
+
{
|
4339
|
+
"description": "primary background color of the modalcontainer",
|
4340
|
+
"name": "--mdc-modalcontainer-primary-background-color"
|
4341
|
+
},
|
4342
|
+
{
|
4343
|
+
"description": "border color of the modalcontainer",
|
4344
|
+
"name": "--mdc-modalcontainer-border-color"
|
4345
|
+
},
|
4346
|
+
{
|
4347
|
+
"description": "inverted background color of the modalcontainer",
|
4348
|
+
"name": "--mdc-modalcontainer-inverted-background-color"
|
4349
|
+
},
|
4350
|
+
{
|
4351
|
+
"description": "inverted border color of the modalcontainer",
|
4352
|
+
"name": "--mdc-modalcontainer-inverted-border-color"
|
4353
|
+
},
|
4354
|
+
{
|
4355
|
+
"description": "inverted text color of the modalcontainer",
|
4356
|
+
"name": "--mdc-modalcontainer-inverted-text-color"
|
4357
|
+
}
|
4358
|
+
],
|
4359
|
+
"slots": [
|
4360
|
+
{
|
4361
|
+
"description": "Default slot for modal container",
|
4362
|
+
"name": ""
|
4363
|
+
}
|
4364
|
+
],
|
4365
|
+
"members": [
|
4366
|
+
{
|
4367
|
+
"kind": "field",
|
4368
|
+
"name": "color",
|
4369
|
+
"type": {
|
4370
|
+
"text": "ModalContainerColor"
|
4371
|
+
},
|
4372
|
+
"description": "Color of the modalcontainer\n- **tonal**\n- **contrast**",
|
4373
|
+
"default": "tonal",
|
4374
|
+
"attribute": "color",
|
4375
|
+
"reflects": true
|
4376
|
+
},
|
4377
|
+
{
|
4378
|
+
"kind": "field",
|
4379
|
+
"name": "elevation",
|
4380
|
+
"type": {
|
4381
|
+
"text": "ModalContainerElevation"
|
4382
|
+
},
|
4383
|
+
"description": "Elevation of the modalcontainer where each value corresponds to a different drop shadow.\n- **0**\n- **1**\n- **2**\n- **3**\n- **4**",
|
4384
|
+
"default": "0",
|
4385
|
+
"attribute": "elevation",
|
4386
|
+
"reflects": true
|
4387
|
+
},
|
4388
|
+
{
|
4389
|
+
"kind": "field",
|
4390
|
+
"name": "role",
|
4391
|
+
"type": {
|
4392
|
+
"text": "ModalContainerRole"
|
4393
|
+
},
|
4394
|
+
"description": "Role of the modalcontainer",
|
4395
|
+
"default": "dialog",
|
4396
|
+
"attribute": "role"
|
4397
|
+
}
|
4398
|
+
],
|
4399
|
+
"attributes": [
|
4400
|
+
{
|
4401
|
+
"name": "color",
|
4402
|
+
"type": {
|
4403
|
+
"text": "ModalContainerColor"
|
4404
|
+
},
|
4405
|
+
"description": "Color of the modalcontainer\n- **tonal**\n- **contrast**",
|
4406
|
+
"default": "tonal",
|
4407
|
+
"fieldName": "color"
|
4408
|
+
},
|
4409
|
+
{
|
4410
|
+
"name": "elevation",
|
4411
|
+
"type": {
|
4412
|
+
"text": "ModalContainerElevation"
|
4413
|
+
},
|
4414
|
+
"description": "Elevation of the modalcontainer where each value corresponds to a different drop shadow.\n- **0**\n- **1**\n- **2**\n- **3**\n- **4**",
|
4415
|
+
"default": "0",
|
4416
|
+
"fieldName": "elevation"
|
4417
|
+
},
|
4418
|
+
{
|
4419
|
+
"name": "role",
|
4420
|
+
"type": {
|
4421
|
+
"text": "ModalContainerRole"
|
4422
|
+
},
|
4423
|
+
"description": "Role of the modalcontainer",
|
4424
|
+
"default": "dialog",
|
4425
|
+
"fieldName": "role"
|
4426
|
+
}
|
4427
|
+
],
|
4428
|
+
"superclass": {
|
4429
|
+
"name": "Component",
|
4430
|
+
"module": "/src/models"
|
4431
|
+
},
|
4432
|
+
"tagName": "mdc-modalcontainer",
|
4433
|
+
"jsDoc": "/**\n * The `mdc-modalcontainer` component is an element used to\n * display a modal container that can further be used in popover.\n *\n * @tagname mdc-modalcontainer\n *\n * @cssproperty --mdc-modalcontainer-primary-background-color - primary background color of the modalcontainer\n * @cssproperty --mdc-modalcontainer-border-color - border color of the modalcontainer\n * @cssproperty --mdc-modalcontainer-inverted-background-color - inverted background color of the modalcontainer\n * @cssproperty --mdc-modalcontainer-inverted-border-color - inverted border color of the modalcontainer\n * @cssproperty --mdc-modalcontainer-inverted-text-color - inverted text color of the modalcontainer\n *\n * @slot - Default slot for modal container\n */",
|
4434
|
+
"customElement": true
|
4435
|
+
}
|
4436
|
+
],
|
4437
|
+
"exports": [
|
4438
|
+
{
|
4439
|
+
"kind": "js",
|
4440
|
+
"name": "default",
|
4441
|
+
"declaration": {
|
4442
|
+
"name": "Modalcontainer",
|
4443
|
+
"module": "components/modalcontainer/modalcontainer.component.js"
|
4444
|
+
}
|
4445
|
+
}
|
4446
|
+
]
|
4447
|
+
},
|
4448
|
+
{
|
4449
|
+
"kind": "javascript-module",
|
4450
|
+
"path": "components/presence/presence.component.js",
|
4451
|
+
"declarations": [
|
4452
|
+
{
|
4453
|
+
"kind": "class",
|
4454
|
+
"description": "The `mdc-presence` component is a versatile UI element used to\ndisplay the presence status of a user or entity within an avatar component.\n\nThis component is ideal for use within avatar UIs where the presence status\nneeds to be visually represented.",
|
4455
|
+
"name": "Presence",
|
4456
|
+
"cssProperties": [
|
4457
|
+
{
|
4458
|
+
"description": "The background color of the presence type active.",
|
4459
|
+
"name": "--mdc-presence-active-background-color"
|
4460
|
+
},
|
4461
|
+
{
|
4462
|
+
"description": "The background color of the presence type away.",
|
4463
|
+
"name": "--mdc-presence-away-background-color"
|
4464
|
+
},
|
4465
|
+
{
|
4466
|
+
"description": "The background color of the presence type away-calling.",
|
4467
|
+
"name": "--mdc-presence-away-calling-background-color"
|
4468
|
+
},
|
4469
|
+
{
|
4470
|
+
"description": "The background color of the presence type busy.",
|
4471
|
+
"name": "--mdc-presence-busy-background-color"
|
4472
|
+
},
|
4473
|
+
{
|
4474
|
+
"description": "The background color of the presence type dnd.",
|
4475
|
+
"name": "--mdc-presence-dnd-background-color"
|
4476
|
+
},
|
4477
|
+
{
|
4478
|
+
"description": "The background color of the presence type meeting.",
|
4479
|
+
"name": "--mdc-presence-meeting-background-color"
|
4480
|
+
},
|
4481
|
+
{
|
4482
|
+
"description": "The background color of the presence type on-call.",
|
4483
|
+
"name": "--mdc-presence-on-call-background-color"
|
4484
|
+
},
|
4485
|
+
{
|
4486
|
+
"description": "The background color of the presence type on-device.",
|
4487
|
+
"name": "--mdc-presence-on-device-background-color"
|
4488
|
+
},
|
4489
|
+
{
|
4490
|
+
"description": "The background color of the presence type on-mobile.",
|
4491
|
+
"name": "--mdc-presence-on-mobile-background-color"
|
4492
|
+
},
|
4493
|
+
{
|
4494
|
+
"description": "The background color of the presence type pause.",
|
4495
|
+
"name": "--mdc-presence-pause-background-color"
|
4496
|
+
},
|
4497
|
+
{
|
4498
|
+
"description": "The background color of the presence type pto.",
|
4499
|
+
"name": "--mdc-presence-pto-background-color"
|
4500
|
+
},
|
4501
|
+
{
|
4502
|
+
"description": "The background color of the presence type presenting.",
|
4503
|
+
"name": "--mdc-presence-presenting-background-color"
|
4504
|
+
},
|
4505
|
+
{
|
4506
|
+
"description": "The background color of the presence type quiet.",
|
4507
|
+
"name": "--mdc-presence-quiet-background-color"
|
4508
|
+
},
|
4509
|
+
{
|
4510
|
+
"description": "The background color of the presence type scheduled.",
|
4511
|
+
"name": "--mdc-presence-scheduled-background-color"
|
4512
|
+
},
|
4513
|
+
{
|
4514
|
+
"description": "The background color of the presence type overlay.",
|
4515
|
+
"name": "--mdc-presence-overlay-background-color"
|
4516
|
+
}
|
4517
|
+
],
|
4518
|
+
"members": [
|
4519
|
+
{
|
4520
|
+
"kind": "field",
|
4521
|
+
"name": "type",
|
4522
|
+
"type": {
|
4523
|
+
"text": "PresenceType"
|
4524
|
+
},
|
4525
|
+
"description": "Supported presence types:\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`",
|
4526
|
+
"default": "active",
|
4527
|
+
"attribute": "type",
|
4528
|
+
"reflects": true
|
4529
|
+
},
|
4530
|
+
{
|
4531
|
+
"kind": "field",
|
4532
|
+
"name": "size",
|
4533
|
+
"type": {
|
4534
|
+
"text": "PresenceSize"
|
4535
|
+
},
|
4536
|
+
"description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
|
4537
|
+
"default": "small",
|
4538
|
+
"attribute": "size",
|
4539
|
+
"reflects": true
|
4540
|
+
},
|
4541
|
+
{
|
4542
|
+
"kind": "field",
|
4543
|
+
"name": "iconSize",
|
4544
|
+
"privacy": "private",
|
4545
|
+
"description": "Get the size of the presence icon based on the given size type",
|
4546
|
+
"readonly": true
|
4547
|
+
},
|
4548
|
+
{
|
4549
|
+
"kind": "field",
|
4550
|
+
"name": "icon",
|
4551
|
+
"privacy": "private",
|
4552
|
+
"description": "Get the icon name based on the presence type",
|
4553
|
+
"readonly": true
|
4554
|
+
},
|
4555
|
+
{
|
4556
|
+
"kind": "method",
|
4557
|
+
"name": "handleOnLoad",
|
4558
|
+
"privacy": "private",
|
4559
|
+
"return": {
|
4560
|
+
"type": {
|
4561
|
+
"text": "void"
|
4562
|
+
}
|
4563
|
+
},
|
4564
|
+
"description": "Handles the successful load of an icon.\nSets the `currentIconType` property to match the `type` property."
|
4565
|
+
},
|
4566
|
+
{
|
4567
|
+
"kind": "method",
|
4568
|
+
"name": "handleOnError",
|
4569
|
+
"privacy": "private",
|
4570
|
+
"return": {
|
4571
|
+
"type": {
|
4572
|
+
"text": "void"
|
4573
|
+
}
|
4574
|
+
},
|
4575
|
+
"description": "Handles an error that occurs when loading an icon."
|
4576
|
+
}
|
4577
|
+
],
|
4578
|
+
"attributes": [
|
4579
|
+
{
|
4580
|
+
"name": "type",
|
4581
|
+
"type": {
|
4582
|
+
"text": "PresenceType"
|
4583
|
+
},
|
4584
|
+
"description": "Supported presence types:\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`",
|
4585
|
+
"default": "active",
|
4586
|
+
"fieldName": "type"
|
4587
|
+
},
|
4588
|
+
{
|
4589
|
+
"name": "size",
|
4590
|
+
"type": {
|
4591
|
+
"text": "PresenceSize"
|
4592
|
+
},
|
4593
|
+
"description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
|
4594
|
+
"default": "small",
|
4595
|
+
"fieldName": "size"
|
4596
|
+
}
|
4597
|
+
],
|
4598
|
+
"superclass": {
|
4599
|
+
"name": "Component",
|
4600
|
+
"module": "/src/models"
|
4601
|
+
},
|
4602
|
+
"tagName": "mdc-presence",
|
4603
|
+
"jsDoc": "/**\n * The `mdc-presence` component is a versatile UI element used to\n * display the presence status of a user or entity within an avatar component.\n *\n * This component is ideal for use within avatar UIs where the presence status\n * needs to be visually represented.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-presence\n *\n * @cssproperty --mdc-presence-active-background-color - The background color of the presence type active.\n * @cssproperty --mdc-presence-away-background-color - The background color of the presence type away.\n * @cssproperty --mdc-presence-away-calling-background-color - The background color of the presence type away-calling.\n * @cssproperty --mdc-presence-busy-background-color - The background color of the presence type busy.\n * @cssproperty --mdc-presence-dnd-background-color - The background color of the presence type dnd.\n * @cssproperty --mdc-presence-meeting-background-color - The background color of the presence type meeting.\n * @cssproperty --mdc-presence-on-call-background-color - The background color of the presence type on-call.\n * @cssproperty --mdc-presence-on-device-background-color - The background color of the presence type on-device.\n * @cssproperty --mdc-presence-on-mobile-background-color - The background color of the presence type on-mobile.\n * @cssproperty --mdc-presence-pause-background-color - The background color of the presence type pause.\n * @cssproperty --mdc-presence-pto-background-color - The background color of the presence type pto.\n * @cssproperty --mdc-presence-presenting-background-color - The background color of the presence type presenting.\n * @cssproperty --mdc-presence-quiet-background-color - The background color of the presence type quiet.\n * @cssproperty --mdc-presence-scheduled-background-color - The background color of the presence type scheduled.\n * @cssproperty --mdc-presence-overlay-background-color - The background color of the presence type overlay.\n */",
|
4604
|
+
"customElement": true
|
4605
|
+
}
|
4606
|
+
],
|
4607
|
+
"exports": [
|
4608
|
+
{
|
4609
|
+
"kind": "js",
|
4610
|
+
"name": "default",
|
4611
|
+
"declaration": {
|
4612
|
+
"name": "Presence",
|
4613
|
+
"module": "components/presence/presence.component.js"
|
4614
|
+
}
|
4615
|
+
}
|
4616
|
+
]
|
4617
|
+
},
|
4618
|
+
{
|
4619
|
+
"kind": "javascript-module",
|
4620
|
+
"path": "components/text/text.component.js",
|
4621
|
+
"declarations": [
|
4622
|
+
{
|
4623
|
+
"kind": "class",
|
4624
|
+
"description": "Text component for creating styled text elements.\nIt has to be mounted within the ThemeProvider to access color and font tokens.\n\nThe `type` attribute allows changing the text style.\nThe `tagname` attribute allows changing the tag name of the text element.\nThe default tag name is `p`.\n\nThe `tagname` attribute should be a valid HTML tag name.\nIf the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n\nThe styling is applied based on the `type` attribute.",
|
4625
|
+
"name": "Text",
|
4626
|
+
"cssParts": [
|
4627
|
+
{
|
4628
|
+
"description": "The text element",
|
4629
|
+
"name": "text"
|
4630
|
+
}
|
4631
|
+
],
|
4632
|
+
"slots": [
|
4633
|
+
{
|
4634
|
+
"description": "Default slot for text content",
|
4635
|
+
"name": ""
|
4636
|
+
}
|
4637
|
+
],
|
4638
|
+
"members": [
|
4639
|
+
{
|
4640
|
+
"kind": "field",
|
4641
|
+
"name": "type",
|
4642
|
+
"type": {
|
4643
|
+
"text": "TextType"
|
4644
|
+
},
|
3481
4645
|
"privacy": "public",
|
3482
|
-
"description": "
|
3483
|
-
"default": "
|
3484
|
-
"attribute": "
|
4646
|
+
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
4647
|
+
"default": "body-large-regular",
|
4648
|
+
"attribute": "type",
|
4649
|
+
"reflects": true
|
4650
|
+
},
|
4651
|
+
{
|
4652
|
+
"kind": "field",
|
4653
|
+
"name": "tagname",
|
4654
|
+
"type": {
|
4655
|
+
"text": "TagName | undefined"
|
4656
|
+
},
|
4657
|
+
"privacy": "public",
|
4658
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
4659
|
+
"attribute": "tagname",
|
3485
4660
|
"reflects": true
|
3486
4661
|
}
|
3487
4662
|
],
|
3488
4663
|
"attributes": [
|
3489
4664
|
{
|
3490
|
-
"name": "
|
4665
|
+
"name": "type",
|
3491
4666
|
"type": {
|
3492
|
-
"text": "
|
4667
|
+
"text": "TextType"
|
3493
4668
|
},
|
3494
|
-
"description": "
|
3495
|
-
"default": "
|
3496
|
-
"fieldName": "
|
4669
|
+
"description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
|
4670
|
+
"default": "body-large-regular",
|
4671
|
+
"fieldName": "type"
|
4672
|
+
},
|
4673
|
+
{
|
4674
|
+
"name": "tagname",
|
4675
|
+
"type": {
|
4676
|
+
"text": "TagName | undefined"
|
4677
|
+
},
|
4678
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
|
4679
|
+
"fieldName": "tagname"
|
3497
4680
|
}
|
3498
4681
|
],
|
3499
4682
|
"superclass": {
|
3500
4683
|
"name": "Component",
|
3501
4684
|
"module": "/src/models"
|
3502
4685
|
},
|
3503
|
-
"tagName": "mdc-
|
3504
|
-
"jsDoc": "/**\n *
|
4686
|
+
"tagName": "mdc-text",
|
4687
|
+
"jsDoc": "/**\n * Text component for creating styled text elements.\n * It has to be mounted within the ThemeProvider to access color and font tokens.\n *\n * The `type` attribute allows changing the text style.\n * The `tagname` attribute allows changing the tag name of the text element.\n * The default tag name is `p`.\n *\n * The `tagname` attribute should be a valid HTML tag name.\n * If the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n *\n * The styling is applied based on the `type` attribute.\n *\n * @tagname mdc-text\n * @slot - Default slot for text content\n *\n * @csspart text - The text element\n */",
|
3505
4688
|
"customElement": true
|
3506
4689
|
}
|
3507
4690
|
],
|
@@ -3510,117 +4693,96 @@
|
|
3510
4693
|
"kind": "js",
|
3511
4694
|
"name": "default",
|
3512
4695
|
"declaration": {
|
3513
|
-
"name": "
|
3514
|
-
"module": "components/
|
4696
|
+
"name": "Text",
|
4697
|
+
"module": "components/text/text.component.js"
|
3515
4698
|
}
|
3516
4699
|
}
|
3517
4700
|
]
|
3518
4701
|
},
|
3519
4702
|
{
|
3520
4703
|
"kind": "javascript-module",
|
3521
|
-
"path": "components/
|
4704
|
+
"path": "components/themeprovider/themeprovider.component.js",
|
3522
4705
|
"declarations": [
|
3523
4706
|
{
|
3524
4707
|
"kind": "class",
|
3525
|
-
"description": "
|
3526
|
-
"name": "
|
4708
|
+
"description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
|
4709
|
+
"name": "ThemeProvider",
|
3527
4710
|
"cssProperties": [
|
3528
4711
|
{
|
3529
|
-
"description": "
|
3530
|
-
"name": "--mdc-
|
3531
|
-
},
|
3532
|
-
{
|
3533
|
-
"description": "border color of the modalcontainer",
|
3534
|
-
"name": "--mdc-modalcontainer-border-color"
|
4712
|
+
"description": "Option to override the default color, default: color-theme-text-primary-normal",
|
4713
|
+
"name": "--mdc-themeprovider-color-default"
|
3535
4714
|
},
|
3536
4715
|
{
|
3537
|
-
"description": "
|
3538
|
-
"name": "--mdc-
|
4716
|
+
"description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
|
4717
|
+
"name": "--mdc-themeprovider-font-family"
|
3539
4718
|
},
|
3540
4719
|
{
|
3541
|
-
"description": "
|
3542
|
-
"name": "--mdc-
|
4720
|
+
"description": "Option to override the font weight, default: `400`",
|
4721
|
+
"name": "--mdc-themeprovider-font-weight"
|
3543
4722
|
},
|
3544
4723
|
{
|
3545
|
-
"description": "
|
3546
|
-
"name": "--mdc-
|
4724
|
+
"description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
|
4725
|
+
"name": "--mdc-themeprovider-letter-spacing-adjustment"
|
3547
4726
|
}
|
3548
4727
|
],
|
3549
4728
|
"slots": [
|
3550
4729
|
{
|
3551
|
-
"description": "
|
4730
|
+
"description": "children",
|
3552
4731
|
"name": ""
|
3553
4732
|
}
|
3554
4733
|
],
|
3555
4734
|
"members": [
|
3556
4735
|
{
|
3557
4736
|
"kind": "field",
|
3558
|
-
"name": "
|
3559
|
-
"
|
3560
|
-
|
3561
|
-
|
3562
|
-
"
|
3563
|
-
"default": "tonal",
|
3564
|
-
"attribute": "color",
|
3565
|
-
"reflects": true
|
4737
|
+
"name": "Context",
|
4738
|
+
"privacy": "public",
|
4739
|
+
"static": true,
|
4740
|
+
"description": "Context object of the ThemeProvider, to be consumed by child components",
|
4741
|
+
"readonly": true
|
3566
4742
|
},
|
3567
4743
|
{
|
3568
4744
|
"kind": "field",
|
3569
|
-
"name": "
|
4745
|
+
"name": "themeclass",
|
3570
4746
|
"type": {
|
3571
|
-
"text": "
|
4747
|
+
"text": "string"
|
3572
4748
|
},
|
3573
|
-
"description": "
|
3574
|
-
"
|
3575
|
-
"attribute": "elevation",
|
3576
|
-
"reflects": true
|
4749
|
+
"description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
|
4750
|
+
"attribute": "themeclass"
|
3577
4751
|
},
|
3578
4752
|
{
|
3579
|
-
"kind": "
|
3580
|
-
"name": "
|
3581
|
-
"
|
3582
|
-
|
4753
|
+
"kind": "method",
|
4754
|
+
"name": "updateContext",
|
4755
|
+
"privacy": "protected",
|
4756
|
+
"return": {
|
4757
|
+
"type": {
|
4758
|
+
"text": "void"
|
4759
|
+
}
|
3583
4760
|
},
|
3584
|
-
"description": "
|
3585
|
-
|
3586
|
-
|
4761
|
+
"description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
|
4762
|
+
},
|
4763
|
+
{
|
4764
|
+
"kind": "method",
|
4765
|
+
"name": "setThemeInClassList",
|
4766
|
+
"privacy": "private",
|
4767
|
+
"description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
|
3587
4768
|
}
|
3588
4769
|
],
|
3589
4770
|
"attributes": [
|
3590
4771
|
{
|
3591
|
-
"name": "
|
3592
|
-
"type": {
|
3593
|
-
"text": "ModalContainerColor"
|
3594
|
-
},
|
3595
|
-
"description": "Color of the modalcontainer\n- **tonal**\n- **contrast**",
|
3596
|
-
"default": "tonal",
|
3597
|
-
"fieldName": "color"
|
3598
|
-
},
|
3599
|
-
{
|
3600
|
-
"name": "elevation",
|
3601
|
-
"type": {
|
3602
|
-
"text": "ModalContainerElevation"
|
3603
|
-
},
|
3604
|
-
"description": "Elevation of the modalcontainer where each value corresponds to a different drop shadow.\n- **0**\n- **1**\n- **2**\n- **3**\n- **4**",
|
3605
|
-
"default": "0",
|
3606
|
-
"fieldName": "elevation"
|
3607
|
-
},
|
3608
|
-
{
|
3609
|
-
"name": "role",
|
4772
|
+
"name": "themeclass",
|
3610
4773
|
"type": {
|
3611
|
-
"text": "
|
4774
|
+
"text": "string"
|
3612
4775
|
},
|
3613
|
-
"description": "
|
3614
|
-
"
|
3615
|
-
"fieldName": "role"
|
4776
|
+
"description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
|
4777
|
+
"fieldName": "themeclass"
|
3616
4778
|
}
|
3617
4779
|
],
|
3618
4780
|
"superclass": {
|
3619
|
-
"name": "
|
4781
|
+
"name": "Provider",
|
3620
4782
|
"module": "/src/models"
|
3621
4783
|
},
|
3622
|
-
"tagName": "mdc-
|
3623
|
-
"jsDoc": "/**\n *
|
4784
|
+
"tagName": "mdc-themeprovider",
|
4785
|
+
"jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n */",
|
3624
4786
|
"customElement": true
|
3625
4787
|
}
|
3626
4788
|
],
|
@@ -3629,351 +4791,505 @@
|
|
3629
4791
|
"kind": "js",
|
3630
4792
|
"name": "default",
|
3631
4793
|
"declaration": {
|
3632
|
-
"name": "
|
3633
|
-
"module": "components/
|
4794
|
+
"name": "ThemeProvider",
|
4795
|
+
"module": "components/themeprovider/themeprovider.component.js"
|
3634
4796
|
}
|
3635
4797
|
}
|
3636
4798
|
]
|
3637
4799
|
},
|
3638
4800
|
{
|
3639
4801
|
"kind": "javascript-module",
|
3640
|
-
"path": "components/
|
4802
|
+
"path": "components/toggle/toggle.component.js",
|
3641
4803
|
"declarations": [
|
3642
4804
|
{
|
3643
4805
|
"kind": "class",
|
3644
|
-
"description": "
|
3645
|
-
"name": "
|
4806
|
+
"description": "Toggle Component is an interactive control used to switch between two mutually exclusive options,\nsuch as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\nwhere users need to enable or disable a feature.\nIt contains an optional label and an optional helper text.\n\nNote: It internally renders a checkbox styled as a toggle switch.",
|
4807
|
+
"name": "Toggle",
|
3646
4808
|
"cssProperties": [
|
3647
4809
|
{
|
3648
|
-
"description": "
|
3649
|
-
"name": "--mdc-
|
4810
|
+
"description": "width of the toggle",
|
4811
|
+
"name": "--mdc-toggle-width"
|
3650
4812
|
},
|
3651
4813
|
{
|
3652
|
-
"description": "
|
3653
|
-
"name": "--mdc-
|
4814
|
+
"description": "height of the toggle",
|
4815
|
+
"name": "--mdc-toggle-height"
|
3654
4816
|
},
|
3655
4817
|
{
|
3656
|
-
"description": "
|
3657
|
-
"name": "--mdc-
|
4818
|
+
"description": "width of the toggle when it's size is compact",
|
4819
|
+
"name": "--mdc-toggle-width-compact"
|
3658
4820
|
},
|
3659
4821
|
{
|
3660
|
-
"description": "
|
3661
|
-
"name": "--mdc-
|
4822
|
+
"description": "height of the toggle when it's size is compact",
|
4823
|
+
"name": "--mdc-toggle-height-compact"
|
3662
4824
|
},
|
3663
4825
|
{
|
3664
|
-
"description": "
|
3665
|
-
"name": "--mdc-
|
4826
|
+
"description": "border radius of the toggle",
|
4827
|
+
"name": "--mdc-toggle-border-radius"
|
3666
4828
|
},
|
3667
4829
|
{
|
3668
|
-
"description": "
|
3669
|
-
"name": "--mdc-
|
4830
|
+
"description": "border radius of the toggle when it's size is compact",
|
4831
|
+
"name": "--mdc-toggle-border-radius-compact"
|
4832
|
+
},
|
4833
|
+
{
|
4834
|
+
"description": "border of the toggle",
|
4835
|
+
"name": "--mdc-toggle-border"
|
4836
|
+
},
|
4837
|
+
{
|
4838
|
+
"description": "background color of the inactive toggle in rest state",
|
4839
|
+
"name": "--mdc-toggle-inactive-rest-color"
|
4840
|
+
},
|
4841
|
+
{
|
4842
|
+
"description": "background color of the inactive toggle in hover state",
|
4843
|
+
"name": "--mdc-toggle-inactive-hover-color"
|
4844
|
+
},
|
4845
|
+
{
|
4846
|
+
"description": "background color of the inactive toggle in pressed state",
|
4847
|
+
"name": "--mdc-toggle-inactive-pressed-color"
|
4848
|
+
},
|
4849
|
+
{
|
4850
|
+
"description": "background color of the inactive toggle in disabled state",
|
4851
|
+
"name": "--mdc-toggle-inactive-disabled-color"
|
4852
|
+
},
|
4853
|
+
{
|
4854
|
+
"description": "background color of the active toggle in rest state",
|
4855
|
+
"name": "--mdc-toggle-active-rest-color"
|
4856
|
+
},
|
4857
|
+
{
|
4858
|
+
"description": "background color of the active toggle in hover state",
|
4859
|
+
"name": "--mdc-toggle-active-hover-color"
|
4860
|
+
},
|
4861
|
+
{
|
4862
|
+
"description": "background color of the active toggle in pressed state",
|
4863
|
+
"name": "--mdc-toggle-active-pressed-color"
|
4864
|
+
},
|
4865
|
+
{
|
4866
|
+
"description": "background color of the active toggle in disabled state",
|
4867
|
+
"name": "--mdc-toggle-active-disabled-color"
|
4868
|
+
},
|
4869
|
+
{
|
4870
|
+
"description": " color of the help text label",
|
4871
|
+
"name": "--mdc-toggle-help-text-color"
|
4872
|
+
},
|
4873
|
+
{
|
4874
|
+
"description": "color of the toggle label and help text in disabled state",
|
4875
|
+
"name": "--mdc-toggle-label-color-disabled"
|
4876
|
+
}
|
4877
|
+
],
|
4878
|
+
"members": [
|
4879
|
+
{
|
4880
|
+
"kind": "field",
|
4881
|
+
"name": "checked",
|
4882
|
+
"type": {
|
4883
|
+
"text": "boolean"
|
4884
|
+
},
|
4885
|
+
"default": "false",
|
4886
|
+
"description": "Determines whether the toggle is active or inactive.",
|
4887
|
+
"attribute": "checked",
|
4888
|
+
"reflects": true
|
4889
|
+
},
|
4890
|
+
{
|
4891
|
+
"kind": "field",
|
4892
|
+
"name": "size",
|
4893
|
+
"type": {
|
4894
|
+
"text": "ToggleSize"
|
4895
|
+
},
|
4896
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
4897
|
+
"default": "default",
|
4898
|
+
"attribute": "size",
|
4899
|
+
"reflects": true
|
3670
4900
|
},
|
3671
4901
|
{
|
3672
|
-
"
|
3673
|
-
"name": "
|
4902
|
+
"kind": "method",
|
4903
|
+
"name": "setFormValue",
|
4904
|
+
"privacy": "private",
|
4905
|
+
"description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
|
3674
4906
|
},
|
3675
4907
|
{
|
3676
|
-
"
|
3677
|
-
"name": "
|
4908
|
+
"kind": "method",
|
4909
|
+
"name": "toggleState",
|
4910
|
+
"privacy": "private",
|
4911
|
+
"return": {
|
4912
|
+
"type": {
|
4913
|
+
"text": "void"
|
4914
|
+
}
|
4915
|
+
},
|
4916
|
+
"description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
|
3678
4917
|
},
|
3679
4918
|
{
|
3680
|
-
"
|
3681
|
-
"name": "
|
4919
|
+
"kind": "method",
|
4920
|
+
"name": "handleChange",
|
4921
|
+
"privacy": "private",
|
4922
|
+
"parameters": [
|
4923
|
+
{
|
4924
|
+
"name": "event",
|
4925
|
+
"type": {
|
4926
|
+
"text": "Event"
|
4927
|
+
}
|
4928
|
+
}
|
4929
|
+
],
|
4930
|
+
"description": "Toggles the state of the toggle element.\nand dispatch the new change event."
|
3682
4931
|
},
|
3683
4932
|
{
|
3684
|
-
"
|
3685
|
-
"name": "
|
4933
|
+
"kind": "method",
|
4934
|
+
"name": "setToggleSize",
|
4935
|
+
"privacy": "private",
|
4936
|
+
"parameters": [
|
4937
|
+
{
|
4938
|
+
"name": "size",
|
4939
|
+
"type": {
|
4940
|
+
"text": "ToggleSize"
|
4941
|
+
},
|
4942
|
+
"description": "The size to set."
|
4943
|
+
}
|
4944
|
+
],
|
4945
|
+
"description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
|
3686
4946
|
},
|
3687
4947
|
{
|
3688
|
-
"
|
3689
|
-
"name": "
|
4948
|
+
"kind": "field",
|
4949
|
+
"name": "helpTextType",
|
4950
|
+
"type": {
|
4951
|
+
"text": "ValidationType"
|
4952
|
+
},
|
4953
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
4954
|
+
"attribute": "help-text-type",
|
4955
|
+
"reflects": true,
|
4956
|
+
"default": "undefined as unknown",
|
4957
|
+
"inheritedFrom": {
|
4958
|
+
"name": "FormfieldWrapper",
|
4959
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
4960
|
+
}
|
3690
4961
|
},
|
3691
4962
|
{
|
3692
|
-
"
|
3693
|
-
"name": "
|
4963
|
+
"kind": "field",
|
4964
|
+
"name": "name",
|
4965
|
+
"type": {
|
4966
|
+
"text": "string"
|
4967
|
+
},
|
4968
|
+
"default": "''",
|
4969
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
4970
|
+
"attribute": "name",
|
4971
|
+
"reflects": true,
|
4972
|
+
"inheritedFrom": {
|
4973
|
+
"name": "NameMixin",
|
4974
|
+
"module": "utils/mixins/NameMixin.js"
|
4975
|
+
}
|
3694
4976
|
},
|
3695
4977
|
{
|
3696
|
-
"
|
3697
|
-
"name": "
|
4978
|
+
"kind": "field",
|
4979
|
+
"name": "value",
|
4980
|
+
"type": {
|
4981
|
+
"text": "string"
|
4982
|
+
},
|
4983
|
+
"default": "''",
|
4984
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
4985
|
+
"attribute": "value",
|
4986
|
+
"reflects": true,
|
4987
|
+
"inheritedFrom": {
|
4988
|
+
"name": "ValueMixin",
|
4989
|
+
"module": "utils/mixins/ValueMixin.js"
|
4990
|
+
}
|
3698
4991
|
},
|
3699
4992
|
{
|
3700
|
-
"
|
3701
|
-
"name": "
|
4993
|
+
"kind": "field",
|
4994
|
+
"name": "dataAriaLabel",
|
4995
|
+
"type": {
|
4996
|
+
"text": "string | null"
|
4997
|
+
},
|
4998
|
+
"default": "null",
|
4999
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
5000
|
+
"attribute": "data-aria-label",
|
5001
|
+
"reflects": true,
|
5002
|
+
"inheritedFrom": {
|
5003
|
+
"name": "DataAriaLabelMixin",
|
5004
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
5005
|
+
}
|
3702
5006
|
},
|
3703
|
-
{
|
3704
|
-
"description": "The background color of the presence type overlay.",
|
3705
|
-
"name": "--mdc-presence-overlay-background-color"
|
3706
|
-
}
|
3707
|
-
],
|
3708
|
-
"members": [
|
3709
5007
|
{
|
3710
5008
|
"kind": "field",
|
3711
|
-
"name": "
|
5009
|
+
"name": "disabled",
|
3712
5010
|
"type": {
|
3713
|
-
"text": "
|
5011
|
+
"text": "boolean"
|
3714
5012
|
},
|
3715
|
-
"
|
3716
|
-
"
|
3717
|
-
"attribute": "
|
3718
|
-
"reflects": true
|
5013
|
+
"default": "false",
|
5014
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
5015
|
+
"attribute": "disabled",
|
5016
|
+
"reflects": true,
|
5017
|
+
"inheritedFrom": {
|
5018
|
+
"name": "FormfieldWrapper",
|
5019
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5020
|
+
}
|
3719
5021
|
},
|
3720
5022
|
{
|
3721
5023
|
"kind": "field",
|
3722
|
-
"name": "
|
5024
|
+
"name": "label",
|
3723
5025
|
"type": {
|
3724
|
-
"text": "
|
5026
|
+
"text": "string | undefined"
|
3725
5027
|
},
|
3726
|
-
"description": "
|
3727
|
-
"
|
3728
|
-
"
|
3729
|
-
"
|
5028
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
5029
|
+
"attribute": "label",
|
5030
|
+
"reflects": true,
|
5031
|
+
"inheritedFrom": {
|
5032
|
+
"name": "FormfieldWrapper",
|
5033
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5034
|
+
}
|
3730
5035
|
},
|
3731
5036
|
{
|
3732
5037
|
"kind": "field",
|
3733
|
-
"name": "
|
3734
|
-
"
|
3735
|
-
"description": "
|
3736
|
-
"
|
5038
|
+
"name": "id",
|
5039
|
+
"default": "`mdc-input-${uuidv4()}`",
|
5040
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
5041
|
+
"attribute": "id",
|
5042
|
+
"inheritedFrom": {
|
5043
|
+
"name": "FormfieldWrapper",
|
5044
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5045
|
+
}
|
3737
5046
|
},
|
3738
5047
|
{
|
3739
5048
|
"kind": "field",
|
3740
|
-
"name": "
|
3741
|
-
"
|
3742
|
-
|
3743
|
-
|
5049
|
+
"name": "helpText",
|
5050
|
+
"type": {
|
5051
|
+
"text": "string | undefined"
|
5052
|
+
},
|
5053
|
+
"description": "The help text that is displayed below the input field.",
|
5054
|
+
"attribute": "help-text",
|
5055
|
+
"reflects": true,
|
5056
|
+
"inheritedFrom": {
|
5057
|
+
"name": "FormfieldWrapper",
|
5058
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5059
|
+
}
|
3744
5060
|
},
|
3745
5061
|
{
|
3746
5062
|
"kind": "method",
|
3747
|
-
"name": "
|
3748
|
-
"privacy": "
|
5063
|
+
"name": "renderLabelElement",
|
5064
|
+
"privacy": "protected",
|
5065
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
3749
5066
|
"return": {
|
3750
5067
|
"type": {
|
3751
|
-
"text": "
|
5068
|
+
"text": ""
|
3752
5069
|
}
|
3753
5070
|
},
|
3754
|
-
"
|
5071
|
+
"inheritedFrom": {
|
5072
|
+
"name": "FormfieldWrapper",
|
5073
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5074
|
+
}
|
3755
5075
|
},
|
3756
5076
|
{
|
3757
5077
|
"kind": "method",
|
3758
|
-
"name": "
|
3759
|
-
"privacy": "
|
5078
|
+
"name": "renderHelpTextIcon",
|
5079
|
+
"privacy": "protected",
|
5080
|
+
"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.",
|
3760
5081
|
"return": {
|
3761
5082
|
"type": {
|
3762
|
-
"text": "
|
5083
|
+
"text": ""
|
3763
5084
|
}
|
3764
5085
|
},
|
3765
|
-
"
|
3766
|
-
|
3767
|
-
|
3768
|
-
|
5086
|
+
"inheritedFrom": {
|
5087
|
+
"name": "FormfieldWrapper",
|
5088
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5089
|
+
}
|
5090
|
+
},
|
3769
5091
|
{
|
3770
|
-
"
|
3771
|
-
"
|
3772
|
-
|
5092
|
+
"kind": "method",
|
5093
|
+
"name": "renderHelpText",
|
5094
|
+
"privacy": "protected",
|
5095
|
+
"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.",
|
5096
|
+
"return": {
|
5097
|
+
"type": {
|
5098
|
+
"text": ""
|
5099
|
+
}
|
3773
5100
|
},
|
3774
|
-
"
|
3775
|
-
|
3776
|
-
|
5101
|
+
"inheritedFrom": {
|
5102
|
+
"name": "FormfieldWrapper",
|
5103
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5104
|
+
}
|
3777
5105
|
},
|
3778
5106
|
{
|
3779
|
-
"
|
3780
|
-
"
|
3781
|
-
|
3782
|
-
|
3783
|
-
"
|
3784
|
-
|
3785
|
-
|
3786
|
-
|
3787
|
-
|
3788
|
-
|
3789
|
-
|
3790
|
-
|
3791
|
-
|
3792
|
-
|
3793
|
-
"jsDoc": "/**\n * The `mdc-presence` component is a versatile UI element used to\n * display the presence status of a user or entity within an avatar component.\n *\n * This component is ideal for use within avatar UIs where the presence status\n * needs to be visually represented.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-presence\n *\n * @cssproperty --mdc-presence-active-background-color - The background color of the presence type active.\n * @cssproperty --mdc-presence-away-background-color - The background color of the presence type away.\n * @cssproperty --mdc-presence-away-calling-background-color - The background color of the presence type away-calling.\n * @cssproperty --mdc-presence-busy-background-color - The background color of the presence type busy.\n * @cssproperty --mdc-presence-dnd-background-color - The background color of the presence type dnd.\n * @cssproperty --mdc-presence-meeting-background-color - The background color of the presence type meeting.\n * @cssproperty --mdc-presence-on-call-background-color - The background color of the presence type on-call.\n * @cssproperty --mdc-presence-on-device-background-color - The background color of the presence type on-device.\n * @cssproperty --mdc-presence-on-mobile-background-color - The background color of the presence type on-mobile.\n * @cssproperty --mdc-presence-pause-background-color - The background color of the presence type pause.\n * @cssproperty --mdc-presence-pto-background-color - The background color of the presence type pto.\n * @cssproperty --mdc-presence-presenting-background-color - The background color of the presence type presenting.\n * @cssproperty --mdc-presence-quiet-background-color - The background color of the presence type quiet.\n * @cssproperty --mdc-presence-scheduled-background-color - The background color of the presence type scheduled.\n * @cssproperty --mdc-presence-overlay-background-color - The background color of the presence type overlay.\n */",
|
3794
|
-
"customElement": true
|
3795
|
-
}
|
3796
|
-
],
|
3797
|
-
"exports": [
|
3798
|
-
{
|
3799
|
-
"kind": "js",
|
3800
|
-
"name": "default",
|
3801
|
-
"declaration": {
|
3802
|
-
"name": "Presence",
|
3803
|
-
"module": "components/presence/presence.component.js"
|
3804
|
-
}
|
3805
|
-
}
|
3806
|
-
]
|
3807
|
-
},
|
3808
|
-
{
|
3809
|
-
"kind": "javascript-module",
|
3810
|
-
"path": "components/text/text.component.js",
|
3811
|
-
"declarations": [
|
3812
|
-
{
|
3813
|
-
"kind": "class",
|
3814
|
-
"description": "Text component for creating styled text elements.\nIt has to be mounted within the ThemeProvider to access color and font tokens.\n\nThe `type` attribute allows changing the text style.\nThe `tagname` attribute allows changing the tag name of the text element.\nThe default tag name is `p`.\n\nThe `tagname` attribute should be a valid HTML tag name.\nIf the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n\nThe styling is applied based on the `type` attribute.",
|
3815
|
-
"name": "Text",
|
3816
|
-
"cssParts": [
|
5107
|
+
"kind": "method",
|
5108
|
+
"name": "renderLabel",
|
5109
|
+
"privacy": "protected",
|
5110
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
5111
|
+
"return": {
|
5112
|
+
"type": {
|
5113
|
+
"text": ""
|
5114
|
+
}
|
5115
|
+
},
|
5116
|
+
"inheritedFrom": {
|
5117
|
+
"name": "FormfieldWrapper",
|
5118
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5119
|
+
}
|
5120
|
+
},
|
3817
5121
|
{
|
3818
|
-
"
|
3819
|
-
"name": "
|
5122
|
+
"kind": "method",
|
5123
|
+
"name": "renderHelperText",
|
5124
|
+
"privacy": "protected",
|
5125
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
5126
|
+
"return": {
|
5127
|
+
"type": {
|
5128
|
+
"text": ""
|
5129
|
+
}
|
5130
|
+
},
|
5131
|
+
"inheritedFrom": {
|
5132
|
+
"name": "FormfieldWrapper",
|
5133
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
5134
|
+
}
|
3820
5135
|
}
|
3821
5136
|
],
|
3822
|
-
"
|
5137
|
+
"events": [
|
3823
5138
|
{
|
3824
|
-
"
|
3825
|
-
|
5139
|
+
"type": {
|
5140
|
+
"text": "EventConstructor"
|
5141
|
+
}
|
3826
5142
|
}
|
3827
5143
|
],
|
3828
|
-
"
|
5144
|
+
"attributes": [
|
3829
5145
|
{
|
3830
|
-
"
|
3831
|
-
"name": "type",
|
5146
|
+
"name": "checked",
|
3832
5147
|
"type": {
|
3833
|
-
"text": "
|
5148
|
+
"text": "boolean"
|
3834
5149
|
},
|
3835
|
-
"
|
3836
|
-
"description": "
|
3837
|
-
"
|
3838
|
-
"attribute": "type",
|
3839
|
-
"reflects": true
|
5150
|
+
"default": "false",
|
5151
|
+
"description": "Determines whether the toggle is active or inactive.",
|
5152
|
+
"fieldName": "checked"
|
3840
5153
|
},
|
3841
5154
|
{
|
3842
|
-
"
|
3843
|
-
"name": "tagname",
|
5155
|
+
"name": "size",
|
3844
5156
|
"type": {
|
3845
|
-
"text": "
|
5157
|
+
"text": "ToggleSize"
|
3846
5158
|
},
|
3847
|
-
"
|
3848
|
-
"
|
3849
|
-
"
|
3850
|
-
|
3851
|
-
}
|
3852
|
-
],
|
3853
|
-
"attributes": [
|
5159
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
5160
|
+
"default": "default",
|
5161
|
+
"fieldName": "size"
|
5162
|
+
},
|
3854
5163
|
{
|
3855
|
-
"name": "
|
5164
|
+
"name": "name",
|
3856
5165
|
"type": {
|
3857
|
-
"text": "
|
5166
|
+
"text": "string"
|
3858
5167
|
},
|
3859
|
-
"
|
3860
|
-
"
|
3861
|
-
"fieldName": "
|
5168
|
+
"default": "''",
|
5169
|
+
"description": "Indicates the name of the component group (ex: checkbox, radio group).\nThey are used to group elements in a form together.",
|
5170
|
+
"fieldName": "name",
|
5171
|
+
"inheritedFrom": {
|
5172
|
+
"name": "NameMixin",
|
5173
|
+
"module": "src/utils/mixins/NameMixin.ts"
|
5174
|
+
}
|
3862
5175
|
},
|
3863
5176
|
{
|
3864
|
-
"name": "
|
5177
|
+
"name": "value",
|
3865
5178
|
"type": {
|
3866
|
-
"text": "
|
5179
|
+
"text": "string"
|
3867
5180
|
},
|
3868
|
-
"
|
3869
|
-
"
|
3870
|
-
|
3871
|
-
|
3872
|
-
|
3873
|
-
|
3874
|
-
|
3875
|
-
},
|
3876
|
-
"tagName": "mdc-text",
|
3877
|
-
"jsDoc": "/**\n * Text component for creating styled text elements.\n * It has to be mounted within the ThemeProvider to access color and font tokens.\n *\n * The `type` attribute allows changing the text style.\n * The `tagname` attribute allows changing the tag name of the text element.\n * The default tag name is `p`.\n *\n * The `tagname` attribute should be a valid HTML tag name.\n * If the `tagname` attribute is not a valid HTML tag name, the default tag name will be used.\n *\n * The styling is applied based on the `type` attribute.\n *\n * @tagname mdc-text\n * @slot - Default slot for text content\n *\n * @csspart text - The text element\n */",
|
3878
|
-
"customElement": true
|
3879
|
-
}
|
3880
|
-
],
|
3881
|
-
"exports": [
|
3882
|
-
{
|
3883
|
-
"kind": "js",
|
3884
|
-
"name": "default",
|
3885
|
-
"declaration": {
|
3886
|
-
"name": "Text",
|
3887
|
-
"module": "components/text/text.component.js"
|
3888
|
-
}
|
3889
|
-
}
|
3890
|
-
]
|
3891
|
-
},
|
3892
|
-
{
|
3893
|
-
"kind": "javascript-module",
|
3894
|
-
"path": "components/themeprovider/themeprovider.component.js",
|
3895
|
-
"declarations": [
|
3896
|
-
{
|
3897
|
-
"kind": "class",
|
3898
|
-
"description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
|
3899
|
-
"name": "ThemeProvider",
|
3900
|
-
"cssProperties": [
|
3901
|
-
{
|
3902
|
-
"description": "Option to override the default color, default: color-theme-text-primary-normal",
|
3903
|
-
"name": "--mdc-themeprovider-color-default"
|
5181
|
+
"default": "''",
|
5182
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
5183
|
+
"fieldName": "value",
|
5184
|
+
"inheritedFrom": {
|
5185
|
+
"name": "ValueMixin",
|
5186
|
+
"module": "src/utils/mixins/ValueMixin.ts"
|
5187
|
+
}
|
3904
5188
|
},
|
3905
5189
|
{
|
3906
|
-
"
|
3907
|
-
"
|
5190
|
+
"name": "data-aria-label",
|
5191
|
+
"type": {
|
5192
|
+
"text": "string | null"
|
5193
|
+
},
|
5194
|
+
"default": "null",
|
5195
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
5196
|
+
"fieldName": "dataAriaLabel",
|
5197
|
+
"inheritedFrom": {
|
5198
|
+
"name": "DataAriaLabelMixin",
|
5199
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
5200
|
+
}
|
3908
5201
|
},
|
3909
5202
|
{
|
3910
|
-
"
|
3911
|
-
"
|
5203
|
+
"name": "disabled",
|
5204
|
+
"type": {
|
5205
|
+
"text": "boolean"
|
5206
|
+
},
|
5207
|
+
"default": "false",
|
5208
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
5209
|
+
"fieldName": "disabled",
|
5210
|
+
"inheritedFrom": {
|
5211
|
+
"name": "FormfieldWrapper",
|
5212
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
5213
|
+
}
|
3912
5214
|
},
|
3913
5215
|
{
|
3914
|
-
"
|
3915
|
-
"
|
3916
|
-
|
3917
|
-
|
3918
|
-
|
3919
|
-
|
3920
|
-
"
|
3921
|
-
|
3922
|
-
|
3923
|
-
|
3924
|
-
|
5216
|
+
"name": "label",
|
5217
|
+
"type": {
|
5218
|
+
"text": "string | undefined"
|
5219
|
+
},
|
5220
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
5221
|
+
"fieldName": "label",
|
5222
|
+
"inheritedFrom": {
|
5223
|
+
"name": "FormfieldWrapper",
|
5224
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
5225
|
+
}
|
5226
|
+
},
|
3925
5227
|
{
|
3926
|
-
"
|
3927
|
-
"
|
3928
|
-
"
|
3929
|
-
"
|
3930
|
-
"
|
3931
|
-
|
5228
|
+
"name": "id",
|
5229
|
+
"default": "`mdc-input-${uuidv4()}`",
|
5230
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
5231
|
+
"fieldName": "id",
|
5232
|
+
"inheritedFrom": {
|
5233
|
+
"name": "FormfieldWrapper",
|
5234
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
5235
|
+
}
|
3932
5236
|
},
|
3933
5237
|
{
|
3934
|
-
"
|
3935
|
-
"name": "themeclass",
|
5238
|
+
"name": "help-text-type",
|
3936
5239
|
"type": {
|
3937
|
-
"text": "
|
5240
|
+
"text": "ValidationType"
|
3938
5241
|
},
|
3939
|
-
"description": "
|
3940
|
-
"
|
5242
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
5243
|
+
"fieldName": "helpTextType",
|
5244
|
+
"inheritedFrom": {
|
5245
|
+
"name": "FormfieldWrapper",
|
5246
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
5247
|
+
}
|
3941
5248
|
},
|
3942
5249
|
{
|
3943
|
-
"
|
3944
|
-
"
|
3945
|
-
|
3946
|
-
"return": {
|
3947
|
-
"type": {
|
3948
|
-
"text": "void"
|
3949
|
-
}
|
5250
|
+
"name": "help-text",
|
5251
|
+
"type": {
|
5252
|
+
"text": "string | undefined"
|
3950
5253
|
},
|
3951
|
-
"description": "
|
3952
|
-
|
3953
|
-
|
3954
|
-
|
3955
|
-
|
3956
|
-
|
3957
|
-
"description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
|
5254
|
+
"description": "The help text that is displayed below the input field.",
|
5255
|
+
"fieldName": "helpText",
|
5256
|
+
"inheritedFrom": {
|
5257
|
+
"name": "FormfieldWrapper",
|
5258
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
5259
|
+
}
|
3958
5260
|
}
|
3959
5261
|
],
|
3960
|
-
"
|
5262
|
+
"mixins": [
|
3961
5263
|
{
|
3962
|
-
"name": "
|
3963
|
-
"
|
3964
|
-
|
3965
|
-
|
3966
|
-
"
|
3967
|
-
"
|
5264
|
+
"name": "NameMixin",
|
5265
|
+
"module": "/src/utils/mixins/NameMixin"
|
5266
|
+
},
|
5267
|
+
{
|
5268
|
+
"name": "ValueMixin",
|
5269
|
+
"module": "/src/utils/mixins/ValueMixin"
|
5270
|
+
},
|
5271
|
+
{
|
5272
|
+
"name": "DataAriaLabelMixin",
|
5273
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
3968
5274
|
}
|
3969
5275
|
],
|
3970
5276
|
"superclass": {
|
3971
|
-
"name": "
|
3972
|
-
"module": "/src/
|
5277
|
+
"name": "FormfieldWrapper",
|
5278
|
+
"module": "/src/components/formfieldwrapper"
|
3973
5279
|
},
|
3974
|
-
"tagName": "mdc-
|
3975
|
-
"jsDoc": "/**\n *
|
3976
|
-
"customElement": true
|
5280
|
+
"tagName": "mdc-toggle",
|
5281
|
+
"jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-toggle\n *\n * @cssproperty --mdc-toggle-width - width of the toggle\n * @cssproperty --mdc-toggle-height - height of the toggle\n * @cssproperty --mdc-toggle-width-compact - width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border-radius - border radius of the toggle\n * @cssproperty --mdc-toggle-border-radius-compact - border radius of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border - border of the toggle\n * @cssproperty --mdc-toggle-inactive-rest-color - background color of the inactive toggle in rest state\n * @cssproperty --mdc-toggle-inactive-hover-color - background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - background color of the inactive toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-disabled-color - background color of the inactive toggle in disabled state\n * @cssproperty --mdc-toggle-active-rest-color - background color of the active toggle in rest state\n * @cssproperty --mdc-toggle-active-hover-color - background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-active-disabled-color - background color of the active toggle in disabled state\n * @cssproperty --mdc-toggle-help-text-color - color of the help text label\n * @cssproperty --mdc-toggle-label-color-disabled - color of the toggle label and help text in disabled state\n *\n */",
|
5282
|
+
"customElement": true,
|
5283
|
+
"slots": [
|
5284
|
+
{
|
5285
|
+
"description": "slot to add the label info icon",
|
5286
|
+
"name": "label-info",
|
5287
|
+
"inheritedFrom": {
|
5288
|
+
"name": "FormfieldWrapper",
|
5289
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
5290
|
+
}
|
5291
|
+
}
|
5292
|
+
]
|
3977
5293
|
}
|
3978
5294
|
],
|
3979
5295
|
"exports": [
|
@@ -3981,8 +5297,8 @@
|
|
3981
5297
|
"kind": "js",
|
3982
5298
|
"name": "default",
|
3983
5299
|
"declaration": {
|
3984
|
-
"name": "
|
3985
|
-
"module": "components/
|
5300
|
+
"name": "Toggle",
|
5301
|
+
"module": "components/toggle/toggle.component.js"
|
3986
5302
|
}
|
3987
5303
|
}
|
3988
5304
|
]
|