@aurodesignsystem-dev/auro-formkit 0.0.0-pr1325.0 → 0.0.0-pr1332.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/components/checkbox/demo/api.min.js +1 -1
  2. package/components/checkbox/demo/index.min.js +1 -1
  3. package/components/checkbox/dist/index.js +1 -1
  4. package/components/checkbox/dist/registered.js +1 -1
  5. package/components/combobox/demo/api.md +1 -1
  6. package/components/combobox/demo/api.min.js +6 -6
  7. package/components/combobox/demo/index.min.js +6 -6
  8. package/components/combobox/dist/auro-combobox.d.ts +5 -2
  9. package/components/combobox/dist/index.js +6 -6
  10. package/components/combobox/dist/registered.js +6 -6
  11. package/components/counter/demo/api.min.js +2 -2
  12. package/components/counter/demo/index.min.js +2 -2
  13. package/components/counter/dist/index.js +2 -2
  14. package/components/counter/dist/registered.js +2 -2
  15. package/components/datepicker/demo/api.min.js +5 -5
  16. package/components/datepicker/demo/index.min.js +5 -5
  17. package/components/datepicker/dist/index.js +5 -5
  18. package/components/datepicker/dist/registered.js +5 -5
  19. package/components/dropdown/demo/api.min.js +1 -1
  20. package/components/dropdown/demo/index.min.js +1 -1
  21. package/components/dropdown/dist/index.js +1 -1
  22. package/components/dropdown/dist/registered.js +1 -1
  23. package/components/input/demo/api.min.js +3 -3
  24. package/components/input/demo/index.min.js +3 -3
  25. package/components/input/dist/auro-input.d.ts +0 -1
  26. package/components/input/dist/base-input.d.ts +1 -1
  27. package/components/input/dist/index.js +3 -3
  28. package/components/input/dist/registered.js +3 -3
  29. package/components/radio/demo/api.min.js +1 -1
  30. package/components/radio/demo/index.min.js +1 -1
  31. package/components/radio/dist/index.js +1 -1
  32. package/components/radio/dist/registered.js +1 -1
  33. package/components/select/demo/api.min.js +2 -2
  34. package/components/select/demo/index.min.js +2 -2
  35. package/components/select/dist/index.js +2 -2
  36. package/components/select/dist/registered.js +2 -2
  37. package/custom-elements.json +1404 -1409
  38. package/package.json +1 -1
package/custom-elements.json CHANGED
@@ -238,80 +238,34 @@
238
238
  },
