@aurodesignsystem-dev/auro-formkit 0.0.0-pr1345.1 → 0.0.0-pr1345.2

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