239
239
  {
240
240
  "kind": "javascript-module",
241
- "path": "components/combobox/src/auro-combobox.js",
241
+ "path": "components/checkbox/src/auro-checkbox-group.js",
242
242
  "declarations": [
243
243
  {
244
244
  "kind": "class",
245
- "description": "The `auro-combobox` element provides users with a way to select an option from a list of filtered or suggested options based on user input.",
246
- "name": "AuroCombobox",
245
+ "description": "The `auro-checkbox-group` element is a wrapper for `auro-checkbox` elements.",
246
+ "name": "AuroCheckboxGroup",
247
247
  "slots": [
248
248
  {
249
- "description": "Default slot for the menu content.",
250
- "name": ""
249
+ "description": "Allows for the legend to be overridden.",
250
+ "name": "legend"
251
251
  },
252
252
  {
253
- "type": {
254
- "text": "HTMLSlotElement"
255
- },
256
253
  "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
257
254
  "name": "optionalLabel"
258
255
  },
259
256
  {
260
- "description": "Sets aria-label on clear button",
261
- "name": "ariaLabel.input.clear"
262
- },
263
- {
264
- "description": "Sets aria-label on close button in fullscreen bib",
265
- "name": "ariaLabel.bib.close"
266
- },
267
- {
268
- "description": "Defines the headline to display above menu-options",
269
- "name": "bib.fullscreen.headline"
270
- },
271
- {
272
- "description": "Defines the content of the label.",
273
- "name": "label"
274
- },
275
- {
276
- "description": "Defines the content of the helpText.",
257
+ "description": "Allows for the helper text to be overridden.",
277
258
  "name": "helpText"
278
259
  },
279
260
  {
280
- "description": "Allows custom HTML content to display the selected value when the combobox is not focused. Only works with `snowflake` and `emphasized` layouts.",
281
- "name": "displayValue"
261
+ "description": "The default slot for the checkbox items.",
262
+ "name": "default"
282
263
  }
283
264
  ],
284
265
  "members": [
285
266
  {
286
267
  "kind": "method",
287
- "name": "_initializeDefaults",
288
- "privacy": "private",
289
- "return": {
290
- "type": {
291
- "text": "void"
292
- }
293
- }
294
- },
295
- {
296
- "kind": "field",
297
- "name": "inputValue",
298
- "description": "Returns the current value of the input element within the combobox.",
299
- "return": {
300
- "type": {
301
- "text": "string|undefined"
302
- }
303
- },
304
- "readonly": true
305
- },
306
- {
307
- "kind": "method",
308
- "name": "isValid",
309
- "description": "Checks if the element is valid.",
310
- "return": {
311
- "type": {
312
- "text": "boolean"
313
- }
314
- }
268
+ "name": "_initializeDefaults"
315
269
  },
316
270
  {
317
271
  "kind": "method",
@@ -320,7 +274,7 @@
320
274
  "parameters": [
321
275
  {
322
276
  "name": "name",
323
- "default": "'auro-combobox'",
277
+ "default": "\"auro-checkbox-group\"",
324
278
  "description": "The name of the element that you want to register.",
325
279
  "optional": true,
326
280
  "type": {
@@ -332,40 +286,24 @@
332
286
  },
333
287
  {
334
288
  "kind": "method",
335
- "name": "updateFilter",
336
- "description": "Updates the filter for the available options based on the input value.",
337
- "privacy": "private"
338
- },
339
- {
340
- "kind": "method",
341
- "name": "syncValuesAndStates",
342
- "description": "Syncs the values and states of this component, the input, and the menu, including this.optionSelected and this.menu.optionSelected.",
343
- "privacy": "private",
344
- "return": {
345
- "type": {
346
- "text": "void"
347
- }
348
- }
349
- },
350
- {
351
- "kind": "method",
352
- "name": "updateTriggerTextDisplay",
289
+ "name": "handleValueUpdate",
353
290
  "parameters": [
354
291
  {
355
- "name": "label",
356
- "description": "The label of the selected option.",
292
+ "name": "value",
293
+ "description": "The value of the checkbox.",
357
294
  "type": {
358
- "text": "string"
295
+ "text": "String"
296
+ }
297
+ },
298
+ {
299
+ "name": "selected",
300
+ "description": "The checked state of the checkbox.",
301
+ "type": {
302
+ "text": "Boolean"
359
303
  }
360
304
  }
361
305
  ],
362
- "description": "Update displayValue or input.value, it's called when making a selection.",
363
- "privacy": "private"
364
- },
365
- {
366
- "kind": "method",
367
- "name": "handleMenuOptions",
368
- "description": "Processes hidden state of all menu options and determines if there are any available options not hidden.",
306
+ "description": "Helper method to handle checkbox value changing.",
369
307
  "privacy": "private",
370
308
  "return": {
371
309
  "type": {
@@ -375,8 +313,8 @@
375
313
  },
376
314
  {
377
315
  "kind": "method",
378
- "name": "generateOptionsArray",
379
- "description": "Determines the element error state based on the `required` attribute and input value.",
316
+ "name": "handlePreselectedItems",
317
+ "description": "Helper method that handles the state of preselected checkboxes.",
380
318
  "privacy": "private",
381
319
  "return": {
382
320
  "type": {
@@ -386,8 +324,9 @@
386
324
  },
387
325
  {
388
326
  "kind": "method",
389
- "name": "hideBib",
390
- "description": "Hides the dropdown bib if its open.",
327
+ "name": "handleItems",
328
+ "description": "Helper method that handles the state of checkboxes.",
329
+ "privacy": "private",
391
330
  "return": {
392
331
  "type": {
393
332
  "text": "void"
@@ -396,8 +335,8 @@
396
335
  },
397
336
  {
398
337
  "kind": "method",
399
- "name": "showBib",
400
- "description": "Shows the dropdown bib if there are options to show.",
338
+ "name": "reset",
339
+ "description": "Resets component to initial state.",
401
340
  "return": {
402
341
  "type": {
403
342
  "text": "void"
@@ -406,1218 +345,1050 @@
406
345
  },
407
346
  {
408
347
  "kind": "method",
409
- "name": "configureDropdown",
410
- "description": "Binds all behavior needed to the dropdown after rendering.",
411
- "privacy": "private",
412
- "return": {
413
- "type": {
414
- "text": "void"
348
+ "name": "validate",
349
+ "parameters": [
350
+ {
351
+ "name": "force",
352
+ "default": "false",
353
+ "description": "Whether to force validation.",
354
+ "optional": true,
355
+ "type": {
356
+ "text": "boolean"
357
+ }
415
358
  }
416
- }
359
+ ],
360
+ "description": "Validates value."
417
361
  },
418
362
  {
419
- "kind": "method",
420
- "name": "setClearBtnFocus",
421
- "privacy": "private"
363
+ "kind": "field",
364
+ "name": "appearance",
365
+ "privacy": "public",
366
+ "type": {
367
+ "text": "'default' | 'inverse'"
368
+ },
369
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
370
+ "default": "'default'",
371
+ "attribute": "appearance",
372
+ "reflects": true
422
373
  },
423
374
  {
424
- "kind": "method",
425
- "name": "setInputFocus",
426
- "privacy": "private"
375
+ "kind": "field",
376
+ "name": "disabled",
377
+ "privacy": "public",
378
+ "type": {
379
+ "text": "boolean"
380
+ },
381
+ "description": "If set, disables the checkbox group.",
382
+ "attribute": "disabled",
383
+ "reflects": true
427
384
  },
428
385
  {
429
- "kind": "method",
430
- "name": "updateMenuShapeSize",
431
- "description": "Update menu to default for fullscreen bib, otherwise to this.size and this.shape.",
432
- "privacy": "private"
386
+ "kind": "field",
387
+ "name": "error",
388
+ "privacy": "public",
389
+ "type": {
390
+ "text": "string"
391
+ },
392
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
393
+ "attribute": "error",
394
+ "reflects": true
433
395
  },
434
396
  {
435
- "kind": "method",
436
- "name": "configureMenu",
437
- "description": "Binds all behavior needed to the menu after rendering.",
438
- "privacy": "private",
439
- "return": {
440
- "type": {
441
- "text": "void"
442
- }
443
- }
397
+ "kind": "field",
398
+ "name": "horizontal",
399
+ "privacy": "public",
400
+ "type": {
401
+ "text": "boolean"
402
+ },
403
+ "description": "If set, checkboxes will be aligned horizontally.",
404
+ "attribute": "horizontal",
405
+ "reflects": true
444
406
  },
445
407
  {
446
- "kind": "method",
447
- "name": "configureInput",
448
- "description": "Binds all behavior needed to the input after rendering.",
449
- "privacy": "private",
450
- "return": {
451
- "type": {
452
- "text": "void"
453
- }
454
- }
408
+ "kind": "field",
409
+ "name": "noValidate",
410
+ "privacy": "public",
411
+ "type": {
412
+ "text": "boolean"
413
+ },
414
+ "description": "If set, disables auto-validation on blur.",
415
+ "attribute": "noValidate",
416
+ "reflects": true
455
417
  },
456
418
  {
457
- "kind": "method",
458
- "name": "handleMenuLoadingChange",
459
- "parameters": [
460
- {
461
- "name": "event",
462
- "description": "The event object containing details about the loading state change.",
463
- "type": {
464
- "text": "CustomEvent"
465
- }
466
- },
467
- {
468
- "description": "Indicates whether the menu is currently loading.",
469
- "name": "event.detail.loading",
470
- "type": {
471
- "text": "boolean"
472
- }
473
- },
474
- {
475
- "description": "Indicates if there are loading placeholders present.",
476
- "name": "event.detail.hasLoadingPlaceholder",
477
- "type": {
478
- "text": "boolean"
479
- }
480
- }
481
- ],
482
- "description": "Manages the visibility of the dropdown based on loading state changes.\n\nThis method listens for loading state changes and adjusts the visibility of the dropdown accordingly.\nIf the dropdown is visible and loading is true without any loading placeholders, it hides the dropdown\nand sets a flag to indicate it is hidden while loading. If loading is false and the dropdown was previously\nhidden, it checks if the active element is within the dropdown and shows it again if true.",
483
- "privacy": "private",
484
- "return": {
485
- "type": {
486
- "text": "void"
487
- }
488
- }
489
- },
490
- {
491
- "kind": "method",
492
- "name": "handleInputValueChange",
493
- "parameters": [
494
- {
495
- "name": "event",
496
- "description": "The input event triggered by the input element.",
497
- "type": {
498
- "text": "Event"
499
- }
500
- }
501
- ],
502
- "description": "Handle changes to the input value and trigger changes that should result.",
503
- "privacy": "private",
504
- "return": {
505
- "type": {
506
- "text": "void"
507
- }
508
- }
509
- },
510
- {
511
- "kind": "method",
512
- "name": "configureCombobox",
513
- "description": "Binds all behavior needed to the combobox after rendering.",
514
- "privacy": "private",
515
- "return": {
516
- "type": {
517
- "text": "void"
518
- }
519
- }
520
- },
521
- {
522
- "kind": "method",
523
- "name": "focus",
524
- "description": "Focuses the combobox trigger input.",
525
- "return": {
526
- "type": {
527
- "text": "void"
528
- }
529
- }
530
- },
531
- {
532
- "kind": "method",
533
- "name": "setMenuValue",
534
- "parameters": [
535
- {
536
- "name": "value",
537
- "description": "The value to set on the menu.",
538
- "type": {
539
- "text": "string"
540
- }
541
- }
542
- ],
543
- "description": "Sets the menu value if menu is available.",
544
- "return": {
545
- "type": {
546
- "text": "void"
547
- }
548
- }
549
- },
550
- {
551
- "kind": "method",
552
- "name": "reset",
553
- "description": "Resets component to initial state.",
554
- "return": {
555
- "type": {
556
- "text": "void"
557
- }
558
- }
559
- },
560
- {
561
- "kind": "method",
562
- "name": "clear",
563
- "description": "Clears the current value of the combobox.",
564
- "return": {
565
- "type": {
566
- "text": "void"
567
- }
568
- }
569
- },
570
- {
571
- "kind": "method",
572
- "name": "validate",
573
- "parameters": [
574
- {
575
- "name": "force",
576
- "default": "false",
577
- "description": "Whether to force validation.",
578
- "optional": true,
579
- "type": {
580
- "text": "boolean"
581
- }
582
- }
583
- ],
584
- "description": "Validates value."
585
- },
586
- {
587
- "kind": "method",
588
- "name": "transportAssignedNodes",
589
- "parameters": [
590
- {
591
- "name": "slot",
592
- "description": "The slot element containing the nodes to apply.",
593
- "type": {
594
- "text": "HTMLSlotElement"
595
- }
596
- },
597
- {
598
- "name": "target",
599
- "description": "The target element to apply the nodes to.",
600
- "type": {
601
- "text": "HTMLElement"
602
- }
603
- },
604
- {
605
- "name": "newSlotName",
606
- "description": "The new slot name for the applied nodes.",
607
- "type": {
608
- "text": "string"
609
- }
610
- }
611
- ],
612
- "description": "Applies slotted nodes to a target element with a new slot name.",
613
- "privacy": "private",
614
- "return": {
615
- "type": {
616
- "text": "void"
617
- }
618
- }
619
- },
620
- {
621
- "kind": "method",
622
- "name": "updateActiveOption",
623
- "parameters": [
624
- {
625
- "name": "index",
626
- "description": "Index of the option to make active.",
627
- "type": {
628
- "text": "number"
629
- }
630
- }
631
- ],
632
- "description": "Updates the active option in the menu."
633
- },
634
- {
635
- "kind": "method",
636
- "name": "handleSlotChange",
637
- "parameters": [
638
- {
639
- "name": "event",
640
- "description": "`slotchange` event.",
641
- "type": {
642
- "text": "Event"
643
- }
644
- }
645
- ],
646
- "description": "Watch for slot changes and recalculate the menuoptions.",
647
- "privacy": "private",
648
- "return": {
649
- "type": {
650
- "text": "void"
651
- }
652
- }
419
+ "kind": "field",
420
+ "name": "onDark",
421
+ "privacy": "public",
422
+ "type": {
423
+ "text": "boolean"
424
+ },
425
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
426
+ "attribute": "onDark",
427
+ "reflects": true
653
428
  },
654
429
  {
655
430
  "kind": "field",
656
- "name": "appearance",
431
+ "name": "required",
657
432
  "privacy": "public",
658
433
  "type": {
659
- "text": "'default' | 'inverse'"
434
+ "text": "boolean"
660
435
  },
661
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
662
- "default": "'default'",
663
- "attribute": "appearance",
436
+ "description": "Populates the `required` attribute on the element. Used for client-side validation.",
437
+ "attribute": "required",
664
438
  "reflects": true
665
439
  },
666
440
  {
667
441
  "kind": "field",
668
- "name": "autocomplete",
442
+ "name": "setCustomValidity",
669
443
  "privacy": "public",
670
444
  "type": {
671
445
  "text": "string"
672
446
  },
673
- "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
674
- "attribute": "autocomplete",
675
- "reflects": true
447
+ "description": "Sets a custom help text message to display for all validityStates.",
448
+ "attribute": "setCustomValidity"
676
449
  },
677
450
  {
678
451
  "kind": "field",
679
- "name": "autoPlacement",
452
+ "name": "setCustomValidityCustomError",
680
453
  "privacy": "public",
681
454
  "type": {
682
- "text": "boolean"
455
+ "text": "string"
683
456
  },
684
- "description": "If declared, bib's position will be automatically calculated where to appear.",
685
- "attribute": "autoPlacement",
686
- "reflects": true
457
+ "description": "Custom help text message to display when validity = `customError`.",
458
+ "attribute": "setCustomValidityCustomError"
687
459
  },
688
460
  {
689
461
  "kind": "field",
690
- "name": "availableOptions",
691
- "privacy": "private",
462
+ "name": "setCustomValidityValueMissing",
463
+ "privacy": "public",
692
464
  "type": {
693
- "text": "array"
465
+ "text": "string"
694
466
  },
695
- "description": "Array of available options to display in the dropdown.",
696
- "attribute": "availableOptions"
467
+ "description": "Custom help text message to display when validity = `valueMissing`.",
468
+ "attribute": "setCustomValidityValueMissing"
697
469
  },
698
470
  {
699
471
  "kind": "field",
700
- "name": "behavior",
472
+ "name": "validity",
701
473
  "privacy": "public",
702
474
  "type": {
703
- "text": "'filter' | 'suggestion'"
475
+ "text": "string"
704
476
  },
705
- "description": "Sets the behavior of the combobox, \"filter\" or \"suggestion\".\n\"filter\" requires the user to select an option from the menu.\n\"suggestion\" allows the user to enter a value not present in the menu options.",
706
- "default": "'suggestion'",
707
- "attribute": "behavior",
477
+ "description": "Specifies the `validityState` this element is in.",
478
+ "attribute": "validity",
708
479
  "reflects": true
480
+ }
481
+ ],
482
+ "events": [
483
+ {
484
+ "name": "input",
485
+ "type": {
486
+ "text": "CustomEvent"
487
+ }
709
488
  },
710
489
  {
711
- "kind": "field",
712
- "name": "checkmark",
713
- "privacy": "public",
490
+ "description": "Notifies that the `validity` and `errorMessage` values have changed.",
491
+ "name": "auroFormElement-validated"
492
+ }
493
+ ],
494
+ "attributes": [
495
+ {
496
+ "name": "appearance",
714
497
  "type": {
715
- "text": "boolean"
498
+ "text": "'default' | 'inverse'"
716
499
  },
717
- "description": "When attribute is present auro-menu will apply check marks to selected options.",
718
- "attribute": "checkmark",
719
- "reflects": true
500
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
501
+ "default": "'default'",
502
+ "fieldName": "appearance"
720
503
  },
721
504
  {
722
- "kind": "field",
723
505
  "name": "disabled",
724
- "privacy": "public",
725
506
  "type": {
726
507
  "text": "boolean"
727
508
  },
728
- "description": "If set, disables the combobox.",
729
- "attribute": "disabled",
730
- "reflects": true
509
+ "description": "If set, disables the checkbox group.",
510
+ "fieldName": "disabled"
731
511
  },
732
512
  {
733
- "kind": "field",
734
- "name": "dropdownId",
735
- "privacy": "private",
513
+ "name": "error",
736
514
  "type": {
737
515
  "text": "string"
738
516
  },
739
- "description": "ID for the dropdown."
517
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
518
+ "fieldName": "error"
740
519
  },
741
520
  {
742
- "kind": "field",
743
- "name": "dropdownOpen",
744
- "privacy": "private",
521
+ "name": "horizontal",
745
522
  "type": {
746
523
  "text": "boolean"
747
524
  },
748
- "description": "Whether or not the dropdown is open."
525
+ "description": "If set, checkboxes will be aligned horizontally.",
526
+ "fieldName": "horizontal"
749
527
  },
750
528
  {
751
- "kind": "field",
752
- "name": "dvInputOnly",
753
- "privacy": "public",
529
+ "name": "noValidate",
754
530
  "type": {
755
531
  "text": "boolean"
756
532
  },
757
- "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
758
- "attribute": "dvInputOnly",
759
- "reflects": true
533
+ "description": "If set, disables auto-validation on blur.",
534
+ "fieldName": "noValidate"
760
535
  },
761
536
  {
762
- "kind": "field",
763
- "name": "error",
764
- "privacy": "public",
537
+ "name": "onDark",
538
+ "type": {
539
+ "text": "boolean"
540
+ },
541
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
542
+ "fieldName": "onDark"
543
+ },
544
+ {
545
+ "name": "required",
546
+ "type": {
547
+ "text": "boolean"
548
+ },
549
+ "description": "Populates the `required` attribute on the element. Used for client-side validation.",
550
+ "fieldName": "required"
551
+ },
552
+ {
553
+ "name": "setCustomValidity",
765
554
  "type": {
766
555
  "text": "string"
767
556
  },
768
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
769
- "attribute": "error",
770
- "reflects": true
557
+ "description": "Sets a custom help text message to display for all validityStates.",
558
+ "fieldName": "setCustomValidity"
771
559
  },
772
560
  {
773
- "kind": "field",
774
- "name": "format",
775
- "privacy": "public",
561
+ "name": "setCustomValidityCustomError",
776
562
  "type": {
777
563
  "text": "string"
778
564
  },
779
- "description": "Specifies the input mask format.",
780
- "attribute": "format",
781
- "reflects": true
565
+ "description": "Custom help text message to display when validity = `customError`.",
566
+ "fieldName": "setCustomValidityCustomError"
782
567
  },
783
568
  {
784
- "kind": "field",
785
- "name": "inputmode",
786
- "privacy": "public",
569
+ "name": "setCustomValidityValueMissing",
787
570
  "type": {
788
571
  "text": "string"
789
572
  },
790
- "description": "Exposes inputmode attribute for input.",
791
- "attribute": "inputmode",
792
- "reflects": true
573
+ "description": "Custom help text message to display when validity = `valueMissing`.",
574
+ "fieldName": "setCustomValidityValueMissing"
793
575
  },
794
576
  {
795
- "kind": "field",
796
- "name": "layout",
797
- "privacy": "public",
577
+ "name": "validity",
798
578
  "type": {
799
579
  "text": "string"
800
580
  },
801
- "description": "Sets the layout of the combobox.",
802
- "default": "'classic'",
803
- "attribute": "layout",
804
- "reflects": true,
805
- "inheritedFrom": {
806
- "name": "AuroElement",
807
- "module": "components/layoutElement/src/auroElement.js"
581
+ "description": "Specifies the `validityState` this element is in.",
582
+ "fieldName": "validity"
583
+ }
584
+ ],
585
+ "superclass": {
586
+ "name": "LitElement",
587
+ "package": "lit"
588
+ },
589
+ "tagName": "auro-checkbox-group",
590
+ "customElement": true
591
+ }
592
+ ],
593
+ "exports": [
594
+ {
595
+ "kind": "js",
596
+ "name": "AuroCheckboxGroup",
597
+ "declaration": {
598
+ "name": "AuroCheckboxGroup",
599
+ "module": "components/checkbox/src/auro-checkbox-group.js"
600
+ }
601
+ }
602
+ ]
603
+ },
604
+ {
605
+ "kind": "javascript-module",
606
+ "path": "components/checkbox/src/auro-checkbox.js",
607
+ "declarations": [
608
+ {
609
+ "kind": "class",
610
+ "description": "The `auro-checkbox` element is for the purpose of allowing users to select one or more options of a limited number of choices.",
611
+ "name": "AuroCheckbox",
612
+ "cssParts": [
613
+ {
614
+ "description": "apply css to a specific checkbox.",
615
+ "name": "checkbox"
616
+ },
617
+ {
618
+ "description": "apply css to a specific checkbox's input.",
619
+ "name": "checkbox-input"
620
+ },
621
+ {
622
+ "description": "apply css to a specific checkbox's label.",
623
+ "name": "checkbox-label"
624
+ }
625
+ ],
626
+ "slots": [
627
+ {
628
+ "description": "The default slot for the checkbox label.",
629
+ "name": "default"
630
+ }
631
+ ],
632
+ "members": [
633
+ {
634
+ "kind": "method",
635
+ "name": "_initializeDefaults"
636
+ },
637
+ {
638
+ "kind": "method",
639
+ "name": "register",
640
+ "static": true,
641
+ "parameters": [
642
+ {
643
+ "name": "name",
644
+ "default": "\"auro-checkbox\"",
645
+ "description": "The name of element that you want to register to.",
646
+ "optional": true,
647
+ "type": {
648
+ "text": "string"
649
+ }
650
+ }
651
+ ],
652
+ "description": "This will register this element with the browser."
653
+ },
654
+ {
655
+ "kind": "method",
656
+ "name": "handleChange",
657
+ "parameters": [
658
+ {
659
+ "name": "event",
660
+ "description": "The change event from the checkbox input.",
661
+ "type": {
662
+ "text": "Event"
663
+ }
664
+ }
665
+ ],
666
+ "description": "Handles the change event for the checkbox input.\nUpdates the checked state and dispatches a corresponding custom event.\nThis custom event is only for the purpose of supporting IE.",
667
+ "privacy": "private",
668
+ "return": {
669
+ "type": {
670
+ "text": "void"
671
+ }
808
672
  }
809
673
  },
810
674
  {
811
- "kind": "field",
812
- "name": "matchWidth",
675
+ "kind": "method",
676
+ "name": "handleInput",
677
+ "parameters": [
678
+ {
679
+ "name": "event",
680
+ "description": "The input event from the checkbox input.",
681
+ "type": {
682
+ "text": "Event"
683
+ }
684
+ }
685
+ ],
686
+ "description": "Handles the input event for the checkbox input.\nUpdates the checked state and dispatches a custom 'auroCheckbox-input' event.",
813
687
  "privacy": "private",
814
- "type": {
815
- "text": "boolean"
816
- },
817
- "description": "If declared, the popover and trigger will be set to the same width.",
818
- "attribute": "matchWidth",
819
- "reflects": true
688
+ "return": {
689
+ "type": {
690
+ "text": "void"
691
+ }
692
+ }
693
+ },
694
+ {
695
+ "kind": "method",
696
+ "name": "handleFocusin",
697
+ "description": "Function to support",
698
+ "privacy": "private",
699
+ "return": {
700
+ "type": {
701
+ "text": "void"
702
+ }
703
+ }
704
+ },
705
+ {
706
+ "kind": "method",
707
+ "name": "generateIconHtml",
708
+ "description": "Function to generate checkmark svg.",
709
+ "privacy": "private",
710
+ "return": {
711
+ "type": {
712
+ "text": "HTMLElement"
713
+ }
714
+ }
715
+ },
716
+ {
717
+ "kind": "method",
718
+ "name": "reset",
719
+ "description": "Resets component to initial state.",
720
+ "return": {
721
+ "type": {
722
+ "text": "void"
723
+ }
724
+ }
725
+ },
726
+ {
727
+ "kind": "method",
728
+ "name": "updateAriaLabel",
729
+ "description": "Updates the aria-label based on slot content.",
730
+ "privacy": "private",
731
+ "return": {
732
+ "type": {
733
+ "text": "void"
734
+ }
735
+ }
736
+ },
737
+ {
738
+ "kind": "method",
739
+ "name": "handleKeyDown",
740
+ "parameters": [
741
+ {
742
+ "name": "event",
743
+ "description": "The keydown event from the checkbox input.",
744
+ "type": {
745
+ "text": "KeyboardEvent"
746
+ }
747
+ }
748
+ ],
749
+ "description": "Handles keydown event to toggle the checkbox with Space key.",
750
+ "privacy": "private",
751
+ "return": {
752
+ "type": {
753
+ "text": "void"
754
+ }
755
+ }
820
756
  },
821
757
  {
822
758
  "kind": "field",
823
- "name": "noFilter",
759
+ "name": "appearance",
824
760
  "privacy": "public",
825
761
  "type": {
826
- "text": "boolean"
762
+ "text": "'default' | 'inverse'"
827
763
  },
828
- "description": "If set, combobox will not filter menuoptions based on input.",
829
- "attribute": "noFilter",
764
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
765
+ "default": "'default'",
766
+ "attribute": "appearance",
830
767
  "reflects": true
831
768
  },
832
769
  {
833
770
  "kind": "field",
834
- "name": "noFlip",
771
+ "name": "checked",
835
772
  "privacy": "public",
836
773
  "type": {
837
774
  "text": "boolean"
838
775
  },
839
- "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
840
- "attribute": "noFlip",
776
+ "description": "If set to true, the checkbox will be filled with a checkmark.",
777
+ "attribute": "checked",
841
778
  "reflects": true
842
779
  },
843
780
  {
844
781
  "kind": "field",
845
- "name": "shift",
782
+ "name": "disabled",
846
783
  "privacy": "public",
847
784
  "type": {
848
785
  "text": "boolean"
849
786
  },
850
- "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
851
- "attribute": "shift",
787
+ "description": "If set to true, the checkbox will not be clickable.",
788
+ "attribute": "disabled",
852
789
  "reflects": true
853
790
  },
854
791
  {
855
792
  "kind": "field",
856
- "name": "noValidate",
793
+ "name": "error",
857
794
  "privacy": "public",
858
795
  "type": {
859
796
  "text": "boolean"
860
797
  },
861
- "description": "If set, disables auto-validation on blur.",
862
- "attribute": "noValidate",
798
+ "description": "If set to true, the checkbox will be displayed with an error state.",
799
+ "attribute": "error",
863
800
  "reflects": true
864
801
  },
865
802
  {
866
803
  "kind": "field",
867
- "name": "offset",
804
+ "name": "id",
868
805
  "privacy": "public",
869
806
  "type": {
870
- "text": "number"
807
+ "text": "string"
871
808
  },
872
- "description": "Gap between the trigger element and bib.",
873
- "default": "0",
874
- "attribute": "offset",
875
- "reflects": true
809
+ "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
810
+ "attribute": "id"
876
811
  },
877
812
  {
878
813
  "kind": "field",
879
- "name": "onDark",
880
- "privacy": "public",
814
+ "name": "inputId",
815
+ "privacy": "private",
881
816
  "type": {
882
- "text": "boolean"
817
+ "text": "string"
883
818
  },
884
- "attribute": "onDark",
885
- "reflects": true,
886
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
887
- "inheritedFrom": {
888
- "name": "AuroElement",
889
- "module": "components/layoutElement/src/auroElement.js"
890
- }
819
+ "description": "The id for input node."
891
820
  },
892
821
  {
893
822
  "kind": "field",
894
- "name": "optionSelected",
823
+ "name": "name",
895
824
  "privacy": "public",
896
825
  "type": {
897
- "text": "HTMLElement"
826
+ "text": "string"
898
827
  },
899
- "description": "Specifies the current selected option.",
900
- "attribute": "optionSelected"
828
+ "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
829
+ "attribute": "name"
901
830
  },
902
831
  {
903
832
  "kind": "field",
904
- "name": "persistInput",
833
+ "name": "onDark",
905
834
  "privacy": "public",
906
835
  "type": {
907
836
  "text": "boolean"
908
837
  },
909
- "description": "If declared, selecting a menu option will not change the input value. By doing so,\nthe current menu filter will be preserved and the user can continue from their last\nfilter state. It is recommended to use this in combination with the `displayValue` slot.",
910
- "attribute": "persistInput",
838
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
839
+ "attribute": "onDark",
911
840
  "reflects": true
912
841
  },
913
842
  {
914
843
  "kind": "field",
915
- "name": "placement",
916
- "privacy": "public",
844
+ "name": "touched",
845
+ "privacy": "private",
917
846
  "type": {
918
- "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
847
+ "text": "boolean"
919
848
  },
920
- "description": "Position where the bib should appear relative to the trigger.",
921
- "default": "'bottom-start'",
922
- "attribute": "placement",
923
- "reflects": true
849
+ "description": "Indicates whether the checkbox has been interacted with."
924
850
  },
925
851
  {
926
852
  "kind": "field",
927
- "name": "placeholder",
853
+ "name": "value",
928
854
  "privacy": "public",
929
855
  "type": {
930
856
  "text": "string"
931
857
  },
932
- "description": "Define custom placeholder text, only supported by date input formats.",
933
- "attribute": "placeholder",
934
- "reflects": true
858
+ "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
859
+ "attribute": "value"
935
860
  },
936
861
  {
937
862
  "kind": "field",
938
- "name": "required",
939
- "privacy": "public",
863
+ "name": "tabIndex",
864
+ "privacy": "private",
940
865
  "type": {
941
- "text": "boolean"
866
+ "text": "number"
942
867
  },
943
- "description": "Populates the `required` attribute on the input. Used for client-side validation.",
944
- "attribute": "required",
868
+ "description": "The tabindex attribute for the checkbox.",
869
+ "attribute": "tabindex",
945
870
  "reflects": true
946
871
  },
947
872
  {
948
873
  "kind": "field",
949
- "name": "setCustomValidity",
950
- "privacy": "public",
874
+ "name": "ariaChecked",
875
+ "privacy": "private",
951
876
  "type": {
952
877
  "text": "string"
953
878
  },
954
- "description": "Sets a custom help text message to display for all validityStates.",
955
- "attribute": "setCustomValidity"
879
+ "description": "The aria-checked attribute for the checkbox.",
880
+ "attribute": "aria-checked",
881
+ "reflects": true
956
882
  },
957
883
  {
958
884
  "kind": "field",
959
- "name": "setCustomValidityCustomError",
960
- "privacy": "public",
885
+ "name": "ariaDisabled",
886
+ "privacy": "private",
961
887
  "type": {
962
888
  "text": "string"
963
889
  },
964
- "description": "Custom help text message to display when validity = `customError`.",
965
- "attribute": "setCustomValidityCustomError"
890
+ "description": "The aria-disabled attribute for the checkbox.",
891
+ "attribute": "aria-disabled",
892
+ "reflects": true
966
893
  },
967
894
  {
968
895
  "kind": "field",
969
- "name": "setCustomValidityValueMissing",
970
- "privacy": "public",
896
+ "name": "role",
897
+ "privacy": "private",
971
898
  "type": {
972
899
  "text": "string"
973
900
  },
974
- "description": "Custom help text message to display when validity = `valueMissing`.",
975
- "attribute": "setCustomValidityValueMissing"
901
+ "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
902
+ "attribute": "role",
903
+ "reflects": true
904
+ }
905
+ ],
906
+ "events": [
907
+ {
908
+ "name": "auroCheckbox-input",
909
+ "type": {
910
+ "text": "CustomEvent"
911
+ }
976
912
  },
977
913
  {
978
- "kind": "field",
979
- "name": "setCustomValidityValueMissingFilter",
980
- "privacy": "public",
914
+ "name": "auroCheckbox-focusin",
981
915
  "type": {
982
- "text": "string"
916
+ "text": "CustomEvent"
917
+ }
918
+ },
919
+ {
920
+ "name": "auroCheckbox-focusout",
921
+ "type": {
922
+ "text": "CustomEvent"
923
+ }
924
+ },
925
+ {
926
+ "type": {
927
+ "text": "CustomEvent<any>"
983
928
  },
984
- "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
985
- "attribute": "setCustomValidityValueMissingFilter"
929
+ "description": "(Deprecated) Notifies when checked value is changed.",
930
+ "name": "change"
986
931
  },
987
932
  {
988
- "kind": "field",
989
- "name": "touched",
990
- "privacy": "private",
991
933
  "type": {
992
- "text": "boolean"
934
+ "text": "InputEvent"
993
935
  },
994
- "description": "Indicates whether the combobox is in a dirty state (has been interacted with)."
936
+ "description": "Notifies when when checked value is changed by user's interface.",
937
+ "name": "input"
938
+ }
939
+ ],
940
+ "attributes": [
941
+ {
942
+ "name": "appearance",
943
+ "type": {
944
+ "text": "'default' | 'inverse'"
945
+ },
946
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
947
+ "default": "'default'",
948
+ "fieldName": "appearance"
995
949
  },
996
950
  {
997
- "kind": "field",
998
- "name": "triggerIcon",
999
- "privacy": "public",
951
+ "name": "checked",
1000
952
  "type": {
1001
953
  "text": "boolean"
1002
954
  },
1003
- "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.",
1004
- "attribute": "triggerIcon",
1005
- "reflects": true
955
+ "description": "If set to true, the checkbox will be filled with a checkmark.",
956
+ "fieldName": "checked"
1006
957
  },
1007
958
  {
1008
- "kind": "field",
1009
- "name": "type",
1010
- "privacy": "public",
959
+ "name": "disabled",
1011
960
  "type": {
1012
- "text": "string"
961
+ "text": "boolean"
1013
962
  },
1014
- "description": "Applies the defined value as the type attribute on `auro-input`.",
1015
- "attribute": "type",
1016
- "reflects": true
963
+ "description": "If set to true, the checkbox will not be clickable.",
964
+ "fieldName": "disabled"
1017
965
  },
1018
966
  {
1019
- "kind": "field",
1020
- "name": "typedValue",
1021
- "privacy": "public",
967
+ "name": "error",
1022
968
  "type": {
1023
- "text": "string"
969
+ "text": "boolean"
1024
970
  },
1025
- "description": "Specifies the value of the input element within the combobox.",
1026
- "attribute": "typedValue",
1027
- "reflects": true
971
+ "description": "If set to true, the checkbox will be displayed with an error state.",
972
+ "fieldName": "error"
1028
973
  },
1029
974
  {
1030
- "kind": "field",
1031
- "name": "validity",
1032
- "privacy": "public",
975
+ "name": "id",
1033
976
  "type": {
1034
977
  "text": "string"
1035
978
  },
1036
- "description": "Specifies the `validityState` this element is in.",
1037
- "attribute": "validity",
1038
- "reflects": true
979
+ "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
980
+ "fieldName": "id"
1039
981
  },
1040
982
  {
1041
- "kind": "field",
1042
- "name": "value",
1043
- "privacy": "public",
983
+ "name": "name",
1044
984
  "type": {
1045
985
  "text": "string"
1046
986
  },
1047
- "description": "Value selected for the dropdown menu.",
1048
- "attribute": "value"
987
+ "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
988
+ "fieldName": "name"
1049
989
  },
1050
990
  {
1051
- "kind": "field",
1052
- "name": "largeFullscreenHeadline",
1053
- "privacy": "public",
991
+ "name": "onDark",
1054
992
  "type": {
1055
993
  "text": "boolean"
1056
994
  },
1057
- "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
1058
- "attribute": "largeFullscreenHeadline",
1059
- "reflects": true
995
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
996
+ "fieldName": "onDark"
1060
997
  },
1061
998
  {
1062
- "kind": "field",
1063
- "name": "fullscreenBreakpoint",
1064
- "privacy": "public",
999
+ "name": "value",
1065
1000
  "type": {
1066
- "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
1001
+ "text": "string"
1067
1002
  },
1068
- "description": "Defines the screen size breakpointat which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.",
1069
- "default": "'sm'",
1070
- "attribute": "fullscreenBreakpoint",
1071
- "reflects": true
1003
+ "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
1004
+ "fieldName": "value"
1072
1005
  },
1073
1006
  {
1074
- "kind": "field",
1075
- "name": "optionActive",
1076
- "privacy": "private",
1007
+ "name": "tabindex",
1077
1008
  "type": {
1078
- "text": "object"
1009
+ "text": "number"
1079
1010
  },
1080
- "description": "Specifies the currently active/highlighted `auro-menuoption`."
1011
+ "description": "The tabindex attribute for the checkbox.",
1012
+ "fieldName": "tabIndex"
1081
1013
  },
1082
1014
  {
1083
- "kind": "field",
1084
- "name": "componentHasFocus",
1085
- "description": "Returns true if the element has focus.",
1086
- "privacy": "private",
1087
- "return": {
1088
- "type": {
1089
- "text": "boolean"
1090
- }
1015
+ "name": "aria-checked",
1016
+ "type": {
1017
+ "text": "string"
1091
1018
  },
1092
- "readonly": true,
1093
- "inheritedFrom": {
1094
- "name": "AuroElement",
1095
- "module": "components/layoutElement/src/auroElement.js"
1096
- }
1097
- },
1098
- {
1099
- "kind": "method",
1100
- "name": "resetShapeClasses",
1101
- "inheritedFrom": {
1102
- "name": "AuroElement",
1103
- "module": "components/layoutElement/src/auroElement.js"
1104
- }
1019
+ "description": "The aria-checked attribute for the checkbox.",
1020
+ "fieldName": "ariaChecked"
1105
1021
  },
1106
1022
  {
1107
- "kind": "method",
1108
- "name": "resetLayoutClasses",
1109
- "inheritedFrom": {
1110
- "name": "AuroElement",
1111
- "module": "components/layoutElement/src/auroElement.js"
1112
- }
1113
- },
1114
- {
1115
- "kind": "method",
1116
- "name": "updateComponentArchitecture",
1117
- "inheritedFrom": {
1118
- "name": "AuroElement",
1119
- "module": "components/layoutElement/src/auroElement.js"
1120
- }
1121
- },
1122
- {
1123
- "kind": "field",
1124
- "name": "shape",
1125
- "privacy": "public",
1023
+ "name": "aria-disabled",
1126
1024
  "type": {
1127
1025
  "text": "string"
1128
1026
  },
1129
- "attribute": "shape",
1130
- "reflects": true,
1131
- "inheritedFrom": {
1132
- "name": "AuroElement",
1133
- "module": "components/layoutElement/src/auroElement.js"
1134
- }
1027
+ "description": "The aria-disabled attribute for the checkbox.",
1028
+ "fieldName": "ariaDisabled"
1135
1029
  },
1136
1030
  {
1137
- "kind": "field",
1138
- "name": "size",
1139
- "privacy": "public",
1031
+ "name": "role",
1140
1032
  "type": {
1141
1033
  "text": "string"
1142
1034
  },
1143
- "attribute": "size",
1144
- "reflects": true,
1145
- "inheritedFrom": {
1146
- "name": "AuroElement",
1147
- "module": "components/layoutElement/src/auroElement.js"
1148
- }
1149
- }
1150
- ],
1151
- "events": [
1152
- {
1153
- "name": "inputValue",
1154
- "type": {
1155
- "text": "CustomEvent"
1156
- },
1157
- "description": "Notifies that the components internal HTML5 input value has changed."
1158
- },
1159
- {
1160
- "name": "input",
1161
- "type": {
1162
- "text": "CustomEvent"
1163
- },
1164
- "description": "Notifies that the component has a new value set."
1165
- },
1166
- {
1167
- "name": "auroCombobox-valueSet",
1168
- "type": {
1169
- "text": "CustomEvent"
1170
- },
1171
- "description": "(Deprecated) Notifies that the component has a new value set."
1172
- },
1173
- {
1174
- "description": "Notifies that the component value(s) have been validated.",
1175
- "name": "auroFormElement-validated"
1035
+ "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
1036
+ "fieldName": "role"
1176
1037
  }
1177
1038
  ],
1178
- "attributes": [
1179
- {
1180
- "name": "appearance",
1181
- "type": {
1182
- "text": "'default' | 'inverse'"
1183
- },
1184
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
1185
- "default": "'default'",
1186
- "fieldName": "appearance"
1187
- },
1188
- {
1189
- "name": "autocomplete",
1190
- "type": {
1191
- "text": "string"
1192
- },
1193
- "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
1194
- "fieldName": "autocomplete"
1195
- },
1196
- {
1197
- "name": "autoPlacement",
1198
- "type": {
1199
- "text": "boolean"
1200
- },
1201
- "description": "If declared, bib's position will be automatically calculated where to appear.",
1202
- "fieldName": "autoPlacement"
1203
- },
1039
+ "superclass": {
1040
+ "name": "LitElement",
1041
+ "package": "lit"
1042
+ },
1043
+ "tagName": "auro-checkbox",
1044
+ "customElement": true
1045
+ }
1046
+ ],
1047
+ "exports": [
1048
+ {
1049
+ "kind": "js",
1050
+ "name": "AuroCheckbox",
1051
+ "declaration": {
1052
+ "name": "AuroCheckbox",
1053
+ "module": "components/checkbox/src/auro-checkbox.js"
1054
+ }
1055
+ }
1056
+ ]
1057
+ },
1058
+ {
1059
+ "kind": "javascript-module",
1060
+ "path": "components/checkbox/src/index.js",
1061
+ "declarations": [],
1062
+ "exports": [
1063
+ {
1064
+ "kind": "js",
1065
+ "name": "AuroCheckbox",
1066
+ "declaration": {
1067
+ "name": "AuroCheckbox",
1068
+ "module": "components/checkbox/src/index.js"
1069
+ }
1070
+ },
1071
+ {
1072
+ "kind": "js",
1073
+ "name": "AuroCheckboxGroup",
1074
+ "declaration": {
1075
+ "name": "AuroCheckboxGroup",
1076
+ "module": "components/checkbox/src/index.js"
1077
+ }
1078
+ }
1079
+ ]
1080
+ },
1081
+ {
1082
+ "kind": "javascript-module",
1083
+ "path": "components/checkbox/src/registered.js",
1084
+ "declarations": [],
1085
+ "exports": []
1086
+ },
1087
+ {
1088
+ "kind": "javascript-module",
1089
+ "path": "components/combobox/src/auro-combobox.js",
1090
+ "declarations": [
1091
+ {
1092
+ "kind": "class",
1093
+ "description": "The `auro-combobox` element provides users with a way to select an option from a list of filtered or suggested options based on user input.",
1094
+ "name": "AuroCombobox",
1095
+ "slots": [
1204
1096
  {
1205
- "name": "availableOptions",
1206
- "type": {
1207
- "text": "array"
1208
- },
1209
- "description": "Array of available options to display in the dropdown.",
1210
- "fieldName": "availableOptions"
1097
+ "description": "Default slot for the menu content.",
1098
+ "name": ""
1211
1099
  },
1212
1100
  {
1213
- "name": "behavior",
1214
1101
  "type": {
1215
- "text": "'filter' | 'suggestion'"
1102
+ "text": "HTMLSlotElement"
1216
1103
  },
1217
- "description": "Sets the behavior of the combobox, \"filter\" or \"suggestion\".\n\"filter\" requires the user to select an option from the menu.\n\"suggestion\" allows the user to enter a value not present in the menu options.",
1218
- "default": "'suggestion'",
1219
- "fieldName": "behavior"
1104
+ "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
1105
+ "name": "optionalLabel"
1220
1106
  },
1221
1107
  {
1222
- "name": "checkmark",
1223
- "type": {
1224
- "text": "boolean"
1225
- },
1226
- "description": "When attribute is present auro-menu will apply check marks to selected options.",
1227
- "fieldName": "checkmark"
1108
+ "description": "Sets aria-label on clear button",
1109
+ "name": "ariaLabel.input.clear"
1228
1110
  },
1229
1111
  {
1230
- "name": "disabled",
1231
- "type": {
1232
- "text": "boolean"
1233
- },
1234
- "description": "If set, disables the combobox.",
1235
- "fieldName": "disabled"
1112
+ "description": "Sets aria-label on close button in fullscreen bib",
1113
+ "name": "ariaLabel.bib.close"
1236
1114
  },
1237
1115
  {
1238
- "name": "dvInputOnly",
1239
- "type": {
1240
- "text": "boolean"
1241
- },
1242
- "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
1243
- "fieldName": "dvInputOnly"
1116
+ "description": "Defines the headline to display above menu-options",
1117
+ "name": "bib.fullscreen.headline"
1244
1118
  },
1245
1119
  {
1246
- "name": "error",
1247
- "type": {
1248
- "text": "string"
1249
- },
1250
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1251
- "fieldName": "error"
1120
+ "description": "Defines the content of the label.",
1121
+ "name": "label"
1252
1122
  },
1253
1123
  {
1254
- "name": "format",
1255
- "type": {
1256
- "text": "string"
1257
- },
1258
- "description": "Specifies the input mask format.",
1259
- "fieldName": "format"
1124
+ "description": "Defines the content of the helpText.",
1125
+ "name": "helpText"
1260
1126
  },
1261
1127
  {
1262
- "name": "inputmode",
1263
- "type": {
1264
- "text": "string"
1265
- },
1266
- "description": "Exposes inputmode attribute for input.",
1267
- "fieldName": "inputmode"
1268
- },
1128
+ "description": "Allows custom HTML content to display the selected value when the combobox is not focused. Only works with `snowflake` and `emphasized` layouts.",
1129
+ "name": "displayValue"
1130
+ }
1131
+ ],
1132
+ "members": [
1269
1133
  {
1270
- "name": "layout",
1271
- "type": {
1272
- "text": "string"
1273
- },
1274
- "description": "Sets the layout of the combobox.",
1275
- "default": "'classic'",
1276
- "fieldName": "layout",
1277
- "inheritedFrom": {
1278
- "name": "AuroElement",
1279
- "module": "components/layoutElement/src/auroElement.js"
1134
+ "kind": "method",
1135
+ "name": "_initializeDefaults",
1136
+ "privacy": "private",
1137
+ "return": {
1138
+ "type": {
1139
+ "text": "void"
1140
+ }
1280
1141
  }
1281
1142
  },
1282
1143
  {
1283
- "name": "matchWidth",
1284
- "type": {
1285
- "text": "boolean"
1286
- },
1287
- "description": "If declared, the popover and trigger will be set to the same width.",
1288
- "fieldName": "matchWidth"
1289
- },
1290
- {
1291
- "name": "noFilter",
1292
- "type": {
1293
- "text": "boolean"
1294
- },
1295
- "description": "If set, combobox will not filter menuoptions based on input.",
1296
- "fieldName": "noFilter"
1297
- },
1298
- {
1299
- "name": "noFlip",
1300
- "type": {
1301
- "text": "boolean"
1302
- },
1303
- "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
1304
- "fieldName": "noFlip"
1305
- },
1306
- {
1307
- "name": "shift",
1308
- "type": {
1309
- "text": "boolean"
1310
- },
1311
- "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
1312
- "fieldName": "shift"
1313
- },
1314
- {
1315
- "name": "noValidate",
1316
- "type": {
1317
- "text": "boolean"
1318
- },
1319
- "description": "If set, disables auto-validation on blur.",
1320
- "fieldName": "noValidate"
1321
- },
1322
- {
1323
- "name": "offset",
1324
- "type": {
1325
- "text": "number"
1326
- },
1327
- "description": "Gap between the trigger element and bib.",
1328
- "default": "0",
1329
- "fieldName": "offset"
1330
- },
1331
- {
1332
- "name": "onDark",
1333
- "type": {
1334
- "text": "boolean"
1335
- },
1336
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1337
- "fieldName": "onDark"
1338
- },
1339
- {
1340
- "name": "optionSelected",
1341
- "type": {
1342
- "text": "HTMLElement"
1343
- },
1344
- "description": "Specifies the current selected option.",
1345
- "fieldName": "optionSelected"
1346
- },
1347
- {
1348
- "name": "persistInput",
1349
- "type": {
1350
- "text": "boolean"
1351
- },
1352
- "description": "If declared, selecting a menu option will not change the input value. By doing so,\nthe current menu filter will be preserved and the user can continue from their last\nfilter state. It is recommended to use this in combination with the `displayValue` slot.",
1353
- "fieldName": "persistInput"
1354
- },
1355
- {
1356
- "name": "placement",
1357
- "type": {
1358
- "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
1359
- },
1360
- "description": "Position where the bib should appear relative to the trigger.",
1361
- "default": "'bottom-start'",
1362
- "fieldName": "placement"
1363
- },
1364
- {
1365
- "name": "placeholder",
1366
- "type": {
1367
- "text": "string"
1368
- },
1369
- "description": "Define custom placeholder text, only supported by date input formats.",
1370
- "fieldName": "placeholder"
1371
- },
1372
- {
1373
- "name": "required",
1374
- "type": {
1375
- "text": "boolean"
1376
- },
1377
- "description": "Populates the `required` attribute on the input. Used for client-side validation.",
1378
- "fieldName": "required"
1379
- },
1380
- {
1381
- "name": "setCustomValidity",
1382
- "type": {
1383
- "text": "string"
1384
- },
1385
- "description": "Sets a custom help text message to display for all validityStates.",
1386
- "fieldName": "setCustomValidity"
1387
- },
1388
- {
1389
- "name": "setCustomValidityCustomError",
1390
- "type": {
1391
- "text": "string"
1392
- },
1393
- "description": "Custom help text message to display when validity = `customError`.",
1394
- "fieldName": "setCustomValidityCustomError"
1395
- },
1396
- {
1397
- "name": "setCustomValidityValueMissing",
1398
- "type": {
1399
- "text": "string"
1144
+ "kind": "field",
1145
+ "name": "inputValue",
1146
+ "description": "Returns the current value of the input element within the combobox.",
1147
+ "return": {
1148
+ "type": {
1149
+ "text": "string|undefined"
1150
+ }
1400
1151
  },
1401
- "description": "Custom help text message to display when validity = `valueMissing`.",
1402
- "fieldName": "setCustomValidityValueMissing"
1152
+ "readonly": true
1403
1153
  },
1404
1154
  {
1405
- "name": "setCustomValidityValueMissingFilter",
1406
- "type": {
1407
- "text": "string"
1408
- },
1409
- "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
1410
- "fieldName": "setCustomValidityValueMissingFilter"
1155
+ "kind": "method",
1156
+ "name": "isValid",
1157
+ "description": "Checks if the element is valid.",
1158
+ "return": {
1159
+ "type": {
1160
+ "text": "boolean"
1161
+ }
1162
+ }
1411
1163
  },
1412
1164
  {
1413
- "name": "triggerIcon",
1414
- "type": {
1415
- "text": "boolean"
1416
- },
1417
- "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.",
1418
- "fieldName": "triggerIcon"
1165
+ "kind": "method",
1166
+ "name": "register",
1167
+ "static": true,
1168
+ "parameters": [
1169
+ {
1170
+ "name": "name",
1171
+ "default": "'auro-combobox'",
1172
+ "description": "The name of the element that you want to register.",
1173
+ "optional": true,
1174
+ "type": {
1175
+ "text": "string"
1176
+ }
1177
+ }
1178
+ ],
1179
+ "description": "This will register this element with the browser."
1419
1180
  },
1420
1181
  {
1421
- "name": "type",
1422
- "type": {
1423
- "text": "string"
1424
- },
1425
- "description": "Applies the defined value as the type attribute on `auro-input`.",
1426
- "fieldName": "type"
1182
+ "kind": "method",
1183
+ "name": "updateFilter",
1184
+ "description": "Updates the filter for the available options based on the input value.",
1185
+ "privacy": "private"
1427
1186
  },
1428
1187
  {
1429
- "name": "typedValue",
1430
- "type": {
1431
- "text": "string"
1432
- },
1433
- "description": "Specifies the value of the input element within the combobox.",
1434
- "fieldName": "typedValue"
1188
+ "kind": "method",
1189
+ "name": "syncValuesAndStates",
1190
+ "description": "Syncs the values and states of this component, the input, and the menu, including this.optionSelected and this.menu.optionSelected.",
1191
+ "privacy": "private",
1192
+ "return": {
1193
+ "type": {
1194
+ "text": "void"
1195
+ }
1196
+ }
1435
1197
  },
1436
1198
  {
1437
- "name": "validity",
1438
- "type": {
1439
- "text": "string"
1440
- },
1441
- "description": "Specifies the `validityState` this element is in.",
1442
- "fieldName": "validity"
1199
+ "kind": "method",
1200
+ "name": "updateTriggerTextDisplay",
1201
+ "parameters": [
1202
+ {
1203
+ "name": "label",
1204
+ "description": "The label of the selected option.",
1205
+ "type": {
1206
+ "text": "string"
1207
+ }
1208
+ }
1209
+ ],
1210
+ "description": "Update displayValue or input.value, it's called when making a selection.",
1211
+ "privacy": "private"
1443
1212
  },
1444
1213
  {
1445
- "name": "value",
1446
- "type": {
1447
- "text": "string"
1448
- },
1449
- "description": "Value selected for the dropdown menu.",
1450
- "fieldName": "value"
1214
+ "kind": "method",
1215
+ "name": "handleMenuOptions",
1216
+ "description": "Processes hidden state of all menu options and determines if there are any available options not hidden.",
1217
+ "privacy": "private",
1218
+ "return": {
1219
+ "type": {
1220
+ "text": "void"
1221
+ }
1222
+ }
1451
1223
  },
1452
1224
  {
1453
- "name": "largeFullscreenHeadline",
1454
- "type": {
1455
- "text": "boolean"
1456
- },
1457
- "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
1458
- "fieldName": "largeFullscreenHeadline"
1225
+ "kind": "method",
1226
+ "name": "generateOptionsArray",
1227
+ "description": "Determines the element error state based on the `required` attribute and input value.",
1228
+ "privacy": "private",
1229
+ "return": {
1230
+ "type": {
1231
+ "text": "void"
1232
+ }
1233
+ }
1459
1234
  },
1460
1235
  {
1461
- "name": "fullscreenBreakpoint",
1462
- "type": {
1463
- "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
1464
- },
1465
- "description": "Defines the screen size breakpointat which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.",
1466
- "default": "'sm'",
1467
- "fieldName": "fullscreenBreakpoint"
1236
+ "kind": "method",
1237
+ "name": "hideBib",
1238
+ "description": "Hides the dropdown bib if its open.",
1239
+ "return": {
1240
+ "type": {
1241
+ "text": "void"
1242
+ }
1243
+ }
1468
1244
  },
1469
1245
  {
1470
- "name": "shape",
1471
- "type": {
1472
- "text": "string"
1473
- },
1474
- "fieldName": "shape",
1475
- "inheritedFrom": {
1476
- "name": "AuroElement",
1477
- "module": "components/layoutElement/src/auroElement.js"
1246
+ "kind": "method",
1247
+ "name": "showBib",
1248
+ "description": "Shows the dropdown bib if there are options to show.",
1249
+ "return": {
1250
+ "type": {
1251
+ "text": "void"
1252
+ }
1478
1253
  }
1479
1254
  },
1480
1255
  {
1481
- "name": "size",
1482
- "type": {
1483
- "text": "string"
1484
- },
1485
- "fieldName": "size",
1486
- "inheritedFrom": {
1487
- "name": "AuroElement",
1488
- "module": "components/layoutElement/src/auroElement.js"
1256
+ "kind": "method",
1257
+ "name": "configureDropdown",
1258
+ "description": "Binds all behavior needed to the dropdown after rendering.",
1259
+ "privacy": "private",
1260
+ "return": {
1261
+ "type": {
1262
+ "text": "void"
1263
+ }
1489
1264
  }
1490
1265
  },
1491
1266
  {
1492
- "name": "ondark",
1493
- "type": {
1494
- "text": "boolean"
1495
- },
1496
- "fieldName": "onDark",
1497
- "inheritedFrom": {
1498
- "name": "AuroElement",
1499
- "module": "components/layoutElement/src/auroElement.js"
1500
- }
1501
- }
1502
- ],
1503
- "superclass": {
1504
- "name": "AuroElement",
1505
- "module": "/components/layoutElement/src/auroElement.js"
1506
- },
1507
- "tagName": "auro-combobox",
1508
- "customElement": true
1509
- }
1510
- ],
1511
- "exports": [
1512
- {
1513
- "kind": "js",
1514
- "name": "AuroCombobox",
1515
- "declaration": {
1516
- "name": "AuroCombobox",
1517
- "module": "components/combobox/src/auro-combobox.js"
1518
- }
1519
- }
1520
- ]
1521
- },
1522
- {
1523
- "kind": "javascript-module",
1524
- "path": "components/combobox/src/index.js",
1525
- "declarations": [],
1526
- "exports": [
1527
- {
1528
- "kind": "js",
1529
- "name": "AuroCombobox",
1530
- "declaration": {
1531
- "name": "AuroCombobox",
1532
- "module": "components/combobox/src/index.js"
1533
- }
1534
- }
1535
- ]
1536
- },
1537
- {
1538
- "kind": "javascript-module",
1539
- "path": "components/combobox/src/registered.js",
1540
- "declarations": [],
1541
- "exports": [
1542
- {
1543
- "kind": "js",
1544
- "name": "AuroCombobox",
1545
- "declaration": {
1546
- "name": "AuroCombobox",
1547
- "module": "components/combobox/src/registered.js"
1548
- }
1549
- }
1550
- ]
1551
- },
1552
- {
1553
- "kind": "javascript-module",
1554
- "path": "components/checkbox/src/auro-checkbox-group.js",
1555
- "declarations": [
1556
- {
1557
- "kind": "class",
1558
- "description": "The `auro-checkbox-group` element is a wrapper for `auro-checkbox` elements.",
1559
- "name": "AuroCheckboxGroup",
1560
- "slots": [
1561
- {
1562
- "description": "Allows for the legend to be overridden.",
1563
- "name": "legend"
1267
+ "kind": "method",
1268
+ "name": "setClearBtnFocus",
1269
+ "privacy": "private"
1564
1270
  },
1565
1271
  {
1566
- "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
1567
- "name": "optionalLabel"
1272
+ "kind": "method",
1273
+ "name": "setInputFocus",
1274
+ "privacy": "private"
1568
1275
  },
1569
1276
  {
1570
- "description": "Allows for the helper text to be overridden.",
1571
- "name": "helpText"
1277
+ "kind": "method",
1278
+ "name": "updateMenuShapeSize",
1279
+ "description": "Update menu to default for fullscreen bib, otherwise to this.size and this.shape.",
1280
+ "privacy": "private"
1572
1281
  },
1573
1282
  {
1574
- "description": "The default slot for the checkbox items.",
1575
- "name": "default"
1576
- }
1577
- ],
1578
- "members": [
1283
+ "kind": "method",
1284
+ "name": "configureMenu",
1285
+ "description": "Binds all behavior needed to the menu after rendering.",
1286
+ "privacy": "private",
1287
+ "return": {
1288
+ "type": {
1289
+ "text": "void"
1290
+ }
1291
+ }
1292
+ },
1579
1293
  {
1580
1294
  "kind": "method",
1581
- "name": "_initializeDefaults"
1295
+ "name": "configureInput",
1296
+ "description": "Binds all behavior needed to the input after rendering.",
1297
+ "privacy": "private",
1298
+ "return": {
1299
+ "type": {
1300
+ "text": "void"
1301
+ }
1302
+ }
1582
1303
  },
1583
1304
  {
1584
1305
  "kind": "method",
1585
- "name": "register",
1586
- "static": true,
1306
+ "name": "handleMenuLoadingChange",
1587
1307
  "parameters": [
1588
1308
  {
1589
- "name": "name",
1590
- "default": "\"auro-checkbox-group\"",
1591
- "description": "The name of the element that you want to register.",
1592
- "optional": true,
1309
+ "name": "event",
1310
+ "description": "The event object containing details about the loading state change.",
1593
1311
  "type": {
1594
- "text": "string"
1312
+ "text": "CustomEvent"
1313
+ }
1314
+ },
1315
+ {
1316
+ "description": "Indicates whether the menu is currently loading.",
1317
+ "name": "event.detail.loading",
1318
+ "type": {
1319
+ "text": "boolean"
1320
+ }
1321
+ },
1322
+ {
1323
+ "description": "Indicates if there are loading placeholders present.",
1324
+ "name": "event.detail.hasLoadingPlaceholder",
1325
+ "type": {
1326
+ "text": "boolean"
1595
1327
  }
1596
1328
  }
1597
1329
  ],
1598
- "description": "This will register this element with the browser."
1330
+ "description": "Manages the visibility of the dropdown based on loading state changes.\n\nThis method listens for loading state changes and adjusts the visibility of the dropdown accordingly.\nIf the dropdown is visible and loading is true without any loading placeholders, it hides the dropdown\nand sets a flag to indicate it is hidden while loading. If loading is false and the dropdown was previously\nhidden, it checks if the active element is within the dropdown and shows it again if true.",
1331
+ "privacy": "private",
1332
+ "return": {
1333
+ "type": {
1334
+ "text": "void"
1335
+ }
1336
+ }
1599
1337
  },
1600
1338
  {
1601
1339
  "kind": "method",
1602
- "name": "handleValueUpdate",
1340
+ "name": "handleInputValueChange",
1603
1341
  "parameters": [
1604
1342
  {
1605
- "name": "value",
1606
- "description": "The value of the checkbox.",
1343
+ "name": "event",
1344
+ "description": "The input event triggered by the input element.",
1607
1345
  "type": {
1608
- "text": "String"
1346
+ "text": "Event"
1609
1347
  }
1610
- },
1348
+ }
1349
+ ],
1350
+ "description": "Handle changes to the input value and trigger changes that should result.",
1351
+ "privacy": "private",
1352
+ "return": {
1353
+ "type": {
1354
+ "text": "void"
1355
+ }
1356
+ }
1357
+ },
1358
+ {
1359
+ "kind": "method",
1360
+ "name": "configureCombobox",
1361
+ "description": "Binds all behavior needed to the combobox after rendering.",
1362
+ "privacy": "private",
1363
+ "return": {
1364
+ "type": {
1365
+ "text": "void"
1366
+ }
1367
+ }
1368
+ },
1369
+ {
1370
+ "kind": "method",
1371
+ "name": "focus",
1372
+ "description": "Focuses the combobox trigger input.",
1373
+ "return": {
1374
+ "type": {
1375
+ "text": "void"
1376
+ }
1377
+ }
1378
+ },
1379
+ {
1380
+ "kind": "method",
1381
+ "name": "setMenuValue",
1382
+ "parameters": [
1611
1383
  {
1612
- "name": "selected",
1613
- "description": "The checked state of the checkbox.",
1384
+ "name": "value",
1385
+ "description": "The value to set on the menu.",
1614
1386
  "type": {
1615
- "text": "Boolean"
1387
+ "text": "string"
1616
1388
  }
1617
1389
  }
1618
1390
  ],
1619
- "description": "Helper method to handle checkbox value changing.",
1620
- "privacy": "private",
1391
+ "description": "Sets the menu value if menu is available.",
1621
1392
  "return": {
1622
1393
  "type": {
1623
1394
  "text": "void"
@@ -1626,19 +1397,67 @@
1626
1397
  },
1627
1398
  {
1628
1399
  "kind": "method",
1629
- "name": "handlePreselectedItems",
1630
- "description": "Helper method that handles the state of preselected checkboxes.",
1631
- "privacy": "private",
1400
+ "name": "reset",
1401
+ "description": "Resets component to initial state.",
1402
+ "return": {
1403
+ "type": {
1404
+ "text": "void"
1405
+ }
1406
+ }
1407
+ },
1408
+ {
1409
+ "kind": "method",
1410
+ "name": "clear",
1411
+ "description": "Clears the current value of the combobox.",
1632
1412
  "return": {
1633
1413
  "type": {
1634
1414
  "text": "void"
1635
1415
  }
1636
- }
1637
- },
1638
- {
1639
- "kind": "method",
1640
- "name": "handleItems",
1641
- "description": "Helper method that handles the state of checkboxes.",
1416
+ }
1417
+ },
1418
+ {
1419
+ "kind": "method",
1420
+ "name": "validate",
1421
+ "parameters": [
1422
+ {
1423
+ "name": "force",
1424
+ "default": "false",
1425
+ "description": "Whether to force validation.",
1426
+ "optional": true,
1427
+ "type": {
1428
+ "text": "boolean"
1429
+ }
1430
+ }
1431
+ ],
1432
+ "description": "Validates value."
1433
+ },
1434
+ {
1435
+ "kind": "method",
1436
+ "name": "transportAssignedNodes",
1437
+ "parameters": [
1438
+ {
1439
+ "name": "slot",
1440
+ "description": "The slot element containing the nodes to apply.",
1441
+ "type": {
1442
+ "text": "HTMLSlotElement"
1443
+ }
1444
+ },
1445
+ {
1446
+ "name": "target",
1447
+ "description": "The target element to apply the nodes to.",
1448
+ "type": {
1449
+ "text": "HTMLElement"
1450
+ }
1451
+ },
1452
+ {
1453
+ "name": "newSlotName",
1454
+ "description": "The new slot name for the applied nodes.",
1455
+ "type": {
1456
+ "text": "string"
1457
+ }
1458
+ }
1459
+ ],
1460
+ "description": "Applies slotted nodes to a target element with a new slot name.",
1642
1461
  "privacy": "private",
1643
1462
  "return": {
1644
1463
  "type": {
@@ -1648,42 +1467,105 @@
1648
1467
  },
1649
1468
  {
1650
1469
  "kind": "method",
1651
- "name": "reset",
1652
- "description": "Resets component to initial state.",
1653
- "return": {
1654
- "type": {
1655
- "text": "void"
1470
+ "name": "updateActiveOption",
1471
+ "parameters": [
1472
+ {
1473
+ "name": "index",
1474
+ "description": "Index of the option to make active.",
1475
+ "type": {
1476
+ "text": "number"
1477
+ }
1656
1478
  }
1657
- }
1479
+ ],
1480
+ "description": "Updates the active option in the menu."
1658
1481
  },
1659
1482
  {
1660
1483
  "kind": "method",
1661
- "name": "validate",
1484
+ "name": "handleSlotChange",
1662
1485
  "parameters": [
1663
1486
  {
1664
- "name": "force",
1665
- "default": "false",
1666
- "description": "Whether to force validation.",
1667
- "optional": true,
1487
+ "name": "event",
1488
+ "description": "`slotchange` event.",
1668
1489
  "type": {
1669
- "text": "boolean"
1490
+ "text": "Event"
1670
1491
  }
1671
1492
  }
1672
1493
  ],
1673
- "description": "Validates value."
1494
+ "description": "Watch for slot changes and recalculate the menuoptions.",
1495
+ "privacy": "private",
1496
+ "return": {
1497
+ "type": {
1498
+ "text": "void"
1499
+ }
1500
+ }
1674
1501
  },
1675
1502
  {
1676
1503
  "kind": "field",
1677
1504
  "name": "appearance",
1678
1505
  "privacy": "public",
1679
1506
  "type": {
1680
- "text": "'default' | 'inverse'"
1507
+ "text": "string"
1681
1508
  },
1682
1509
  "description": "Defines whether the component will be on lighter or darker backgrounds.",
1683
1510
  "default": "'default'",
1684
1511
  "attribute": "appearance",
1685
1512
  "reflects": true
1686
1513
  },
1514
+ {
1515
+ "kind": "field",
1516
+ "name": "autocomplete",
1517
+ "privacy": "public",
1518
+ "type": {
1519
+ "text": "string"
1520
+ },
1521
+ "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
1522
+ "attribute": "autocomplete",
1523
+ "reflects": true
1524
+ },
1525
+ {
1526
+ "kind": "field",
1527
+ "name": "autoPlacement",
1528
+ "privacy": "public",
1529
+ "type": {
1530
+ "text": "boolean"
1531
+ },
1532
+ "description": "If declared, bib's position will be automatically calculated where to appear.",
1533
+ "attribute": "autoPlacement",
1534
+ "reflects": true
1535
+ },
1536
+ {
1537
+ "kind": "field",
1538
+ "name": "availableOptions",
1539
+ "privacy": "private",
1540
+ "type": {
1541
+ "text": "array"
1542
+ },
1543
+ "description": "Array of available options to display in the dropdown.",
1544
+ "attribute": "availableOptions"
1545
+ },
1546
+ {
1547
+ "kind": "field",
1548
+ "name": "behavior",
1549
+ "privacy": "public",
1550
+ "type": {
1551
+ "text": "'filter' | 'suggestion'"
1552
+ },
1553
+ "description": "Sets the behavior of the combobox, \"filter\" or \"suggestion\".\n\"filter\" requires the user to select an option from the menu.\n\"suggestion\" allows the user to enter a value not present in the menu options.",
1554
+ "default": "'suggestion'",
1555
+ "attribute": "behavior",
1556
+ "reflects": true
1557
+ },
1558
+ {
1559
+ "kind": "field",
1560
+ "name": "checkmark",
1561
+ "privacy": "public",
1562
+ "type": {
1563
+ "text": "boolean"
1564
+ },
1565
+ "description": "When attribute is present auro-menu will apply check marks to selected options.",
1566
+ "attribute": "checkmark",
1567
+ "reflects": true
1568
+ },
1687
1569
  {
1688
1570
  "kind": "field",
1689
1571
  "name": "disabled",
@@ -1691,52 +1573,212 @@
1691
1573
  "type": {
1692
1574
  "text": "boolean"
1693
1575
  },
1694
- "description": "If set, disables the checkbox group.",
1576
+ "description": "If set, disables the combobox.",
1695
1577
  "attribute": "disabled",
1696
1578
  "reflects": true
1697
1579
  },
1698
1580
  {
1699
1581
  "kind": "field",
1700
- "name": "error",
1582
+ "name": "dropdownId",
1583
+ "privacy": "private",
1584
+ "type": {
1585
+ "text": "string"
1586
+ },
1587
+ "description": "ID for the dropdown."
1588
+ },
1589
+ {
1590
+ "kind": "field",
1591
+ "name": "dropdownOpen",
1592
+ "privacy": "private",
1593
+ "type": {
1594
+ "text": "boolean"
1595
+ },
1596
+ "description": "Whether or not the dropdown is open."
1597
+ },
1598
+ {
1599
+ "kind": "field",
1600
+ "name": "dvInputOnly",
1601
+ "privacy": "public",
1602
+ "type": {
1603
+ "text": "boolean"
1604
+ },
1605
+ "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
1606
+ "attribute": "dvInputOnly",
1607
+ "reflects": true
1608
+ },
1609
+ {
1610
+ "kind": "field",
1611
+ "name": "error",
1612
+ "privacy": "public",
1613
+ "type": {
1614
+ "text": "string"
1615
+ },
1616
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1617
+ "attribute": "error",
1618
+ "reflects": true
1619
+ },
1620
+ {
1621
+ "kind": "field",
1622
+ "name": "format",
1623
+ "privacy": "public",
1624
+ "type": {
1625
+ "text": "string"
1626
+ },
1627
+ "description": "Specifies the input mask format.",
1628
+ "attribute": "format",
1629
+ "reflects": true
1630
+ },
1631
+ {
1632
+ "kind": "field",
1633
+ "name": "inputmode",
1634
+ "privacy": "public",
1635
+ "type": {
1636
+ "text": "string"
1637
+ },
1638
+ "description": "Exposes inputmode attribute for input.",
1639
+ "attribute": "inputmode",
1640
+ "reflects": true
1641
+ },
1642
+ {
1643
+ "kind": "field",
1644
+ "name": "layout",
1645
+ "privacy": "public",
1646
+ "type": {
1647
+ "text": "string"
1648
+ },
1649
+ "description": "Sets the layout of the combobox.",
1650
+ "default": "'classic'",
1651
+ "attribute": "layout",
1652
+ "reflects": true,
1653
+ "inheritedFrom": {
1654
+ "name": "AuroElement",
1655
+ "module": "components/layoutElement/src/auroElement.js"
1656
+ }
1657
+ },
1658
+ {
1659
+ "kind": "field",
1660
+ "name": "matchWidth",
1661
+ "privacy": "private",
1662
+ "type": {
1663
+ "text": "boolean"
1664
+ },
1665
+ "description": "If declared, the popover and trigger will be set to the same width.",
1666
+ "attribute": "matchWidth",
1667
+ "reflects": true
1668
+ },
1669
+ {
1670
+ "kind": "field",
1671
+ "name": "noFilter",
1672
+ "privacy": "public",
1673
+ "type": {
1674
+ "text": "boolean"
1675
+ },
1676
+ "description": "If set, combobox will not filter menuoptions based on input.",
1677
+ "attribute": "noFilter",
1678
+ "reflects": true
1679
+ },
1680
+ {
1681
+ "kind": "field",
1682
+ "name": "noFlip",
1683
+ "privacy": "public",
1684
+ "type": {
1685
+ "text": "boolean"
1686
+ },
1687
+ "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
1688
+ "attribute": "noFlip",
1689
+ "reflects": true
1690
+ },
1691
+ {
1692
+ "kind": "field",
1693
+ "name": "shift",
1694
+ "privacy": "public",
1695
+ "type": {
1696
+ "text": "boolean"
1697
+ },
1698
+ "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
1699
+ "attribute": "shift",
1700
+ "reflects": true
1701
+ },
1702
+ {
1703
+ "kind": "field",
1704
+ "name": "noValidate",
1705
+ "privacy": "public",
1706
+ "type": {
1707
+ "text": "boolean"
1708
+ },
1709
+ "description": "If set, disables auto-validation on blur.",
1710
+ "attribute": "noValidate",
1711
+ "reflects": true
1712
+ },
1713
+ {
1714
+ "kind": "field",
1715
+ "name": "offset",
1716
+ "privacy": "public",
1717
+ "type": {
1718
+ "text": "number"
1719
+ },
1720
+ "description": "Gap between the trigger element and bib.",
1721
+ "default": "0",
1722
+ "attribute": "offset",
1723
+ "reflects": true
1724
+ },
1725
+ {
1726
+ "kind": "field",
1727
+ "name": "onDark",
1728
+ "privacy": "public",
1729
+ "type": {
1730
+ "text": "boolean"
1731
+ },
1732
+ "attribute": "onDark",
1733
+ "reflects": true,
1734
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1735
+ "inheritedFrom": {
1736
+ "name": "AuroElement",
1737
+ "module": "components/layoutElement/src/auroElement.js"
1738
+ }
1739
+ },
1740
+ {
1741
+ "kind": "field",
1742
+ "name": "optionSelected",
1701
1743
  "privacy": "public",
1702
1744
  "type": {
1703
- "text": "string"
1745
+ "text": "HTMLElement"
1704
1746
  },
1705
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1706
- "attribute": "error",
1707
- "reflects": true
1747
+ "description": "Specifies the current selected option.",
1748
+ "attribute": "optionSelected"
1708
1749
  },
1709
1750
  {
1710
1751
  "kind": "field",
1711
- "name": "horizontal",
1752
+ "name": "persistInput",
1712
1753
  "privacy": "public",
1713
1754
  "type": {
1714
1755
  "text": "boolean"
1715
1756
  },
1716
- "description": "If set, checkboxes will be aligned horizontally.",
1717
- "attribute": "horizontal",
1757
+ "description": "If declared, selecting a menu option will not change the input value. By doing so,\nthe current menu filter will be preserved and the user can continue from their last\nfilter state. It is recommended to use this in combination with the `displayValue` slot.",
1758
+ "attribute": "persistInput",
1718
1759
  "reflects": true
1719
1760
  },
1720
1761
  {
1721
1762
  "kind": "field",
1722
- "name": "noValidate",
1763
+ "name": "placement",
1723
1764
  "privacy": "public",
1724
1765
  "type": {
1725
- "text": "boolean"
1766
+ "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
1726
1767
  },
1727
- "description": "If set, disables auto-validation on blur.",
1728
- "attribute": "noValidate",
1768
+ "description": "Position where the bib should appear relative to the trigger.",
1769
+ "default": "'bottom-start'",
1770
+ "attribute": "placement",
1729
1771
  "reflects": true
1730
1772
  },
1731
1773
  {
1732
1774
  "kind": "field",
1733
- "name": "onDark",
1775
+ "name": "placeholder",
1734
1776
  "privacy": "public",
1735
1777
  "type": {
1736
- "text": "boolean"
1778
+ "text": "string"
1737
1779
  },
1738
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1739
- "attribute": "onDark",
1780
+ "description": "Define custom placeholder text, only supported by date input formats.",
1781
+ "attribute": "placeholder",
1740
1782
  "reflects": true
1741
1783
  },
1742
1784
  {
@@ -1746,7 +1788,7 @@
1746
1788
  "type": {
1747
1789
  "text": "boolean"
1748
1790
  },
1749
- "description": "Populates the `required` attribute on the element. Used for client-side validation.",
1791
+ "description": "Populates the `required` attribute on the input. Used for client-side validation.",
1750
1792
  "attribute": "required",
1751
1793
  "reflects": true
1752
1794
  },
@@ -1782,620 +1824,578 @@
1782
1824
  },
1783
1825
  {
1784
1826
  "kind": "field",
1785
- "name": "validity",
1827
+ "name": "setCustomValidityValueMissingFilter",
1786
1828
  "privacy": "public",
1787
1829
  "type": {
1788
1830
  "text": "string"
1789
1831
  },
1790
- "description": "Specifies the `validityState` this element is in.",
1791
- "attribute": "validity",
1792
- "reflects": true
1793
- }
1794
- ],
1795
- "events": [
1796
- {
1797
- "name": "input",
1798
- "type": {
1799
- "text": "CustomEvent"
1800
- }
1801
- },
1802
- {
1803
- "description": "Notifies that the `validity` and `errorMessage` values have changed.",
1804
- "name": "auroFormElement-validated"
1805
- }
1806
- ],
1807
- "attributes": [
1808
- {
1809
- "name": "appearance",
1810
- "type": {
1811
- "text": "'default' | 'inverse'"
1812
- },
1813
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
1814
- "default": "'default'",
1815
- "fieldName": "appearance"
1816
- },
1817
- {
1818
- "name": "disabled",
1819
- "type": {
1820
- "text": "boolean"
1821
- },
1822
- "description": "If set, disables the checkbox group.",
1823
- "fieldName": "disabled"
1824
- },
1825
- {
1826
- "name": "error",
1827
- "type": {
1828
- "text": "string"
1829
- },
1830
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1831
- "fieldName": "error"
1832
+ "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
1833
+ "attribute": "setCustomValidityValueMissingFilter"
1832
1834
  },
1833
1835
  {
1834
- "name": "horizontal",
1836
+ "kind": "field",
1837
+ "name": "touched",
1838
+ "privacy": "private",
1835
1839
  "type": {
1836
1840
  "text": "boolean"
1837
1841
  },
1838
- "description": "If set, checkboxes will be aligned horizontally.",
1839
- "fieldName": "horizontal"
1842
+ "description": "Indicates whether the combobox is in a dirty state (has been interacted with)."
1840
1843
  },
1841
1844
  {
1842
- "name": "noValidate",
1845
+ "kind": "field",
1846
+ "name": "triggerIcon",
1847
+ "privacy": "public",
1843
1848
  "type": {
1844
1849
  "text": "boolean"
1845
1850
  },
1846
- "description": "If set, disables auto-validation on blur.",
1847
- "fieldName": "noValidate"
1851
+ "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.",
1852
+ "attribute": "triggerIcon",
1853
+ "reflects": true
1848
1854
  },
1849
1855
  {
1850
- "name": "onDark",
1856
+ "kind": "field",
1857
+ "name": "type",
1858
+ "privacy": "public",
1851
1859
  "type": {
1852
- "text": "boolean"
1860
+ "text": "string"
1853
1861
  },
1854
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1855
- "fieldName": "onDark"
1862
+ "description": "Applies the defined value as the type attribute on `auro-input`.",
1863
+ "attribute": "type",
1864
+ "reflects": true
1856
1865
  },
1857
1866
  {
1858
- "name": "required",
1867
+ "kind": "field",
1868
+ "name": "typedValue",
1869
+ "privacy": "public",
1859
1870
  "type": {
1860
- "text": "boolean"
1871
+ "text": "string"
1861
1872
  },
1862
- "description": "Populates the `required` attribute on the element. Used for client-side validation.",
1863
- "fieldName": "required"
1873
+ "description": "Specifies the value of the input element within the combobox.",
1874
+ "attribute": "typedValue",
1875
+ "reflects": true
1864
1876
  },
1865
1877
  {
1866
- "name": "setCustomValidity",
1878
+ "kind": "field",
1879
+ "name": "validity",
1880
+ "privacy": "public",
1867
1881
  "type": {
1868
1882
  "text": "string"
1869
1883
  },
1870
- "description": "Sets a custom help text message to display for all validityStates.",
1871
- "fieldName": "setCustomValidity"
1884
+ "description": "Specifies the `validityState` this element is in.",
1885
+ "attribute": "validity",
1886
+ "reflects": true
1872
1887
  },
1873
1888
  {
1874
- "name": "setCustomValidityCustomError",
1889
+ "kind": "field",
1890
+ "name": "value",
1891
+ "privacy": "public",
1875
1892
  "type": {
1876
1893
  "text": "string"
1877
1894
  },
1878
- "description": "Custom help text message to display when validity = `customError`.",
1879
- "fieldName": "setCustomValidityCustomError"
1895
+ "description": "Value selected for the dropdown menu.",
1896
+ "attribute": "value"
1880
1897
  },
1881
1898
  {
1882
- "name": "setCustomValidityValueMissing",
1899
+ "kind": "field",
1900
+ "name": "largeFullscreenHeadline",
1901
+ "privacy": "public",
1883
1902
  "type": {
1884
- "text": "string"
1903
+ "text": "boolean"
1885
1904
  },
1886
- "description": "Custom help text message to display when validity = `valueMissing`.",
1887
- "fieldName": "setCustomValidityValueMissing"
1905
+ "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
1906
+ "attribute": "largeFullscreenHeadline",
1907
+ "reflects": true
1888
1908
  },
1889
1909
  {
1890
- "name": "validity",
1910
+ "kind": "field",
1911
+ "name": "fullscreenBreakpoint",
1912
+ "privacy": "public",
1891
1913
  "type": {
1892
- "text": "string"
1914
+ "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
1893
1915
  },
1894
- "description": "Specifies the `validityState` this element is in.",
1895
- "fieldName": "validity"
1896
- }
1897
- ],
1898
- "superclass": {
1899
- "name": "LitElement",
1900
- "package": "lit"
1901
- },
1902
- "tagName": "auro-checkbox-group",
1903
- "customElement": true
1904
- }
1905
- ],
1906
- "exports": [
1907
- {
1908
- "kind": "js",
1909
- "name": "AuroCheckboxGroup",
1910
- "declaration": {
1911
- "name": "AuroCheckboxGroup",
1912
- "module": "components/checkbox/src/auro-checkbox-group.js"
1913
- }
1914
- }
1915
- ]
1916
- },
1917
- {
1918
- "kind": "javascript-module",
1919
- "path": "components/checkbox/src/auro-checkbox.js",
1920
- "declarations": [
1921
- {
1922
- "kind": "class",
1923
- "description": "The `auro-checkbox` element is for the purpose of allowing users to select one or more options of a limited number of choices.",
1924
- "name": "AuroCheckbox",
1925
- "cssParts": [
1926
- {
1927
- "description": "apply css to a specific checkbox.",
1928
- "name": "checkbox"
1929
- },
1930
- {
1931
- "description": "apply css to a specific checkbox's input.",
1932
- "name": "checkbox-input"
1933
- },
1934
- {
1935
- "description": "apply css to a specific checkbox's label.",
1936
- "name": "checkbox-label"
1937
- }
1938
- ],
1939
- "slots": [
1940
- {
1941
- "description": "The default slot for the checkbox label.",
1942
- "name": "default"
1943
- }
1944
- ],
1945
- "members": [
1946
- {
1947
- "kind": "method",
1948
- "name": "_initializeDefaults"
1949
- },
1950
- {
1951
- "kind": "method",
1952
- "name": "register",
1953
- "static": true,
1954
- "parameters": [
1955
- {
1956
- "name": "name",
1957
- "default": "\"auro-checkbox\"",
1958
- "description": "The name of element that you want to register to.",
1959
- "optional": true,
1960
- "type": {
1961
- "text": "string"
1962
- }
1963
- }
1964
- ],
1965
- "description": "This will register this element with the browser."
1916
+ "description": "Defines the screen size breakpointat which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.",
1917
+ "default": "'sm'",
1918
+ "attribute": "fullscreenBreakpoint",
1919
+ "reflects": true
1966
1920
  },
1967
1921
  {
1968
- "kind": "method",
1969
- "name": "handleChange",
1970
- "parameters": [
1971
- {
1972
- "name": "event",
1973
- "description": "The change event from the checkbox input.",
1974
- "type": {
1975
- "text": "Event"
1976
- }
1977
- }
1978
- ],
1979
- "description": "Handles the change event for the checkbox input.\nUpdates the checked state and dispatches a corresponding custom event.\nThis custom event is only for the purpose of supporting IE.",
1922
+ "kind": "field",
1923
+ "name": "optionActive",
1980
1924
  "privacy": "private",
1981
- "return": {
1982
- "type": {
1983
- "text": "void"
1984
- }
1985
- }
1925
+ "type": {
1926
+ "text": "object"
1927
+ },
1928
+ "description": "Specifies the currently active/highlighted `auro-menuoption`."
1986
1929
  },
1987
1930
  {
1988
- "kind": "method",
1989
- "name": "handleInput",
1990
- "parameters": [
1991
- {
1992
- "name": "event",
1993
- "description": "The input event from the checkbox input.",
1994
- "type": {
1995
- "text": "Event"
1996
- }
1997
- }
1998
- ],
1999
- "description": "Handles the input event for the checkbox input.\nUpdates the checked state and dispatches a custom 'auroCheckbox-input' event.",
1931
+ "kind": "field",
1932
+ "name": "componentHasFocus",
1933
+ "description": "Returns true if the element has focus.",
2000
1934
  "privacy": "private",
2001
1935
  "return": {
2002
1936
  "type": {
2003
- "text": "void"
1937
+ "text": "boolean"
2004
1938
  }
1939
+ },
1940
+ "readonly": true,
1941
+ "inheritedFrom": {
1942
+ "name": "AuroElement",
1943
+ "module": "components/layoutElement/src/auroElement.js"
2005
1944
  }
2006
1945
  },
2007
1946
  {
2008
1947
  "kind": "method",
2009
- "name": "handleFocusin",
2010
- "description": "Function to support",
2011
- "privacy": "private",
2012
- "return": {
2013
- "type": {
2014
- "text": "void"
2015
- }
1948
+ "name": "resetShapeClasses",
1949
+ "inheritedFrom": {
1950
+ "name": "AuroElement",
1951
+ "module": "components/layoutElement/src/auroElement.js"
2016
1952
  }
2017
1953
  },
2018
1954
  {
2019
1955
  "kind": "method",
2020
- "name": "generateIconHtml",
2021
- "description": "Function to generate checkmark svg.",
2022
- "privacy": "private",
2023
- "return": {
2024
- "type": {
2025
- "text": "HTMLElement"
2026
- }
1956
+ "name": "resetLayoutClasses",
1957
+ "inheritedFrom": {
1958
+ "name": "AuroElement",
1959
+ "module": "components/layoutElement/src/auroElement.js"
2027
1960
  }
2028
1961
  },
2029
1962
  {
2030
1963
  "kind": "method",
2031
- "name": "reset",
2032
- "description": "Resets component to initial state.",
2033
- "return": {
2034
- "type": {
2035
- "text": "void"
2036
- }
1964
+ "name": "updateComponentArchitecture",
1965
+ "inheritedFrom": {
1966
+ "name": "AuroElement",
1967
+ "module": "components/layoutElement/src/auroElement.js"
2037
1968
  }
2038
1969
  },
2039
1970
  {
2040
- "kind": "method",
2041
- "name": "updateAriaLabel",
2042
- "description": "Updates the aria-label based on slot content.",
2043
- "privacy": "private",
2044
- "return": {
2045
- "type": {
2046
- "text": "void"
2047
- }
1971
+ "kind": "field",
1972
+ "name": "shape",
1973
+ "privacy": "public",
1974
+ "type": {
1975
+ "text": "string"
1976
+ },
1977
+ "attribute": "shape",
1978
+ "reflects": true,
1979
+ "inheritedFrom": {
1980
+ "name": "AuroElement",
1981
+ "module": "components/layoutElement/src/auroElement.js"
2048
1982
  }
2049
1983
  },
2050
1984
  {
2051
- "kind": "method",
2052
- "name": "handleKeyDown",
2053
- "parameters": [
2054
- {
2055
- "name": "event",
2056
- "description": "The keydown event from the checkbox input.",
2057
- "type": {
2058
- "text": "KeyboardEvent"
2059
- }
2060
- }
2061
- ],
2062
- "description": "Handles keydown event to toggle the checkbox with Space key.",
2063
- "privacy": "private",
2064
- "return": {
2065
- "type": {
2066
- "text": "void"
2067
- }
1985
+ "kind": "field",
1986
+ "name": "size",
1987
+ "privacy": "public",
1988
+ "type": {
1989
+ "text": "string"
1990
+ },
1991
+ "attribute": "size",
1992
+ "reflects": true,
1993
+ "inheritedFrom": {
1994
+ "name": "AuroElement",
1995
+ "module": "components/layoutElement/src/auroElement.js"
2068
1996
  }
1997
+ }
1998
+ ],
1999
+ "events": [
2000
+ {
2001
+ "name": "inputValue",
2002
+ "type": {
2003
+ "text": "CustomEvent"
2004
+ },
2005
+ "description": "Notifies that the components internal HTML5 input value has changed."
2069
2006
  },
2070
2007
  {
2071
- "kind": "field",
2008
+ "name": "input",
2009
+ "type": {
2010
+ "text": "CustomEvent"
2011
+ },
2012
+ "description": "Notifies that the component has a new value set."
2013
+ },
2014
+ {
2015
+ "name": "auroCombobox-valueSet",
2016
+ "type": {
2017
+ "text": "CustomEvent"
2018
+ },
2019
+ "description": "(Deprecated) Notifies that the component has a new value set."
2020
+ },
2021
+ {
2022
+ "description": "Notifies that the component value(s) have been validated.",
2023
+ "name": "auroFormElement-validated"
2024
+ }
2025
+ ],
2026
+ "attributes": [
2027
+ {
2072
2028
  "name": "appearance",
2073
- "privacy": "public",
2074
2029
  "type": {
2075
- "text": "'default' | 'inverse'"
2030
+ "text": "string"
2076
2031
  },
2077
2032
  "description": "Defines whether the component will be on lighter or darker backgrounds.",
2078
2033
  "default": "'default'",
2079
- "attribute": "appearance",
2080
- "reflects": true
2034
+ "fieldName": "appearance"
2081
2035
  },
2082
2036
  {
2083
- "kind": "field",
2084
- "name": "checked",
2085
- "privacy": "public",
2037
+ "name": "autocomplete",
2038
+ "type": {
2039
+ "text": "string"
2040
+ },
2041
+ "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
2042
+ "fieldName": "autocomplete"
2043
+ },
2044
+ {
2045
+ "name": "autoPlacement",
2086
2046
  "type": {
2087
2047
  "text": "boolean"
2088
2048
  },
2089
- "description": "If set to true, the checkbox will be filled with a checkmark.",
2090
- "attribute": "checked",
2091
- "reflects": true
2049
+ "description": "If declared, bib's position will be automatically calculated where to appear.",
2050
+ "fieldName": "autoPlacement"
2051
+ },
2052
+ {
2053
+ "name": "availableOptions",
2054
+ "type": {
2055
+ "text": "array"
2056
+ },
2057
+ "description": "Array of available options to display in the dropdown.",
2058
+ "fieldName": "availableOptions"
2059
+ },
2060
+ {
2061
+ "name": "behavior",
2062
+ "type": {
2063
+ "text": "'filter' | 'suggestion'"
2064
+ },
2065
+ "description": "Sets the behavior of the combobox, \"filter\" or \"suggestion\".\n\"filter\" requires the user to select an option from the menu.\n\"suggestion\" allows the user to enter a value not present in the menu options.",
2066
+ "default": "'suggestion'",
2067
+ "fieldName": "behavior"
2068
+ },
2069
+ {
2070
+ "name": "checkmark",
2071
+ "type": {
2072
+ "text": "boolean"
2073
+ },
2074
+ "description": "When attribute is present auro-menu will apply check marks to selected options.",
2075
+ "fieldName": "checkmark"
2092
2076
  },
2093
2077
  {
2094
- "kind": "field",
2095
2078
  "name": "disabled",
2096
- "privacy": "public",
2097
2079
  "type": {
2098
2080
  "text": "boolean"
2099
2081
  },
2100
- "description": "If set to true, the checkbox will not be clickable.",
2101
- "attribute": "disabled",
2102
- "reflects": true
2082
+ "description": "If set, disables the combobox.",
2083
+ "fieldName": "disabled"
2103
2084
  },
2104
2085
  {
2105
- "kind": "field",
2106
- "name": "error",
2107
- "privacy": "public",
2086
+ "name": "dvInputOnly",
2108
2087
  "type": {
2109
2088
  "text": "boolean"
2110
2089
  },
2111
- "description": "If set to true, the checkbox will be displayed with an error state.",
2112
- "attribute": "error",
2113
- "reflects": true
2090
+ "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
2091
+ "fieldName": "dvInputOnly"
2114
2092
  },
2115
2093
  {
2116
- "kind": "field",
2117
- "name": "id",
2118
- "privacy": "public",
2094
+ "name": "error",
2119
2095
  "type": {
2120
2096
  "text": "string"
2121
2097
  },
2122
- "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
2123
- "attribute": "id"
2098
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
2099
+ "fieldName": "error"
2124
2100
  },
2125
2101
  {
2126
- "kind": "field",
2127
- "name": "inputId",
2128
- "privacy": "private",
2102
+ "name": "format",
2129
2103
  "type": {
2130
2104
  "text": "string"
2131
2105
  },
2132
- "description": "The id for input node."
2106
+ "description": "Specifies the input mask format.",
2107
+ "fieldName": "format"
2133
2108
  },
2134
2109
  {
2135
- "kind": "field",
2136
- "name": "name",
2137
- "privacy": "public",
2110
+ "name": "inputmode",
2138
2111
  "type": {
2139
2112
  "text": "string"
2140
2113
  },
2141
- "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
2142
- "attribute": "name"
2114
+ "description": "Exposes inputmode attribute for input.",
2115
+ "fieldName": "inputmode"
2143
2116
  },
2144
2117
  {
2145
- "kind": "field",
2146
- "name": "onDark",
2147
- "privacy": "public",
2118
+ "name": "layout",
2119
+ "type": {
2120
+ "text": "string"
2121
+ },
2122
+ "description": "Sets the layout of the combobox.",
2123
+ "default": "'classic'",
2124
+ "fieldName": "layout",
2125
+ "inheritedFrom": {
2126
+ "name": "AuroElement",
2127
+ "module": "components/layoutElement/src/auroElement.js"
2128
+ }
2129
+ },
2130
+ {
2131
+ "name": "matchWidth",
2148
2132
  "type": {
2149
2133
  "text": "boolean"
2150
2134
  },
2151
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2152
- "attribute": "onDark",
2153
- "reflects": true
2135
+ "description": "If declared, the popover and trigger will be set to the same width.",
2136
+ "fieldName": "matchWidth"
2137
+ },
2138
+ {
2139
+ "name": "noFilter",
2140
+ "type": {
2141
+ "text": "boolean"
2142
+ },
2143
+ "description": "If set, combobox will not filter menuoptions based on input.",
2144
+ "fieldName": "noFilter"
2145
+ },
2146
+ {
2147
+ "name": "noFlip",
2148
+ "type": {
2149
+ "text": "boolean"
2150
+ },
2151
+ "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
2152
+ "fieldName": "noFlip"
2154
2153
  },
2155
2154
  {
2156
- "kind": "field",
2157
- "name": "touched",
2158
- "privacy": "private",
2155
+ "name": "shift",
2159
2156
  "type": {
2160
2157
  "text": "boolean"
2161
2158
  },
2162
- "description": "Indicates whether the checkbox has been interacted with."
2159
+ "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
2160
+ "fieldName": "shift"
2163
2161
  },
2164
2162
  {
2165
- "kind": "field",
2166
- "name": "value",
2167
- "privacy": "public",
2163
+ "name": "noValidate",
2168
2164
  "type": {
2169
- "text": "string"
2165
+ "text": "boolean"
2170
2166
  },
2171
- "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
2172
- "attribute": "value"
2167
+ "description": "If set, disables auto-validation on blur.",
2168
+ "fieldName": "noValidate"
2173
2169
  },
2174
2170
  {
2175
- "kind": "field",
2176
- "name": "tabIndex",
2177
- "privacy": "private",
2171
+ "name": "offset",
2178
2172
  "type": {
2179
2173
  "text": "number"
2180
2174
  },
2181
- "description": "The tabindex attribute for the checkbox.",
2182
- "attribute": "tabindex",
2183
- "reflects": true
2175
+ "description": "Gap between the trigger element and bib.",
2176
+ "default": "0",
2177
+ "fieldName": "offset"
2184
2178
  },
2185
2179
  {
2186
- "kind": "field",
2187
- "name": "ariaChecked",
2188
- "privacy": "private",
2180
+ "name": "onDark",
2189
2181
  "type": {
2190
- "text": "string"
2182
+ "text": "boolean"
2191
2183
  },
2192
- "description": "The aria-checked attribute for the checkbox.",
2193
- "attribute": "aria-checked",
2194
- "reflects": true
2184
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2185
+ "fieldName": "onDark"
2195
2186
  },
2196
2187
  {
2197
- "kind": "field",
2198
- "name": "ariaDisabled",
2199
- "privacy": "private",
2188
+ "name": "optionSelected",
2200
2189
  "type": {
2201
- "text": "string"
2190
+ "text": "HTMLElement"
2202
2191
  },
2203
- "description": "The aria-disabled attribute for the checkbox.",
2204
- "attribute": "aria-disabled",
2205
- "reflects": true
2192
+ "description": "Specifies the current selected option.",
2193
+ "fieldName": "optionSelected"
2206
2194
  },
2207
2195
  {
2208
- "kind": "field",
2209
- "name": "role",
2210
- "privacy": "private",
2196
+ "name": "persistInput",
2211
2197
  "type": {
2212
- "text": "string"
2198
+ "text": "boolean"
2213
2199
  },
2214
- "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
2215
- "attribute": "role",
2216
- "reflects": true
2217
- }
2218
- ],
2219
- "events": [
2220
- {
2221
- "name": "auroCheckbox-input",
2222
- "type": {
2223
- "text": "CustomEvent"
2224
- }
2200
+ "description": "If declared, selecting a menu option will not change the input value. By doing so,\nthe current menu filter will be preserved and the user can continue from their last\nfilter state. It is recommended to use this in combination with the `displayValue` slot.",
2201
+ "fieldName": "persistInput"
2225
2202
  },
2226
2203
  {
2227
- "name": "auroCheckbox-focusin",
2204
+ "name": "placement",
2228
2205
  "type": {
2229
- "text": "CustomEvent"
2230
- }
2206
+ "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
2207
+ },
2208
+ "description": "Position where the bib should appear relative to the trigger.",
2209
+ "default": "'bottom-start'",
2210
+ "fieldName": "placement"
2231
2211
  },
2232
2212
  {
2233
- "name": "auroCheckbox-focusout",
2213
+ "name": "placeholder",
2234
2214
  "type": {
2235
- "text": "CustomEvent"
2236
- }
2215
+ "text": "string"
2216
+ },
2217
+ "description": "Define custom placeholder text, only supported by date input formats.",
2218
+ "fieldName": "placeholder"
2237
2219
  },
2238
2220
  {
2221
+ "name": "required",
2239
2222
  "type": {
2240
- "text": "CustomEvent<any>"
2223
+ "text": "boolean"
2241
2224
  },
2242
- "description": "(Deprecated) Notifies when checked value is changed.",
2243
- "name": "change"
2225
+ "description": "Populates the `required` attribute on the input. Used for client-side validation.",
2226
+ "fieldName": "required"
2244
2227
  },
2245
2228
  {
2229
+ "name": "setCustomValidity",
2246
2230
  "type": {
2247
- "text": "InputEvent"
2231
+ "text": "string"
2248
2232
  },
2249
- "description": "Notifies when when checked value is changed by user's interface.",
2250
- "name": "input"
2251
- }
2252
- ],
2253
- "attributes": [
2233
+ "description": "Sets a custom help text message to display for all validityStates.",
2234
+ "fieldName": "setCustomValidity"
2235
+ },
2254
2236
  {
2255
- "name": "appearance",
2237
+ "name": "setCustomValidityCustomError",
2256
2238
  "type": {
2257
- "text": "'default' | 'inverse'"
2239
+ "text": "string"
2258
2240
  },
2259
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
2260
- "default": "'default'",
2261
- "fieldName": "appearance"
2241
+ "description": "Custom help text message to display when validity = `customError`.",
2242
+ "fieldName": "setCustomValidityCustomError"
2262
2243
  },
2263
2244
  {
2264
- "name": "checked",
2245
+ "name": "setCustomValidityValueMissing",
2265
2246
  "type": {
2266
- "text": "boolean"
2247
+ "text": "string"
2267
2248
  },
2268
- "description": "If set to true, the checkbox will be filled with a checkmark.",
2269
- "fieldName": "checked"
2249
+ "description": "Custom help text message to display when validity = `valueMissing`.",
2250
+ "fieldName": "setCustomValidityValueMissing"
2270
2251
  },
2271
2252
  {
2272
- "name": "disabled",
2253
+ "name": "setCustomValidityValueMissingFilter",
2273
2254
  "type": {
2274
- "text": "boolean"
2255
+ "text": "string"
2275
2256
  },
2276
- "description": "If set to true, the checkbox will not be clickable.",
2277
- "fieldName": "disabled"
2257
+ "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
2258
+ "fieldName": "setCustomValidityValueMissingFilter"
2278
2259
  },
2279
2260
  {
2280
- "name": "error",
2261
+ "name": "triggerIcon",
2281
2262
  "type": {
2282
2263
  "text": "boolean"
2283
2264
  },
2284
- "description": "If set to true, the checkbox will be displayed with an error state.",
2285
- "fieldName": "error"
2265
+ "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.",
2266
+ "fieldName": "triggerIcon"
2286
2267
  },
2287
2268
  {
2288
- "name": "id",
2269
+ "name": "type",
2289
2270
  "type": {
2290
2271
  "text": "string"
2291
2272
  },
2292
- "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
2293
- "fieldName": "id"
2273
+ "description": "Applies the defined value as the type attribute on `auro-input`.",
2274
+ "fieldName": "type"
2294
2275
  },
2295
2276
  {
2296
- "name": "name",
2277
+ "name": "typedValue",
2297
2278
  "type": {
2298
2279
  "text": "string"
2299
2280
  },
2300
- "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
2301
- "fieldName": "name"
2281
+ "description": "Specifies the value of the input element within the combobox.",
2282
+ "fieldName": "typedValue"
2302
2283
  },
2303
2284
  {
2304
- "name": "onDark",
2285
+ "name": "validity",
2305
2286
  "type": {
2306
- "text": "boolean"
2287
+ "text": "string"
2307
2288
  },
2308
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2309
- "fieldName": "onDark"
2289
+ "description": "Specifies the `validityState` this element is in.",
2290
+ "fieldName": "validity"
2310
2291
  },
2311
2292
  {
2312
2293
  "name": "value",
2313
2294
  "type": {
2314
2295
  "text": "string"
2315
2296
  },
2316
- "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
2297
+ "description": "Value selected for the dropdown menu.",
2317
2298
  "fieldName": "value"
2318
2299
  },
2319
2300
  {
2320
- "name": "tabindex",
2301
+ "name": "largeFullscreenHeadline",
2321
2302
  "type": {
2322
- "text": "number"
2303
+ "text": "boolean"
2323
2304
  },
2324
- "description": "The tabindex attribute for the checkbox.",
2325
- "fieldName": "tabIndex"
2305
+ "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
2306
+ "fieldName": "largeFullscreenHeadline"
2326
2307
  },
2327
2308
  {
2328
- "name": "aria-checked",
2309
+ "name": "fullscreenBreakpoint",
2329
2310
  "type": {
2330
- "text": "string"
2311
+ "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
2331
2312
  },
2332
- "description": "The aria-checked attribute for the checkbox.",
2333
- "fieldName": "ariaChecked"
2313
+ "description": "Defines the screen size breakpointat which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.\n\nWhen expanded, the dropdown will automatically display in fullscreen mode\nif the screen size is equal to or smaller than the selected breakpoint.",
2314
+ "default": "'sm'",
2315
+ "fieldName": "fullscreenBreakpoint"
2334
2316
  },
2335
2317
  {
2336
- "name": "aria-disabled",
2318
+ "name": "shape",
2337
2319
  "type": {
2338
2320
  "text": "string"
2339
2321
  },
2340
- "description": "The aria-disabled attribute for the checkbox.",
2341
- "fieldName": "ariaDisabled"
2322
+ "fieldName": "shape",
2323
+ "inheritedFrom": {
2324
+ "name": "AuroElement",
2325
+ "module": "components/layoutElement/src/auroElement.js"
2326
+ }
2342
2327
  },
2343
2328
  {
2344
- "name": "role",
2329
+ "name": "size",
2345
2330
  "type": {
2346
2331
  "text": "string"
2347
2332
  },
2348
- "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
2349
- "fieldName": "role"
2333
+ "fieldName": "size",
2334
+ "inheritedFrom": {
2335
+ "name": "AuroElement",
2336
+ "module": "components/layoutElement/src/auroElement.js"
2337
+ }
2338
+ },
2339
+ {
2340
+ "name": "ondark",
2341
+ "type": {
2342
+ "text": "boolean"
2343
+ },
2344
+ "fieldName": "onDark",
2345
+ "inheritedFrom": {
2346
+ "name": "AuroElement",
2347
+ "module": "components/layoutElement/src/auroElement.js"
2348
+ }
2350
2349
  }
2351
2350
  ],
2352
2351
  "superclass": {
2353
- "name": "LitElement",
2354
- "package": "lit"
2352
+ "name": "AuroElement",
2353
+ "module": "/components/layoutElement/src/auroElement.js"
2355
2354
  },
2356
- "tagName": "auro-checkbox",
2355
+ "tagName": "auro-combobox",
2357
2356
  "customElement": true
2358
2357
  }
2359
2358
  ],
2360
2359
  "exports": [
2361
2360
  {
2362
2361
  "kind": "js",
2363
- "name": "AuroCheckbox",
2362
+ "name": "AuroCombobox",
2364
2363
  "declaration": {
2365
- "name": "AuroCheckbox",
2366
- "module": "components/checkbox/src/auro-checkbox.js"
2364
+ "name": "AuroCombobox",
2365
+ "module": "components/combobox/src/auro-combobox.js"
2367
2366
  }
2368
2367
  }
2369
2368
  ]
2370
2369
  },
2371
2370
  {
2372
2371
  "kind": "javascript-module",
2373
- "path": "components/checkbox/src/index.js",
2372
+ "path": "components/combobox/src/index.js",
2374
2373
  "declarations": [],
2375
2374
  "exports": [
2376
2375
  {
2377
2376
  "kind": "js",
2378
- "name": "AuroCheckbox",
2379
- "declaration": {
2380
- "name": "AuroCheckbox",
2381
- "module": "components/checkbox/src/index.js"
2382
- }
2383
- },
2384
- {
2385
- "kind": "js",
2386
- "name": "AuroCheckboxGroup",
2377
+ "name": "AuroCombobox",
2387
2378
  "declaration": {
2388
- "name": "AuroCheckboxGroup",
2389
- "module": "components/checkbox/src/index.js"
2379
+ "name": "AuroCombobox",
2380
+ "module": "components/combobox/src/index.js"
2390
2381
  }
2391
2382
  }
2392
2383
  ]
2393
2384
  },
2394
2385
  {
2395
2386
  "kind": "javascript-module",
2396
- "path": "components/checkbox/src/registered.js",
2387
+ "path": "components/combobox/src/registered.js",
2397
2388
  "declarations": [],
2398
- "exports": []
2389
+ "exports": [
2390
+ {
2391
+ "kind": "js",
2392
+ "name": "AuroCombobox",
2393
+ "declaration": {
2394
+ "name": "AuroCombobox",
2395
+ "module": "components/combobox/src/registered.js"
2396
+ }
2397
+ }
2398
+ ]
2399
2399
  },
2400
2400
  {
2401
2401
  "kind": "javascript-module",
@@ -9770,11 +9770,6 @@
9770
9770
  "name": "commonDisplayValueWrapperClasses",
9771
9771
  "description": "Common display value wrapper classes.",
9772
9772
  "privacy": "private",
9773
- "return": {
9774
- "type": {
9775
- "text": "Record<string, boolean>"
9776
- }
9777
- },
9778
9773
  "readonly": true
9779
9774
  },
9780
9775
  {
@@ -10422,7 +10417,7 @@
10422
10417
  "privacy": "private",
10423
10418
  "return": {
10424
10419
  "type": {
10425
- "text": "string"
10420
+ "text": "void"
10426
10421
  }
10427
10422
  },
10428
10423
  "readonly": true,
@@ -12272,7 +12267,7 @@
12272
12267
  "privacy": "private",
12273
12268
  "return": {
12274
12269
  "type": {
12275
- "text": "string"
12270
+ "text": "void"
12276
12271
  }
12277
12272
  },
12278
12273
  "readonly": true