@aurodesignsystem-dev/auro-formkit 0.0.0-pr1533.13 → 0.0.0-pr1533.14

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 (71) hide show
  1. package/components/checkbox/demo/customize.min.js +1 -1
  2. package/components/checkbox/demo/getting-started.min.js +1 -1
  3. package/components/checkbox/demo/index.min.js +1 -1
  4. package/components/checkbox/dist/index.js +1 -1
  5. package/components/checkbox/dist/registered.js +1 -1
  6. package/components/combobox/demo/api.md +2 -2
  7. package/components/combobox/demo/customize.md +1 -1
  8. package/components/combobox/demo/customize.min.js +110 -22
  9. package/components/combobox/demo/getting-started.min.js +110 -22
  10. package/components/combobox/demo/index.md +1 -0
  11. package/components/combobox/demo/index.min.js +110 -22
  12. package/components/combobox/demo/keyboard-behavior.md +1 -4
  13. package/components/combobox/dist/auro-combobox.d.ts +3 -1
  14. package/components/combobox/dist/index.js +23 -4
  15. package/components/combobox/dist/registered.js +23 -4
  16. package/components/counter/demo/customize.min.js +2 -2
  17. package/components/counter/demo/index.min.js +2 -2
  18. package/components/counter/dist/index.js +2 -2
  19. package/components/counter/dist/registered.js +2 -2
  20. package/components/datepicker/demo/customize.min.js +3 -3
  21. package/components/datepicker/demo/index.min.js +3 -3
  22. package/components/datepicker/dist/index.js +3 -3
  23. package/components/datepicker/dist/registered.js +3 -3
  24. package/components/dropdown/demo/customize.min.js +1 -1
  25. package/components/dropdown/demo/getting-started.min.js +1 -1
  26. package/components/dropdown/demo/index.min.js +1 -1
  27. package/components/dropdown/dist/index.js +1 -1
  28. package/components/dropdown/dist/registered.js +1 -1
  29. package/components/form/demo/customize.min.js +125 -33
  30. package/components/form/demo/getting-started.min.js +125 -33
  31. package/components/form/demo/index.min.js +125 -33
  32. package/components/form/demo/registerDemoDeps.min.js +125 -33
  33. package/components/input/demo/customize.min.js +1 -1
  34. package/components/input/demo/getting-started.min.js +1 -1
  35. package/components/input/demo/index.min.js +1 -1
  36. package/components/input/dist/index.js +1 -1
  37. package/components/input/dist/registered.js +1 -1
  38. package/components/menu/demo/accessibility.md +4 -4
  39. package/components/menu/demo/api.md +26 -19
  40. package/components/menu/demo/css-only.md +26 -19
  41. package/components/menu/demo/customize.md +307 -47
  42. package/components/menu/demo/design.md +1 -1
  43. package/components/menu/demo/getting-started.md +144 -7
  44. package/components/menu/demo/index.min.js +214 -19
  45. package/components/menu/demo/keyboard-behavior.md +83 -4
  46. package/components/menu/demo/voiceover.md +12 -8
  47. package/components/menu/demo/why-menu.md +8 -9
  48. package/components/menu/dist/auro-menu-utils.d.ts +19 -0
  49. package/components/menu/dist/auro-menu.d.ts +4 -8
  50. package/components/menu/dist/auro-menuoption.d.ts +12 -0
  51. package/components/menu/dist/index.js +87 -18
  52. package/components/menu/dist/registered.js +87 -18
  53. package/components/radio/demo/customize.min.js +1 -1
  54. package/components/radio/demo/getting-started.min.js +1 -1
  55. package/components/radio/demo/index.min.js +1 -1
  56. package/components/radio/dist/index.js +1 -1
  57. package/components/radio/dist/registered.js +1 -1
  58. package/components/select/demo/api.md +2 -2
  59. package/components/select/demo/customize.md +5 -2
  60. package/components/select/demo/customize.min.js +94 -21
  61. package/components/select/demo/design.md +10 -10
  62. package/components/select/demo/getting-started.md +1 -1
  63. package/components/select/demo/getting-started.min.js +94 -21
  64. package/components/select/demo/index.md +2 -2
  65. package/components/select/demo/index.min.js +94 -21
  66. package/components/select/demo/keyboard-behavior.md +49 -18
  67. package/components/select/dist/auro-select.d.ts +6 -2
  68. package/components/select/dist/index.js +7 -3
  69. package/components/select/dist/registered.js +7 -3
  70. package/custom-elements.json +1608 -1534
  71. package/package.json +1 -1
@@ -267,34 +267,107 @@
267
267
  },
268
268
  {
269
269
  "kind": "javascript-module",
270
- "path": "components/checkbox/src/auro-checkbox-group.js",
270
+ "path": "components/combobox/src/auro-combobox.js",
271
271
  "declarations": [
272
272
  {
273
273
  "kind": "class",
274
- "description": "The `auro-checkbox-group` element is a wrapper for `auro-checkbox` elements.",
275
- "name": "AuroCheckboxGroup",
274
+ "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.",
275
+ "name": "AuroCombobox",
276
276
  "slots": [
277
277
  {
278
- "description": "Allows for the legend to be overridden.",
279
- "name": "legend"
278
+ "description": "Default slot for the menu content.",
279
+ "name": ""
280
280
  },
281
281
  {
282
+ "type": {
283
+ "text": "HTMLSlotElement"
284
+ },
282
285
  "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
283
286
  "name": "optionalLabel"
284
287
  },
285
288
  {
286
- "description": "Allows for the helper text to be overridden.",
289
+ "description": "Sets aria-label on clear button",
290
+ "name": "ariaLabel.input.clear"
291
+ },
292
+ {
293
+ "description": "Sets aria-label on close button in fullscreen bib",
294
+ "name": "ariaLabel.bib.close"
295
+ },
296
+ {
297
+ "description": "Defines the headline to display above menu-options",
298
+ "name": "bib.fullscreen.headline"
299
+ },
300
+ {
301
+ "description": "Defines the content of the label.",
302
+ "name": "label"
303
+ },
304
+ {
305
+ "description": "Defines the content of the helpText.",
287
306
  "name": "helpText"
288
307
  },
289
308
  {
290
- "description": "The default slot for the checkbox items.",
291
- "name": "default"
309
+ "description": "Allows custom HTML content to display the selected value when the combobox is not focused. Only works with `snowflake` and `emphasized` layouts.",
310
+ "name": "displayValue"
292
311
  }
293
312
  ],
294
313
  "members": [
295
314
  {
296
315
  "kind": "method",
297
- "name": "_initializeDefaults"
316
+ "name": "_initializeDefaults",
317
+ "privacy": "private",
318
+ "return": {
319
+ "type": {
320
+ "text": "void"
321
+ }
322
+ }
323
+ },
324
+ {
325
+ "kind": "method",
326
+ "name": "_scheduleTimer",
327
+ "parameters": [
328
+ {
329
+ "name": "fn",
330
+ "description": "Callback to run.",
331
+ "type": {
332
+ "text": "Function"
333
+ }
334
+ },
335
+ {
336
+ "name": "ms",
337
+ "description": "Delay in milliseconds.",
338
+ "type": {
339
+ "text": "number"
340
+ }
341
+ }
342
+ ],
343
+ "description": "Wraps setTimeout and records the timer id so disconnectedCallback\ncan cancel any outstanding callbacks. The id is removed from the set\nonce the callback fires so the set doesn't grow unbounded.",
344
+ "return": {
345
+ "type": {
346
+ "text": "number"
347
+ }
348
+ },
349
+ "privacy": "private"
350
+ },
351
+ {
352
+ "kind": "field",
353
+ "name": "inputValue",
354
+ "description": "Returns the current value of the input element within the combobox.",
355
+ "return": {
356
+ "type": {
357
+ "text": "string|undefined"
358
+ }
359
+ },
360
+ "readonly": true
361
+ },
362
+ {
363
+ "kind": "method",
364
+ "name": "isValid",
365
+ "description": "Checks if the element is valid.",
366
+ "return": {
367
+ "type": {
368
+ "text": "boolean"
369
+ }
370
+ }
298
371
  },
299
372
  {
300
373
  "kind": "method",
@@ -303,7 +376,7 @@
303
376
  "parameters": [
304
377
  {
305
378
  "name": "name",
306
- "default": "\"auro-checkbox-group\"",
379
+ "default": "'auro-combobox'",
307
380
  "description": "The name of the element that you want to register.",
308
381
  "optional": true,
309
382
  "type": {
@@ -315,24 +388,96 @@
315
388
  },
316
389
  {
317
390
  "kind": "method",
318
- "name": "handleValueUpdate",
391
+ "name": "activateFirstEnabledAvailableOption",
392
+ "description": "Mark the first available (non-hidden), enabled option as `active`.",
393
+ "privacy": "private",
394
+ "return": {
395
+ "type": {
396
+ "text": "void"
397
+ }
398
+ }
399
+ },
400
+ {
401
+ "kind": "method",
402
+ "name": "activateLastEnabledAvailableOption",
403
+ "description": "Mark the last available (non-hidden), enabled option as `active`.",
404
+ "privacy": "private",
405
+ "return": {
406
+ "type": {
407
+ "text": "void"
408
+ }
409
+ }
410
+ },
411
+ {
412
+ "kind": "method",
413
+ "name": "updateFilter",
414
+ "description": "Updates the filter for the available options based on the input value.",
415
+ "privacy": "private"
416
+ },
417
+ {
418
+ "kind": "method",
419
+ "name": "syncValuesAndStates",
420
+ "description": "Syncs the values and states of this component, the input, and the menu, including this.optionSelected and this.menu.optionSelected.",
421
+ "privacy": "private",
422
+ "return": {
423
+ "type": {
424
+ "text": "void"
425
+ }
426
+ }
427
+ },
428
+ {
429
+ "kind": "method",
430
+ "name": "updateTriggerTextDisplay",
319
431
  "parameters": [
320
432
  {
321
- "name": "value",
322
- "description": "The value of the checkbox.",
433
+ "name": "label",
434
+ "description": "The label of the selected option.",
323
435
  "type": {
324
- "text": "String"
436
+ "text": "string"
437
+ }
438
+ }
439
+ ],
440
+ "description": "Update displayValue or input.value, it's called when making a selection.",
441
+ "privacy": "private"
442
+ },
443
+ {
444
+ "kind": "method",
445
+ "name": "syncInputValuesAcrossTriggerAndBib",
446
+ "parameters": [
447
+ {
448
+ "name": "nextValue",
449
+ "description": "The value to write to both inputs.",
450
+ "type": {
451
+ "text": "string"
325
452
  }
453
+ }
454
+ ],
455
+ "description": "Writes nextValue to the trigger input and the bib input when their current\nvalue differs, then re-asserts imask after Lit's update flushes.",
456
+ "return": {
457
+ "type": {
458
+ "text": "Promise<void>"
459
+ }
460
+ },
461
+ "privacy": "private"
462
+ },
463
+ {
464
+ "kind": "method",
465
+ "name": "handleMenuOptions",
466
+ "parameters": [
467
+ {
468
+ "name": "{ preferComboboxValue = false }",
469
+ "default": "{}"
326
470
  },
327
471
  {
328
- "name": "selected",
329
- "description": "The checked state of the checkbox.",
472
+ "description": "Optional flag bag.",
473
+ "name": "options",
474
+ "optional": true,
330
475
  "type": {
331
- "text": "Boolean"
476
+ "text": "@param {boolean} [options.preferComboboxValue=false] - When true,\n * handleMenuOptions matches the selected option against `this.value`\n * first instead of `this.input.value`. Needed on mount and re-mount\n * because under `persistInput` the consumer's typedValue prop can drift\n * from the framework value (Svelte `{#key}` re-mount after a swap, or\n * SPA preselect after route change) and the old input-first match would\n * then pick the stale text. Only handleSlotChange passes this; typing\n * and clearing paths keep the input-first match so user clears aren't\n * undone.\n * "
332
477
  }
333
478
  }
334
479
  ],
335
- "description": "Helper method to handle checkbox value changing.",
480
+ "description": "Processes hidden state of all menu options and determines if there are any available options not hidden.",
336
481
  "privacy": "private",
337
482
  "return": {
338
483
  "type": {
@@ -342,8 +487,8 @@
342
487
  },
343
488
  {
344
489
  "kind": "method",
345
- "name": "handlePreselectedItems",
346
- "description": "Helper method that handles the state of preselected checkboxes.",
490
+ "name": "generateOptionsArray",
491
+ "description": "Determines the element error state based on the `required` attribute and input value.",
347
492
  "privacy": "private",
348
493
  "return": {
349
494
  "type": {
@@ -353,9 +498,8 @@
353
498
  },
354
499
  {
355
500
  "kind": "method",
356
- "name": "handleItems",
357
- "description": "Helper method that handles the state of checkboxes.",
358
- "privacy": "private",
501
+ "name": "hideBib",
502
+ "description": "Hides the dropdown bib if its open.",
359
503
  "return": {
360
504
  "type": {
361
505
  "text": "void"
@@ -364,8 +508,8 @@
364
508
  },
365
509
  {
366
510
  "kind": "method",
367
- "name": "reset",
368
- "description": "Resets component to initial state.",
511
+ "name": "showBib",
512
+ "description": "Shows the dropdown bib if there are options to show.",
369
513
  "return": {
370
514
  "type": {
371
515
  "text": "void"
@@ -374,325 +518,252 @@
374
518
  },
375
519
  {
376
520
  "kind": "method",
377
- "name": "validate",
378
- "parameters": [
379
- {
380
- "name": "force",
381
- "default": "false",
382
- "description": "Whether to force validation.",
383
- "optional": true,
384
- "type": {
385
- "text": "boolean"
386
- }
521
+ "name": "configureDropdown",
522
+ "description": "Binds all behavior needed to the dropdown after rendering.",
523
+ "privacy": "private",
524
+ "return": {
525
+ "type": {
526
+ "text": "void"
387
527
  }
388
- ],
389
- "description": "Validates value."
528
+ }
390
529
  },
391
530
  {
392
- "kind": "field",
393
- "name": "appearance",
394
- "privacy": "public",
395
- "type": {
396
- "text": "'default' | 'inverse'"
397
- },
398
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
399
- "default": "'default'",
400
- "attribute": "appearance",
401
- "reflects": true
531
+ "kind": "method",
532
+ "name": "setClearBtnFocus",
533
+ "privacy": "private"
402
534
  },
403
535
  {
404
- "kind": "field",
405
- "name": "disabled",
406
- "privacy": "public",
407
- "type": {
408
- "text": "boolean"
409
- },
410
- "description": "If set, disables the checkbox group.",
411
- "attribute": "disabled",
412
- "reflects": true
536
+ "kind": "method",
537
+ "name": "setTriggerInputFocus",
538
+ "privacy": "private"
413
539
  },
414
540
  {
415
- "kind": "field",
416
- "name": "error",
417
- "privacy": "public",
418
- "type": {
419
- "text": "string"
420
- },
421
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
422
- "attribute": "error",
423
- "reflects": true
541
+ "kind": "method",
542
+ "name": "setInputFocus",
543
+ "privacy": "private"
424
544
  },
425
545
  {
426
- "kind": "field",
427
- "name": "horizontal",
428
- "privacy": "public",
429
- "type": {
430
- "text": "boolean"
431
- },
432
- "description": "If set, checkboxes will be aligned horizontally.",
433
- "attribute": "horizontal",
434
- "reflects": true
546
+ "kind": "method",
547
+ "name": "updateBibDialogRole",
548
+ "description": "Suppresses or restores dialog semantics on the bib's dialog element.\nOn desktop (non-fullscreen), VoiceOver verbosely announces \"listbox inside\nof a dialog\" which disrupts combobox usage. Setting role=\"presentation\"\nsuppresses this. In fullscreen mode, dialog semantics are restored.",
549
+ "privacy": "private"
435
550
  },
436
551
  {
437
- "kind": "field",
438
- "name": "noValidate",
439
- "privacy": "public",
440
- "type": {
441
- "text": "boolean"
442
- },
443
- "description": "If set, disables auto-validation on blur.",
444
- "attribute": "noValidate",
445
- "reflects": true
552
+ "kind": "method",
553
+ "name": "updateMenuShapeSize",
554
+ "description": "Update menu to default for fullscreen bib, otherwise to this.size and this.shape.",
555
+ "privacy": "private"
446
556
  },
447
557
  {
448
- "kind": "field",
449
- "name": "onDark",
450
- "privacy": "public",
451
- "type": {
452
- "text": "boolean"
453
- },
454
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
455
- "attribute": "onDark",
456
- "reflects": true
558
+ "kind": "method",
559
+ "name": "_getAnnouncementRoot",
560
+ "description": "Returns the shadow root containing the live region for screen reader announcements.\nWhen the bib is open in fullscreen modal mode, everything outside the <dialog>\nis inert, so we target the bib's own shadow root instead of the host's.",
561
+ "privacy": "private",
562
+ "return": {
563
+ "type": {
564
+ "text": "ShadowRoot"
565
+ }
566
+ }
457
567
  },
458
568
  {
459
- "kind": "field",
460
- "name": "required",
461
- "privacy": "public",
462
- "type": {
463
- "text": "boolean"
464
- },
465
- "description": "Populates the `required` attribute on the element. Used for client-side validation.",
466
- "attribute": "required",
467
- "reflects": true
569
+ "kind": "method",
570
+ "name": "configureMenu",
571
+ "description": "Binds all behavior needed to the menu after rendering.",
572
+ "privacy": "private",
573
+ "return": {
574
+ "type": {
575
+ "text": "void"
576
+ }
577
+ }
468
578
  },
469
579
  {
470
- "kind": "field",
471
- "name": "setCustomValidity",
472
- "privacy": "public",
473
- "type": {
474
- "text": "string"
475
- },
476
- "description": "Sets a custom help text message to display for all validityStates.",
477
- "attribute": "setCustomValidity"
580
+ "kind": "method",
581
+ "name": "configureInput",
582
+ "description": "Binds all behavior needed to the input after rendering.",
583
+ "privacy": "private",
584
+ "return": {
585
+ "type": {
586
+ "text": "void"
587
+ }
588
+ }
478
589
  },
479
590
  {
480
- "kind": "field",
481
- "name": "setCustomValidityCustomError",
482
- "privacy": "public",
483
- "type": {
484
- "text": "string"
485
- },
486
- "description": "Custom help text message to display when validity = `customError`.",
487
- "attribute": "setCustomValidityCustomError"
591
+ "kind": "method",
592
+ "name": "handleMenuLoadingChange",
593
+ "parameters": [
594
+ {
595
+ "name": "event",
596
+ "description": "The event object containing details about the loading state change.",
597
+ "type": {
598
+ "text": "CustomEvent"
599
+ }
600
+ },
601
+ {
602
+ "description": "Indicates whether the menu is currently loading.",
603
+ "name": "event.detail.loading",
604
+ "type": {
605
+ "text": "boolean"
606
+ }
607
+ },
608
+ {
609
+ "description": "Indicates if there are loading placeholders present.",
610
+ "name": "event.detail.hasLoadingPlaceholder",
611
+ "type": {
612
+ "text": "boolean"
613
+ }
614
+ }
615
+ ],
616
+ "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.",
617
+ "privacy": "private",
618
+ "return": {
619
+ "type": {
620
+ "text": "void"
621
+ }
622
+ }
488
623
  },
489
624
  {
490
- "kind": "field",
491
- "name": "setCustomValidityValueMissing",
492
- "privacy": "public",
493
- "type": {
494
- "text": "string"
495
- },
496
- "description": "Custom help text message to display when validity = `valueMissing`.",
497
- "attribute": "setCustomValidityValueMissing"
625
+ "kind": "method",
626
+ "name": "handleInputValueChange",
627
+ "parameters": [
628
+ {
629
+ "name": "event",
630
+ "description": "The input event triggered by the input element.",
631
+ "type": {
632
+ "text": "Event"
633
+ }
634
+ }
635
+ ],
636
+ "description": "Handle changes to the input value and trigger changes that should result.",
637
+ "privacy": "private",
638
+ "return": {
639
+ "type": {
640
+ "text": "void"
641
+ }
642
+ }
498
643
  },
499
644
  {
500
- "kind": "field",
501
- "name": "validity",
502
- "privacy": "public",
503
- "type": {
504
- "text": "string"
505
- },
506
- "description": "Specifies the `validityState` this element is in.",
507
- "attribute": "validity",
508
- "reflects": true
509
- }
510
- ],
511
- "events": [
512
- {
513
- "name": "input",
514
- "type": {
515
- "text": "CustomEvent"
645
+ "kind": "method",
646
+ "name": "handleTriggerInputValueChange",
647
+ "parameters": [
648
+ {
649
+ "name": "event",
650
+ "description": "The input event from the trigger input element.",
651
+ "type": {
652
+ "text": "Event"
653
+ }
654
+ }
655
+ ],
656
+ "description": "Handles input value changes originating from the trigger input.\nRefreshes menu options and filtering, delegates to handleInputValueChange\nfor value synchronization, and manages fullscreen bib focus.",
657
+ "privacy": "private",
658
+ "return": {
659
+ "type": {
660
+ "text": "void"
661
+ }
516
662
  }
517
663
  },
518
664
  {
519
- "description": "Notifies that the `validity` and `errorMessage` values have changed.",
520
- "name": "auroFormElement-validated"
521
- }
522
- ],
523
- "attributes": [
665
+ "kind": "method",
666
+ "name": "configureCombobox",
667
+ "description": "Binds all behavior needed to the combobox after rendering.",
668
+ "privacy": "private",
669
+ "return": {
670
+ "type": {
671
+ "text": "void"
672
+ }
673
+ }
674
+ },
524
675
  {
525
- "name": "appearance",
526
- "type": {
527
- "text": "'default' | 'inverse'"
528
- },
529
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
530
- "default": "'default'",
531
- "fieldName": "appearance"
676
+ "kind": "method",
677
+ "name": "focus",
678
+ "description": "Focuses the combobox trigger input.",
679
+ "return": {
680
+ "type": {
681
+ "text": "void"
682
+ }
683
+ }
532
684
  },
533
685
  {
534
- "name": "disabled",
535
- "type": {
536
- "text": "boolean"
537
- },
538
- "description": "If set, disables the checkbox group.",
539
- "fieldName": "disabled"
686
+ "kind": "method",
687
+ "name": "setMenuValue",
688
+ "parameters": [
689
+ {
690
+ "name": "value",
691
+ "description": "The value to set on the menu.",
692
+ "type": {
693
+ "text": "string"
694
+ }
695
+ }
696
+ ],
697
+ "description": "Sets the menu value if menu is available.",
698
+ "return": {
699
+ "type": {
700
+ "text": "void"
701
+ }
702
+ }
540
703
  },
541
704
  {
542
- "name": "error",
543
- "type": {
544
- "text": "string"
545
- },
546
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
547
- "fieldName": "error"
705
+ "kind": "method",
706
+ "name": "reset",
707
+ "description": "Resets component to initial state.",
708
+ "return": {
709
+ "type": {
710
+ "text": "void"
711
+ }
712
+ }
548
713
  },
549
714
  {
550
- "name": "horizontal",
551
- "type": {
552
- "text": "boolean"
553
- },
554
- "description": "If set, checkboxes will be aligned horizontally.",
555
- "fieldName": "horizontal"
556
- },
557
- {
558
- "name": "noValidate",
559
- "type": {
560
- "text": "boolean"
561
- },
562
- "description": "If set, disables auto-validation on blur.",
563
- "fieldName": "noValidate"
564
- },
565
- {
566
- "name": "onDark",
567
- "type": {
568
- "text": "boolean"
569
- },
570
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
571
- "fieldName": "onDark"
572
- },
573
- {
574
- "name": "required",
575
- "type": {
576
- "text": "boolean"
577
- },
578
- "description": "Populates the `required` attribute on the element. Used for client-side validation.",
579
- "fieldName": "required"
580
- },
581
- {
582
- "name": "setCustomValidity",
583
- "type": {
584
- "text": "string"
585
- },
586
- "description": "Sets a custom help text message to display for all validityStates.",
587
- "fieldName": "setCustomValidity"
588
- },
589
- {
590
- "name": "setCustomValidityCustomError",
591
- "type": {
592
- "text": "string"
593
- },
594
- "description": "Custom help text message to display when validity = `customError`.",
595
- "fieldName": "setCustomValidityCustomError"
596
- },
597
- {
598
- "name": "setCustomValidityValueMissing",
599
- "type": {
600
- "text": "string"
601
- },
602
- "description": "Custom help text message to display when validity = `valueMissing`.",
603
- "fieldName": "setCustomValidityValueMissing"
604
- },
605
- {
606
- "name": "validity",
607
- "type": {
608
- "text": "string"
609
- },
610
- "description": "Specifies the `validityState` this element is in.",
611
- "fieldName": "validity"
612
- }
613
- ],
614
- "superclass": {
615
- "name": "LitElement",
616
- "package": "lit"
617
- },
618
- "tagName": "auro-checkbox-group",
619
- "customElement": true
620
- }
621
- ],
622
- "exports": [
623
- {
624
- "kind": "js",
625
- "name": "AuroCheckboxGroup",
626
- "declaration": {
627
- "name": "AuroCheckboxGroup",
628
- "module": "components/checkbox/src/auro-checkbox-group.js"
629
- }
630
- }
631
- ]
632
- },
633
- {
634
- "kind": "javascript-module",
635
- "path": "components/checkbox/src/auro-checkbox.js",
636
- "declarations": [
637
- {
638
- "kind": "class",
639
- "description": "The `auro-checkbox` element is for the purpose of allowing users to select one or more options of a limited number of choices.",
640
- "name": "AuroCheckbox",
641
- "cssParts": [
642
- {
643
- "description": "apply css to a specific checkbox.",
644
- "name": "checkbox"
645
- },
646
- {
647
- "description": "apply css to a specific checkbox's input.",
648
- "name": "checkbox-input"
649
- },
650
- {
651
- "description": "apply css to a specific checkbox's label.",
652
- "name": "checkbox-label"
653
- }
654
- ],
655
- "slots": [
656
- {
657
- "description": "The default slot for the checkbox label.",
658
- "name": "default"
659
- }
660
- ],
661
- "members": [
662
- {
663
- "kind": "method",
664
- "name": "_initializeDefaults"
715
+ "kind": "method",
716
+ "name": "clear",
717
+ "description": "Clears the current value of the combobox.",
718
+ "return": {
719
+ "type": {
720
+ "text": "void"
721
+ }
722
+ }
665
723
  },
666
724
  {
667
725
  "kind": "method",
668
- "name": "register",
669
- "static": true,
726
+ "name": "validate",
670
727
  "parameters": [
671
728
  {
672
- "name": "name",
673
- "default": "\"auro-checkbox\"",
674
- "description": "The name of element that you want to register to.",
729
+ "name": "force",
730
+ "default": "false",
731
+ "description": "Whether to force validation.",
675
732
  "optional": true,
676
733
  "type": {
677
- "text": "string"
734
+ "text": "boolean"
678
735
  }
679
736
  }
680
737
  ],
681
- "description": "This will register this element with the browser."
738
+ "description": "Validates value."
682
739
  },
683
740
  {
684
741
  "kind": "method",
685
- "name": "handleChange",
742
+ "name": "transportAssignedNodes",
686
743
  "parameters": [
687
744
  {
688
- "name": "event",
689
- "description": "The change event from the checkbox input.",
745
+ "name": "slot",
746
+ "description": "The slot element containing the nodes to apply.",
690
747
  "type": {
691
- "text": "Event"
748
+ "text": "HTMLSlotElement"
749
+ }
750
+ },
751
+ {
752
+ "name": "target",
753
+ "description": "The target element to apply the nodes to.",
754
+ "type": {
755
+ "text": "HTMLElement"
756
+ }
757
+ },
758
+ {
759
+ "name": "newSlotName",
760
+ "description": "The new slot name for the applied nodes.",
761
+ "type": {
762
+ "text": "string"
692
763
  }
693
764
  }
694
765
  ],
695
- "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.",
766
+ "description": "Applies slotted nodes to a target element with a new slot name.",
696
767
  "privacy": "private",
697
768
  "return": {
698
769
  "type": {
@@ -702,80 +773,31 @@
702
773
  },
703
774
  {
704
775
  "kind": "method",
705
- "name": "handleInput",
776
+ "name": "updateActiveOption",
706
777
  "parameters": [
707
778
  {
708
- "name": "event",
709
- "description": "The input event from the checkbox input.",
779
+ "name": "index",
780
+ "description": "Index of the option to make active.",
710
781
  "type": {
711
- "text": "Event"
782
+ "text": "number"
712
783
  }
713
784
  }
714
785
  ],
715
- "description": "Handles the input event for the checkbox input.\nUpdates the checked state and dispatches a custom 'auroCheckbox-input' event.",
716
- "privacy": "private",
717
- "return": {
718
- "type": {
719
- "text": "void"
720
- }
721
- }
722
- },
723
- {
724
- "kind": "method",
725
- "name": "handleFocusin",
726
- "description": "Function to support",
727
- "privacy": "private",
728
- "return": {
729
- "type": {
730
- "text": "void"
731
- }
732
- }
733
- },
734
- {
735
- "kind": "method",
736
- "name": "generateIconHtml",
737
- "description": "Function to generate checkmark svg.",
738
- "privacy": "private",
739
- "return": {
740
- "type": {
741
- "text": "HTMLElement"
742
- }
743
- }
744
- },
745
- {
746
- "kind": "method",
747
- "name": "reset",
748
- "description": "Resets component to initial state.",
749
- "return": {
750
- "type": {
751
- "text": "void"
752
- }
753
- }
754
- },
755
- {
756
- "kind": "method",
757
- "name": "updateAriaLabel",
758
- "description": "Updates the aria-label based on slot content.",
759
- "privacy": "private",
760
- "return": {
761
- "type": {
762
- "text": "void"
763
- }
764
- }
786
+ "description": "Updates the active option in the menu."
765
787
  },
766
788
  {
767
789
  "kind": "method",
768
- "name": "handleKeyDown",
790
+ "name": "handleSlotChange",
769
791
  "parameters": [
770
792
  {
771
793
  "name": "event",
772
- "description": "The keydown event from the checkbox input.",
794
+ "description": "`slotchange` event.",
773
795
  "type": {
774
- "text": "KeyboardEvent"
796
+ "text": "Event"
775
797
  }
776
798
  }
777
799
  ],
778
- "description": "Handles keydown event to toggle the checkbox with Space key.",
800
+ "description": "Watch for slot changes and recalculate the menuoptions.",
779
801
  "privacy": "private",
780
802
  "return": {
781
803
  "type": {
@@ -788,7 +810,7 @@
788
810
  "name": "appearance",
789
811
  "privacy": "public",
790
812
  "type": {
791
- "text": "'default' | 'inverse'"
813
+ "text": "string"
792
814
  },
793
815
  "description": "Defines whether the component will be on lighter or darker backgrounds.",
794
816
  "default": "'default'",
@@ -797,1055 +819,1080 @@
797
819
  },
798
820
  {
799
821
  "kind": "field",
800
- "name": "checked",
822
+ "name": "autocomplete",
801
823
  "privacy": "public",
802
824
  "type": {
803
- "text": "boolean"
825
+ "text": "string"
804
826
  },
805
- "description": "If set to true, the checkbox will be filled with a checkmark.",
806
- "attribute": "checked",
827
+ "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
828
+ "attribute": "autocomplete",
807
829
  "reflects": true
808
830
  },
809
831
  {
810
832
  "kind": "field",
811
- "name": "disabled",
833
+ "name": "autoPlacement",
812
834
  "privacy": "public",
813
835
  "type": {
814
836
  "text": "boolean"
815
837
  },
816
- "description": "If set to true, the checkbox will not be clickable.",
817
- "attribute": "disabled",
838
+ "description": "If declared, bib's position will be automatically calculated where to appear.",
839
+ "attribute": "autoPlacement",
818
840
  "reflects": true
819
841
  },
820
842
  {
821
843
  "kind": "field",
822
- "name": "error",
823
- "privacy": "public",
844
+ "name": "availableOptions",
845
+ "privacy": "private",
824
846
  "type": {
825
- "text": "boolean"
847
+ "text": "array"
826
848
  },
827
- "description": "If set to true, the checkbox will be displayed with an error state.",
828
- "attribute": "error",
829
- "reflects": true
849
+ "description": "Array of available options to display in the dropdown.\nThis array contains all non-hidden options (e.g., hidden by filtering on input value).",
850
+ "attribute": "availableOptions"
830
851
  },
831
852
  {
832
853
  "kind": "field",
833
- "name": "id",
854
+ "name": "behavior",
834
855
  "privacy": "public",
835
856
  "type": {
836
- "text": "string"
857
+ "text": "'filter' | 'suggestion'"
837
858
  },
838
- "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
839
- "attribute": "id",
859
+ "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.",
860
+ "default": "'suggestion'",
861
+ "attribute": "behavior",
840
862
  "reflects": true
841
863
  },
842
864
  {
843
865
  "kind": "field",
844
- "name": "inputId",
845
- "privacy": "private",
866
+ "name": "checkmark",
867
+ "privacy": "public",
846
868
  "type": {
847
- "text": "string"
869
+ "text": "boolean"
848
870
  },
849
- "description": "The id for input node."
871
+ "description": "When attribute is present auro-menu will apply check marks to selected options.",
872
+ "attribute": "checkmark",
873
+ "reflects": true
850
874
  },
851
875
  {
852
876
  "kind": "field",
853
- "name": "name",
877
+ "name": "disabled",
854
878
  "privacy": "public",
879
+ "type": {
880
+ "text": "boolean"
881
+ },
882
+ "description": "If set, disables the combobox.",
883
+ "attribute": "disabled",
884
+ "reflects": true
885
+ },
886
+ {
887
+ "kind": "field",
888
+ "name": "dropdownId",
889
+ "privacy": "private",
855
890
  "type": {
856
891
  "text": "string"
857
892
  },
858
- "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
859
- "attribute": "name"
893
+ "description": "ID for the dropdown."
860
894
  },
861
895
  {
862
896
  "kind": "field",
863
- "name": "onDark",
864
- "privacy": "public",
897
+ "name": "dropdownOpen",
898
+ "privacy": "private",
865
899
  "type": {
866
900
  "text": "boolean"
867
901
  },
868
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
869
- "attribute": "onDark",
870
- "reflects": true
902
+ "description": "Whether or not the dropdown is open."
871
903
  },
872
904
  {
873
905
  "kind": "field",
874
- "name": "touched",
875
- "privacy": "private",
906
+ "name": "dvInputOnly",
907
+ "privacy": "public",
876
908
  "type": {
877
909
  "text": "boolean"
878
910
  },
879
- "description": "Indicates whether the checkbox has been interacted with."
911
+ "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
912
+ "attribute": "dvInputOnly",
913
+ "reflects": true
880
914
  },
881
915
  {
882
916
  "kind": "field",
883
- "name": "value",
917
+ "name": "error",
884
918
  "privacy": "public",
885
919
  "type": {
886
920
  "text": "string"
887
921
  },
888
- "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
889
- "attribute": "value"
922
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
923
+ "attribute": "error",
924
+ "reflects": true
890
925
  },
891
926
  {
892
927
  "kind": "field",
893
- "name": "tabIndex",
894
- "privacy": "private",
928
+ "name": "format",
929
+ "privacy": "public",
895
930
  "type": {
896
- "text": "number"
931
+ "text": "string"
897
932
  },
898
- "description": "The tabindex attribute for the checkbox.",
899
- "attribute": "tabindex",
933
+ "description": "Specifies the input mask format.",
934
+ "attribute": "format",
900
935
  "reflects": true
901
936
  },
902
937
  {
903
938
  "kind": "field",
904
- "name": "ariaChecked",
905
- "privacy": "private",
939
+ "name": "inputmode",
940
+ "privacy": "public",
906
941
  "type": {
907
942
  "text": "string"
908
943
  },
909
- "description": "The aria-checked attribute for the checkbox.",
910
- "attribute": "aria-checked",
944
+ "description": "Exposes inputmode attribute for input.",
945
+ "attribute": "inputmode",
911
946
  "reflects": true
912
947
  },
913
948
  {
914
949
  "kind": "field",
915
- "name": "ariaDisabled",
916
- "privacy": "private",
950
+ "name": "layout",
951
+ "privacy": "public",
917
952
  "type": {
918
953
  "text": "string"
919
954
  },
920
- "description": "The aria-disabled attribute for the checkbox.",
921
- "attribute": "aria-disabled",
922
- "reflects": true
955
+ "description": "Sets the layout of the combobox.",
956
+ "default": "'classic'",
957
+ "attribute": "layout",
958
+ "reflects": true,
959
+ "inheritedFrom": {
960
+ "name": "AuroElement",
961
+ "module": "components/layoutElement/src/auroElement.js"
962
+ }
923
963
  },
924
964
  {
925
965
  "kind": "field",
926
- "name": "role",
966
+ "name": "matchWidth",
927
967
  "privacy": "private",
928
968
  "type": {
929
- "text": "string"
969
+ "text": "boolean"
930
970
  },
931
- "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
932
- "attribute": "role",
971
+ "description": "If declared, the popover and trigger will be set to the same width.",
972
+ "attribute": "matchWidth",
933
973
  "reflects": true
934
- }
935
- ],
936
- "events": [
974
+ },
937
975
  {
938
- "name": "auroCheckbox-input",
976
+ "kind": "field",
977
+ "name": "noFilter",
978
+ "privacy": "public",
939
979
  "type": {
940
- "text": "CustomEvent"
941
- }
980
+ "text": "boolean"
981
+ },
982
+ "description": "If set, combobox will not filter menuoptions based on input.",
983
+ "attribute": "noFilter",
984
+ "reflects": true
942
985
  },
943
986
  {
944
- "name": "auroCheckbox-focusin",
987
+ "kind": "field",
988
+ "name": "noFlip",
989
+ "privacy": "public",
945
990
  "type": {
946
- "text": "CustomEvent"
947
- }
991
+ "text": "boolean"
992
+ },
993
+ "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
994
+ "attribute": "noFlip",
995
+ "reflects": true
948
996
  },
949
997
  {
950
- "name": "auroCheckbox-focusout",
998
+ "kind": "field",
999
+ "name": "shift",
1000
+ "privacy": "public",
951
1001
  "type": {
952
- "text": "CustomEvent"
953
- }
1002
+ "text": "boolean"
1003
+ },
1004
+ "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
1005
+ "attribute": "shift",
1006
+ "reflects": true
954
1007
  },
955
1008
  {
956
- "description": "(Deprecated) Notifies when checked value is changed.",
957
- "name": "change"
1009
+ "kind": "field",
1010
+ "name": "noValidate",
1011
+ "privacy": "public",
1012
+ "type": {
1013
+ "text": "boolean"
1014
+ },
1015
+ "description": "If set, disables auto-validation on blur.",
1016
+ "attribute": "noValidate",
1017
+ "reflects": true
958
1018
  },
959
1019
  {
960
- "description": "Notifies when when checked value is changed by user's interface.",
961
- "name": "input"
962
- }
963
- ],
964
- "attributes": [
965
- {
966
- "name": "appearance",
1020
+ "kind": "field",
1021
+ "name": "offset",
1022
+ "privacy": "public",
967
1023
  "type": {
968
- "text": "'default' | 'inverse'"
1024
+ "text": "number"
969
1025
  },
970
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
971
- "default": "'default'",
972
- "fieldName": "appearance"
1026
+ "description": "Gap between the trigger element and bib.",
1027
+ "default": "0",
1028
+ "attribute": "offset",
1029
+ "reflects": true
973
1030
  },
974
1031
  {
975
- "name": "checked",
1032
+ "kind": "field",
1033
+ "name": "onDark",
1034
+ "privacy": "public",
976
1035
  "type": {
977
1036
  "text": "boolean"
978
1037
  },
979
- "description": "If set to true, the checkbox will be filled with a checkmark.",
980
- "fieldName": "checked"
1038
+ "attribute": "onDark",
1039
+ "reflects": true,
1040
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1041
+ "inheritedFrom": {
1042
+ "name": "AuroElement",
1043
+ "module": "components/layoutElement/src/auroElement.js"
1044
+ }
981
1045
  },
982
1046
  {
983
- "name": "disabled",
1047
+ "kind": "field",
1048
+ "name": "optionSelected",
1049
+ "privacy": "public",
984
1050
  "type": {
985
- "text": "boolean"
1051
+ "text": "HTMLElement"
986
1052
  },
987
- "description": "If set to true, the checkbox will not be clickable.",
988
- "fieldName": "disabled"
1053
+ "description": "Specifies the current selected option.",
1054
+ "attribute": "optionSelected"
989
1055
  },
990
1056
  {
991
- "name": "error",
1057
+ "kind": "field",
1058
+ "name": "persistInput",
1059
+ "privacy": "public",
992
1060
  "type": {
993
1061
  "text": "boolean"
994
1062
  },
995
- "description": "If set to true, the checkbox will be displayed with an error state.",
996
- "fieldName": "error"
1063
+ "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.",
1064
+ "attribute": "persistInput",
1065
+ "reflects": true
997
1066
  },
998
1067
  {
999
- "name": "id",
1068
+ "kind": "field",
1069
+ "name": "placement",
1070
+ "privacy": "public",
1000
1071
  "type": {
1001
- "text": "string"
1072
+ "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
1002
1073
  },
1003
- "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
1004
- "fieldName": "id"
1074
+ "description": "Position where the bib should appear relative to the trigger.",
1075
+ "default": "'bottom-start'",
1076
+ "attribute": "placement",
1077
+ "reflects": true
1005
1078
  },
1006
1079
  {
1007
- "name": "name",
1080
+ "kind": "field",
1081
+ "name": "placeholder",
1082
+ "privacy": "public",
1008
1083
  "type": {
1009
1084
  "text": "string"
1010
1085
  },
1011
- "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
1012
- "fieldName": "name"
1086
+ "description": "Define custom placeholder text, only supported by date input formats.",
1087
+ "attribute": "placeholder",
1088
+ "reflects": true
1013
1089
  },
1014
1090
  {
1015
- "name": "onDark",
1091
+ "kind": "field",
1092
+ "name": "required",
1093
+ "privacy": "public",
1016
1094
  "type": {
1017
1095
  "text": "boolean"
1018
1096
  },
1019
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1020
- "fieldName": "onDark"
1097
+ "description": "Populates the `required` attribute on the input. Used for client-side validation.",
1098
+ "attribute": "required",
1099
+ "reflects": true
1021
1100
  },
1022
1101
  {
1023
- "name": "value",
1102
+ "kind": "field",
1103
+ "name": "setCustomValidity",
1104
+ "privacy": "public",
1024
1105
  "type": {
1025
1106
  "text": "string"
1026
1107
  },
1027
- "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
1028
- "fieldName": "value"
1108
+ "description": "Sets a custom help text message to display for all validityStates.",
1109
+ "attribute": "setCustomValidity"
1029
1110
  },
1030
1111
  {
1031
- "name": "tabindex",
1112
+ "kind": "field",
1113
+ "name": "setCustomValidityCustomError",
1114
+ "privacy": "public",
1032
1115
  "type": {
1033
- "text": "number"
1116
+ "text": "string"
1034
1117
  },
1035
- "description": "The tabindex attribute for the checkbox.",
1036
- "fieldName": "tabIndex"
1118
+ "description": "Custom help text message to display when validity = `customError`.",
1119
+ "attribute": "setCustomValidityCustomError"
1037
1120
  },
1038
1121
  {
1039
- "name": "aria-checked",
1122
+ "kind": "field",
1123
+ "name": "setCustomValidityValueMissing",
1124
+ "privacy": "public",
1040
1125
  "type": {
1041
1126
  "text": "string"
1042
1127
  },
1043
- "description": "The aria-checked attribute for the checkbox.",
1044
- "fieldName": "ariaChecked"
1128
+ "description": "Custom help text message to display when validity = `valueMissing`.",
1129
+ "attribute": "setCustomValidityValueMissing"
1045
1130
  },
1046
1131
  {
1047
- "name": "aria-disabled",
1132
+ "kind": "field",
1133
+ "name": "setCustomValidityValueMissingFilter",
1134
+ "privacy": "public",
1048
1135
  "type": {
1049
1136
  "text": "string"
1050
1137
  },
1051
- "description": "The aria-disabled attribute for the checkbox.",
1052
- "fieldName": "ariaDisabled"
1138
+ "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
1139
+ "attribute": "setCustomValidityValueMissingFilter"
1053
1140
  },
1054
1141
  {
1055
- "name": "role",
1142
+ "kind": "field",
1143
+ "name": "touched",
1144
+ "privacy": "private",
1056
1145
  "type": {
1057
- "text": "string"
1146
+ "text": "boolean"
1058
1147
  },
1059
- "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
1060
- "fieldName": "role"
1061
- }
1062
- ],
1063
- "superclass": {
1064
- "name": "LitElement",
1065
- "package": "lit"
1066
- },
1067
- "tagName": "auro-checkbox",
1068
- "customElement": true
1069
- }
1070
- ],
1071
- "exports": [
1072
- {
1073
- "kind": "js",
1074
- "name": "AuroCheckbox",
1075
- "declaration": {
1076
- "name": "AuroCheckbox",
1077
- "module": "components/checkbox/src/auro-checkbox.js"
1078
- }
1079
- }
1080
- ]
1081
- },
1082
- {
1083
- "kind": "javascript-module",
1084
- "path": "components/checkbox/src/index.js",
1085
- "declarations": [],
1086
- "exports": [
1087
- {
1088
- "kind": "js",
1089
- "name": "AuroCheckbox",
1090
- "declaration": {
1091
- "name": "AuroCheckbox",
1092
- "module": "components/checkbox/src/index.js"
1093
- }
1094
- },
1095
- {
1096
- "kind": "js",
1097
- "name": "AuroCheckboxGroup",
1098
- "declaration": {
1099
- "name": "AuroCheckboxGroup",
1100
- "module": "components/checkbox/src/index.js"
1101
- }
1102
- }
1103
- ]
1104
- },
1105
- {
1106
- "kind": "javascript-module",
1107
- "path": "components/checkbox/src/registered.js",
1108
- "declarations": [],
1109
- "exports": []
1110
- },
1111
- {
1112
- "kind": "javascript-module",
1113
- "path": "components/combobox/src/auro-combobox.js",
1114
- "declarations": [
1115
- {
1116
- "kind": "class",
1117
- "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.",
1118
- "name": "AuroCombobox",
1119
- "slots": [
1120
- {
1121
- "description": "Default slot for the menu content.",
1122
- "name": ""
1148
+ "description": "Indicates whether the combobox is in a dirty state (has been interacted with)."
1123
1149
  },
1124
1150
  {
1151
+ "kind": "field",
1152
+ "name": "triggerIcon",
1153
+ "privacy": "public",
1125
1154
  "type": {
1126
- "text": "HTMLSlotElement"
1155
+ "text": "boolean"
1127
1156
  },
1128
- "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
1129
- "name": "optionalLabel"
1130
- },
1131
- {
1132
- "description": "Sets aria-label on clear button",
1133
- "name": "ariaLabel.input.clear"
1157
+ "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.\nIcon rendering is currently limited to `type=\"credit-card\"`. Setting `triggerIcon`\nwithout a supported `type` propagates the attribute but does not render a visible icon.",
1158
+ "attribute": "triggerIcon",
1159
+ "reflects": true
1134
1160
  },
1135
1161
  {
1136
- "description": "Sets aria-label on close button in fullscreen bib",
1137
- "name": "ariaLabel.bib.close"
1162
+ "kind": "field",
1163
+ "name": "type",
1164
+ "privacy": "public",
1165
+ "type": {
1166
+ "text": "string"
1167
+ },
1168
+ "description": "Applies the defined value as the type attribute on `auro-input`.",
1169
+ "attribute": "type",
1170
+ "reflects": true
1138
1171
  },
1139
1172
  {
1140
- "description": "Defines the headline to display above menu-options",
1141
- "name": "bib.fullscreen.headline"
1173
+ "kind": "field",
1174
+ "name": "typedValue",
1175
+ "privacy": "public",
1176
+ "type": {
1177
+ "text": "string"
1178
+ },
1179
+ "description": "Specifies the value of the input element within the combobox.",
1180
+ "attribute": "typedValue",
1181
+ "reflects": true
1142
1182
  },
1143
1183
  {
1144
- "description": "Defines the content of the label.",
1145
- "name": "label"
1184
+ "kind": "field",
1185
+ "name": "validity",
1186
+ "privacy": "public",
1187
+ "type": {
1188
+ "text": "string"
1189
+ },
1190
+ "description": "Specifies the `validityState` this element is in.",
1191
+ "attribute": "validity",
1192
+ "reflects": true
1146
1193
  },
1147
1194
  {
1148
- "description": "Defines the content of the helpText.",
1149
- "name": "helpText"
1195
+ "kind": "field",
1196
+ "name": "value",
1197
+ "privacy": "public",
1198
+ "type": {
1199
+ "text": "string"
1200
+ },
1201
+ "description": "Value selected for the dropdown menu. When set programmatically or as a preset attribute, the value must match a selectable option. If it matches an option marked `disabled` or `static`, the selection is rejected: `value` and `optionSelected` are cleared to `undefined`. `hidden` options (including those filtered out by type-ahead) remain selectable by value.",
1202
+ "attribute": "value"
1150
1203
  },
1151
1204
  {
1152
- "description": "Allows custom HTML content to display the selected value when the combobox is not focused. Only works with `snowflake` and `emphasized` layouts.",
1153
- "name": "displayValue"
1154
- }
1155
- ],
1156
- "members": [
1157
- {
1158
- "kind": "method",
1159
- "name": "_initializeDefaults",
1160
- "privacy": "private",
1161
- "return": {
1162
- "type": {
1163
- "text": "void"
1164
- }
1165
- }
1205
+ "kind": "field",
1206
+ "name": "largeFullscreenHeadline",
1207
+ "privacy": "public",
1208
+ "type": {
1209
+ "text": "boolean"
1210
+ },
1211
+ "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
1212
+ "attribute": "largeFullscreenHeadline",
1213
+ "reflects": true
1166
1214
  },
1167
1215
  {
1168
- "kind": "method",
1169
- "name": "_scheduleTimer",
1170
- "parameters": [
1171
- {
1172
- "name": "fn",
1173
- "description": "Callback to run.",
1174
- "type": {
1175
- "text": "Function"
1176
- }
1177
- },
1178
- {
1179
- "name": "ms",
1180
- "description": "Delay in milliseconds.",
1181
- "type": {
1182
- "text": "number"
1183
- }
1184
- }
1185
- ],
1186
- "description": "Wraps setTimeout and records the timer id so disconnectedCallback\ncan cancel any outstanding callbacks. The id is removed from the set\nonce the callback fires so the set doesn't grow unbounded.",
1187
- "return": {
1188
- "type": {
1189
- "text": "number"
1190
- }
1216
+ "kind": "field",
1217
+ "name": "fullscreenBreakpoint",
1218
+ "privacy": "public",
1219
+ "type": {
1220
+ "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
1191
1221
  },
1192
- "privacy": "private"
1222
+ "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.",
1223
+ "default": "'sm'",
1224
+ "attribute": "fullscreenBreakpoint",
1225
+ "reflects": true
1193
1226
  },
1194
1227
  {
1195
1228
  "kind": "field",
1196
- "name": "inputValue",
1197
- "description": "Returns the current value of the input element within the combobox.",
1198
- "return": {
1199
- "type": {
1200
- "text": "string|undefined"
1201
- }
1229
+ "name": "optionActive",
1230
+ "privacy": "private",
1231
+ "type": {
1232
+ "text": "object"
1202
1233
  },
1203
- "readonly": true
1234
+ "description": "Specifies the currently active option."
1204
1235
  },
1205
1236
  {
1206
- "kind": "method",
1207
- "name": "isValid",
1208
- "description": "Checks if the element is valid.",
1237
+ "kind": "field",
1238
+ "name": "componentHasFocus",
1239
+ "description": "Returns true if the element has focus.",
1240
+ "privacy": "private",
1209
1241
  "return": {
1210
1242
  "type": {
1211
1243
  "text": "boolean"
1212
1244
  }
1245
+ },
1246
+ "readonly": true,
1247
+ "inheritedFrom": {
1248
+ "name": "AuroElement",
1249
+ "module": "components/layoutElement/src/auroElement.js"
1213
1250
  }
1214
1251
  },
1215
1252
  {
1216
1253
  "kind": "method",
1217
- "name": "register",
1218
- "static": true,
1219
- "parameters": [
1220
- {
1221
- "name": "name",
1222
- "default": "'auro-combobox'",
1223
- "description": "The name of the element that you want to register.",
1224
- "optional": true,
1225
- "type": {
1226
- "text": "string"
1227
- }
1228
- }
1229
- ],
1230
- "description": "This will register this element with the browser."
1254
+ "name": "resetShapeClasses",
1255
+ "inheritedFrom": {
1256
+ "name": "AuroElement",
1257
+ "module": "components/layoutElement/src/auroElement.js"
1258
+ }
1231
1259
  },
1232
1260
  {
1233
1261
  "kind": "method",
1234
- "name": "activateFirstEnabledAvailableOption",
1235
- "description": "Mark the first available (non-hidden), enabled option as `active`.",
1236
- "privacy": "private",
1237
- "return": {
1238
- "type": {
1239
- "text": "void"
1240
- }
1262
+ "name": "resetLayoutClasses",
1263
+ "inheritedFrom": {
1264
+ "name": "AuroElement",
1265
+ "module": "components/layoutElement/src/auroElement.js"
1241
1266
  }
1242
1267
  },
1243
1268
  {
1244
1269
  "kind": "method",
1245
- "name": "activateLastEnabledAvailableOption",
1246
- "description": "Mark the last available (non-hidden), enabled option as `active`.",
1247
- "privacy": "private",
1248
- "return": {
1249
- "type": {
1250
- "text": "void"
1251
- }
1270
+ "name": "updateComponentArchitecture",
1271
+ "inheritedFrom": {
1272
+ "name": "AuroElement",
1273
+ "module": "components/layoutElement/src/auroElement.js"
1252
1274
  }
1253
1275
  },
1254
1276
  {
1255
- "kind": "method",
1256
- "name": "updateFilter",
1257
- "description": "Updates the filter for the available options based on the input value.",
1258
- "privacy": "private"
1277
+ "kind": "field",
1278
+ "name": "shape",
1279
+ "privacy": "public",
1280
+ "type": {
1281
+ "text": "string"
1282
+ },
1283
+ "attribute": "shape",
1284
+ "reflects": true,
1285
+ "inheritedFrom": {
1286
+ "name": "AuroElement",
1287
+ "module": "components/layoutElement/src/auroElement.js"
1288
+ }
1259
1289
  },
1260
1290
  {
1261
- "kind": "method",
1262
- "name": "syncValuesAndStates",
1263
- "description": "Syncs the values and states of this component, the input, and the menu, including this.optionSelected and this.menu.optionSelected.",
1264
- "privacy": "private",
1265
- "return": {
1266
- "type": {
1267
- "text": "void"
1268
- }
1291
+ "kind": "field",
1292
+ "name": "size",
1293
+ "privacy": "public",
1294
+ "type": {
1295
+ "text": "string"
1296
+ },
1297
+ "attribute": "size",
1298
+ "reflects": true,
1299
+ "inheritedFrom": {
1300
+ "name": "AuroElement",
1301
+ "module": "components/layoutElement/src/auroElement.js"
1269
1302
  }
1303
+ }
1304
+ ],
1305
+ "events": [
1306
+ {
1307
+ "name": "inputValue",
1308
+ "type": {
1309
+ "text": "CustomEvent"
1310
+ },
1311
+ "description": "Notifies that the components internal HTML5 input value has changed."
1270
1312
  },
1271
1313
  {
1272
- "kind": "method",
1273
- "name": "updateTriggerTextDisplay",
1274
- "parameters": [
1275
- {
1276
- "name": "label",
1277
- "description": "The label of the selected option.",
1278
- "type": {
1279
- "text": "string"
1280
- }
1281
- }
1282
- ],
1283
- "description": "Update displayValue or input.value, it's called when making a selection.",
1284
- "privacy": "private"
1314
+ "name": "input",
1315
+ "type": {
1316
+ "text": "CustomEvent"
1317
+ },
1318
+ "description": "Notifies that the component has a new value set."
1285
1319
  },
1286
1320
  {
1287
- "kind": "method",
1288
- "name": "syncInputValuesAcrossTriggerAndBib",
1289
- "parameters": [
1290
- {
1291
- "name": "nextValue",
1292
- "description": "The value to write to both inputs.",
1293
- "type": {
1294
- "text": "string"
1295
- }
1296
- }
1297
- ],
1298
- "description": "Writes nextValue to the trigger input and the bib input when their current\nvalue differs, then re-asserts imask after Lit's update flushes.",
1299
- "return": {
1300
- "type": {
1301
- "text": "Promise<void>"
1302
- }
1321
+ "name": "auroCombobox-valueSet",
1322
+ "type": {
1323
+ "text": "CustomEvent"
1303
1324
  },
1304
- "privacy": "private"
1325
+ "description": "(Deprecated) Notifies that the component has a new value set."
1305
1326
  },
1306
1327
  {
1307
- "kind": "method",
1308
- "name": "handleMenuOptions",
1309
- "parameters": [
1310
- {
1311
- "name": "{ preferComboboxValue = false }",
1312
- "default": "{}"
1313
- },
1314
- {
1315
- "description": "Optional flag bag.",
1316
- "name": "options",
1317
- "optional": true,
1318
- "type": {
1319
- "text": "@param {boolean} [options.preferComboboxValue=false] - When true,\n * handleMenuOptions matches the selected option against `this.value`\n * first instead of `this.input.value`. Needed on mount and re-mount\n * because under `persistInput` the consumer's typedValue prop can drift\n * from the framework value (Svelte `{#key}` re-mount after a swap, or\n * SPA preselect after route change) and the old input-first match would\n * then pick the stale text. Only handleSlotChange passes this; typing\n * and clearing paths keep the input-first match so user clears aren't\n * undone.\n * "
1320
- }
1321
- }
1322
- ],
1323
- "description": "Processes hidden state of all menu options and determines if there are any available options not hidden.",
1324
- "privacy": "private",
1325
- "return": {
1326
- "type": {
1327
- "text": "void"
1328
- }
1329
- }
1328
+ "description": "Notifies that the component value(s) have been validated.",
1329
+ "name": "auroFormElement-validated"
1330
+ }
1331
+ ],
1332
+ "attributes": [
1333
+ {
1334
+ "name": "appearance",
1335
+ "type": {
1336
+ "text": "string"
1337
+ },
1338
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
1339
+ "default": "'default'",
1340
+ "fieldName": "appearance"
1330
1341
  },
1331
1342
  {
1332
- "kind": "method",
1333
- "name": "generateOptionsArray",
1334
- "description": "Determines the element error state based on the `required` attribute and input value.",
1335
- "privacy": "private",
1336
- "return": {
1337
- "type": {
1338
- "text": "void"
1339
- }
1340
- }
1343
+ "name": "autocomplete",
1344
+ "type": {
1345
+ "text": "string"
1346
+ },
1347
+ "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
1348
+ "fieldName": "autocomplete"
1341
1349
  },
1342
1350
  {
1343
- "kind": "method",
1344
- "name": "hideBib",
1345
- "description": "Hides the dropdown bib if its open.",
1346
- "return": {
1347
- "type": {
1348
- "text": "void"
1349
- }
1350
- }
1351
+ "name": "autoPlacement",
1352
+ "type": {
1353
+ "text": "boolean"
1354
+ },
1355
+ "description": "If declared, bib's position will be automatically calculated where to appear.",
1356
+ "fieldName": "autoPlacement"
1351
1357
  },
1352
1358
  {
1353
- "kind": "method",
1354
- "name": "showBib",
1355
- "description": "Shows the dropdown bib if there are options to show.",
1356
- "return": {
1357
- "type": {
1358
- "text": "void"
1359
- }
1360
- }
1359
+ "name": "availableOptions",
1360
+ "type": {
1361
+ "text": "array"
1362
+ },
1363
+ "description": "Array of available options to display in the dropdown.\nThis array contains all non-hidden options (e.g., hidden by filtering on input value).",
1364
+ "fieldName": "availableOptions"
1361
1365
  },
1362
1366
  {
1363
- "kind": "method",
1364
- "name": "configureDropdown",
1365
- "description": "Binds all behavior needed to the dropdown after rendering.",
1366
- "privacy": "private",
1367
- "return": {
1368
- "type": {
1369
- "text": "void"
1370
- }
1371
- }
1367
+ "name": "behavior",
1368
+ "type": {
1369
+ "text": "'filter' | 'suggestion'"
1370
+ },
1371
+ "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.",
1372
+ "default": "'suggestion'",
1373
+ "fieldName": "behavior"
1372
1374
  },
1373
1375
  {
1374
- "kind": "method",
1375
- "name": "setClearBtnFocus",
1376
- "privacy": "private"
1376
+ "name": "checkmark",
1377
+ "type": {
1378
+ "text": "boolean"
1379
+ },
1380
+ "description": "When attribute is present auro-menu will apply check marks to selected options.",
1381
+ "fieldName": "checkmark"
1377
1382
  },
1378
1383
  {
1379
- "kind": "method",
1380
- "name": "setTriggerInputFocus",
1381
- "privacy": "private"
1384
+ "name": "disabled",
1385
+ "type": {
1386
+ "text": "boolean"
1387
+ },
1388
+ "description": "If set, disables the combobox.",
1389
+ "fieldName": "disabled"
1382
1390
  },
1383
1391
  {
1384
- "kind": "method",
1385
- "name": "setInputFocus",
1386
- "privacy": "private"
1392
+ "name": "dvInputOnly",
1393
+ "type": {
1394
+ "text": "boolean"
1395
+ },
1396
+ "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
1397
+ "fieldName": "dvInputOnly"
1387
1398
  },
1388
1399
  {
1389
- "kind": "method",
1390
- "name": "updateBibDialogRole",
1391
- "description": "Suppresses or restores dialog semantics on the bib's dialog element.\nOn desktop (non-fullscreen), VoiceOver verbosely announces \"listbox inside\nof a dialog\" which disrupts combobox usage. Setting role=\"presentation\"\nsuppresses this. In fullscreen mode, dialog semantics are restored.",
1392
- "privacy": "private"
1400
+ "name": "error",
1401
+ "type": {
1402
+ "text": "string"
1403
+ },
1404
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1405
+ "fieldName": "error"
1393
1406
  },
1394
1407
  {
1395
- "kind": "method",
1396
- "name": "updateMenuShapeSize",
1397
- "description": "Update menu to default for fullscreen bib, otherwise to this.size and this.shape.",
1398
- "privacy": "private"
1408
+ "name": "format",
1409
+ "type": {
1410
+ "text": "string"
1411
+ },
1412
+ "description": "Specifies the input mask format.",
1413
+ "fieldName": "format"
1399
1414
  },
1400
1415
  {
1401
- "kind": "method",
1402
- "name": "_getAnnouncementRoot",
1403
- "description": "Returns the shadow root containing the live region for screen reader announcements.\nWhen the bib is open in fullscreen modal mode, everything outside the <dialog>\nis inert, so we target the bib's own shadow root instead of the host's.",
1404
- "privacy": "private",
1405
- "return": {
1406
- "type": {
1407
- "text": "ShadowRoot"
1408
- }
1409
- }
1416
+ "name": "inputmode",
1417
+ "type": {
1418
+ "text": "string"
1419
+ },
1420
+ "description": "Exposes inputmode attribute for input.",
1421
+ "fieldName": "inputmode"
1410
1422
  },
1411
1423
  {
1412
- "kind": "method",
1413
- "name": "configureMenu",
1414
- "description": "Binds all behavior needed to the menu after rendering.",
1415
- "privacy": "private",
1416
- "return": {
1417
- "type": {
1418
- "text": "void"
1419
- }
1424
+ "name": "layout",
1425
+ "type": {
1426
+ "text": "string"
1427
+ },
1428
+ "description": "Sets the layout of the combobox.",
1429
+ "default": "'classic'",
1430
+ "fieldName": "layout",
1431
+ "inheritedFrom": {
1432
+ "name": "AuroElement",
1433
+ "module": "components/layoutElement/src/auroElement.js"
1420
1434
  }
1421
1435
  },
1422
1436
  {
1423
- "kind": "method",
1424
- "name": "configureInput",
1425
- "description": "Binds all behavior needed to the input after rendering.",
1426
- "privacy": "private",
1427
- "return": {
1428
- "type": {
1429
- "text": "void"
1430
- }
1431
- }
1437
+ "name": "matchWidth",
1438
+ "type": {
1439
+ "text": "boolean"
1440
+ },
1441
+ "description": "If declared, the popover and trigger will be set to the same width.",
1442
+ "fieldName": "matchWidth"
1432
1443
  },
1433
1444
  {
1434
- "kind": "method",
1435
- "name": "handleMenuLoadingChange",
1436
- "parameters": [
1437
- {
1438
- "name": "event",
1439
- "description": "The event object containing details about the loading state change.",
1440
- "type": {
1441
- "text": "CustomEvent"
1442
- }
1443
- },
1444
- {
1445
- "description": "Indicates whether the menu is currently loading.",
1446
- "name": "event.detail.loading",
1447
- "type": {
1448
- "text": "boolean"
1449
- }
1450
- },
1451
- {
1452
- "description": "Indicates if there are loading placeholders present.",
1453
- "name": "event.detail.hasLoadingPlaceholder",
1454
- "type": {
1455
- "text": "boolean"
1456
- }
1457
- }
1458
- ],
1459
- "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.",
1460
- "privacy": "private",
1461
- "return": {
1462
- "type": {
1463
- "text": "void"
1464
- }
1465
- }
1445
+ "name": "noFilter",
1446
+ "type": {
1447
+ "text": "boolean"
1448
+ },
1449
+ "description": "If set, combobox will not filter menuoptions based on input.",
1450
+ "fieldName": "noFilter"
1466
1451
  },
1467
1452
  {
1468
- "kind": "method",
1469
- "name": "handleInputValueChange",
1470
- "parameters": [
1471
- {
1472
- "name": "event",
1473
- "description": "The input event triggered by the input element.",
1474
- "type": {
1475
- "text": "Event"
1476
- }
1477
- }
1478
- ],
1479
- "description": "Handle changes to the input value and trigger changes that should result.",
1480
- "privacy": "private",
1481
- "return": {
1482
- "type": {
1483
- "text": "void"
1484
- }
1485
- }
1453
+ "name": "noFlip",
1454
+ "type": {
1455
+ "text": "boolean"
1456
+ },
1457
+ "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
1458
+ "fieldName": "noFlip"
1486
1459
  },
1487
1460
  {
1488
- "kind": "method",
1489
- "name": "handleTriggerInputValueChange",
1490
- "parameters": [
1491
- {
1492
- "name": "event",
1493
- "description": "The input event from the trigger input element.",
1494
- "type": {
1495
- "text": "Event"
1496
- }
1497
- }
1498
- ],
1499
- "description": "Handles input value changes originating from the trigger input.\nRefreshes menu options and filtering, delegates to handleInputValueChange\nfor value synchronization, and manages fullscreen bib focus.",
1500
- "privacy": "private",
1501
- "return": {
1502
- "type": {
1503
- "text": "void"
1504
- }
1505
- }
1461
+ "name": "shift",
1462
+ "type": {
1463
+ "text": "boolean"
1464
+ },
1465
+ "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
1466
+ "fieldName": "shift"
1506
1467
  },
1507
1468
  {
1508
- "kind": "method",
1509
- "name": "configureCombobox",
1510
- "description": "Binds all behavior needed to the combobox after rendering.",
1511
- "privacy": "private",
1512
- "return": {
1513
- "type": {
1514
- "text": "void"
1515
- }
1516
- }
1469
+ "name": "noValidate",
1470
+ "type": {
1471
+ "text": "boolean"
1472
+ },
1473
+ "description": "If set, disables auto-validation on blur.",
1474
+ "fieldName": "noValidate"
1517
1475
  },
1518
1476
  {
1519
- "kind": "method",
1520
- "name": "focus",
1521
- "description": "Focuses the combobox trigger input.",
1522
- "return": {
1523
- "type": {
1524
- "text": "void"
1525
- }
1526
- }
1477
+ "name": "offset",
1478
+ "type": {
1479
+ "text": "number"
1480
+ },
1481
+ "description": "Gap between the trigger element and bib.",
1482
+ "default": "0",
1483
+ "fieldName": "offset"
1527
1484
  },
1528
1485
  {
1529
- "kind": "method",
1530
- "name": "setMenuValue",
1531
- "parameters": [
1532
- {
1533
- "name": "value",
1534
- "description": "The value to set on the menu.",
1535
- "type": {
1536
- "text": "string"
1537
- }
1538
- }
1539
- ],
1540
- "description": "Sets the menu value if menu is available.",
1541
- "return": {
1542
- "type": {
1543
- "text": "void"
1544
- }
1545
- }
1486
+ "name": "onDark",
1487
+ "type": {
1488
+ "text": "boolean"
1489
+ },
1490
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1491
+ "fieldName": "onDark"
1546
1492
  },
1547
1493
  {
1548
- "kind": "method",
1549
- "name": "reset",
1550
- "description": "Resets component to initial state.",
1551
- "return": {
1552
- "type": {
1553
- "text": "void"
1554
- }
1555
- }
1494
+ "name": "optionSelected",
1495
+ "type": {
1496
+ "text": "HTMLElement"
1497
+ },
1498
+ "description": "Specifies the current selected option.",
1499
+ "fieldName": "optionSelected"
1556
1500
  },
1557
1501
  {
1558
- "kind": "method",
1559
- "name": "clear",
1560
- "description": "Clears the current value of the combobox.",
1561
- "return": {
1562
- "type": {
1563
- "text": "void"
1564
- }
1565
- }
1502
+ "name": "persistInput",
1503
+ "type": {
1504
+ "text": "boolean"
1505
+ },
1506
+ "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.",
1507
+ "fieldName": "persistInput"
1566
1508
  },
1567
1509
  {
1568
- "kind": "method",
1569
- "name": "validate",
1570
- "parameters": [
1571
- {
1572
- "name": "force",
1573
- "default": "false",
1574
- "description": "Whether to force validation.",
1575
- "optional": true,
1576
- "type": {
1577
- "text": "boolean"
1578
- }
1579
- }
1580
- ],
1581
- "description": "Validates value."
1510
+ "name": "placement",
1511
+ "type": {
1512
+ "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
1513
+ },
1514
+ "description": "Position where the bib should appear relative to the trigger.",
1515
+ "default": "'bottom-start'",
1516
+ "fieldName": "placement"
1582
1517
  },
1583
1518
  {
1584
- "kind": "method",
1585
- "name": "transportAssignedNodes",
1586
- "parameters": [
1587
- {
1588
- "name": "slot",
1589
- "description": "The slot element containing the nodes to apply.",
1590
- "type": {
1591
- "text": "HTMLSlotElement"
1592
- }
1593
- },
1594
- {
1595
- "name": "target",
1596
- "description": "The target element to apply the nodes to.",
1597
- "type": {
1598
- "text": "HTMLElement"
1599
- }
1600
- },
1601
- {
1602
- "name": "newSlotName",
1603
- "description": "The new slot name for the applied nodes.",
1604
- "type": {
1605
- "text": "string"
1606
- }
1607
- }
1608
- ],
1609
- "description": "Applies slotted nodes to a target element with a new slot name.",
1610
- "privacy": "private",
1611
- "return": {
1612
- "type": {
1613
- "text": "void"
1614
- }
1615
- }
1519
+ "name": "placeholder",
1520
+ "type": {
1521
+ "text": "string"
1522
+ },
1523
+ "description": "Define custom placeholder text, only supported by date input formats.",
1524
+ "fieldName": "placeholder"
1616
1525
  },
1617
1526
  {
1618
- "kind": "method",
1619
- "name": "updateActiveOption",
1620
- "parameters": [
1621
- {
1622
- "name": "index",
1623
- "description": "Index of the option to make active.",
1624
- "type": {
1625
- "text": "number"
1626
- }
1627
- }
1628
- ],
1629
- "description": "Updates the active option in the menu."
1527
+ "name": "required",
1528
+ "type": {
1529
+ "text": "boolean"
1530
+ },
1531
+ "description": "Populates the `required` attribute on the input. Used for client-side validation.",
1532
+ "fieldName": "required"
1630
1533
  },
1631
1534
  {
1632
- "kind": "method",
1633
- "name": "handleSlotChange",
1634
- "parameters": [
1635
- {
1636
- "name": "event",
1637
- "description": "`slotchange` event.",
1638
- "type": {
1639
- "text": "Event"
1640
- }
1641
- }
1642
- ],
1643
- "description": "Watch for slot changes and recalculate the menuoptions.",
1644
- "privacy": "private",
1645
- "return": {
1646
- "type": {
1647
- "text": "void"
1648
- }
1649
- }
1535
+ "name": "setCustomValidity",
1536
+ "type": {
1537
+ "text": "string"
1538
+ },
1539
+ "description": "Sets a custom help text message to display for all validityStates.",
1540
+ "fieldName": "setCustomValidity"
1541
+ },
1542
+ {
1543
+ "name": "setCustomValidityCustomError",
1544
+ "type": {
1545
+ "text": "string"
1546
+ },
1547
+ "description": "Custom help text message to display when validity = `customError`.",
1548
+ "fieldName": "setCustomValidityCustomError"
1549
+ },
1550
+ {
1551
+ "name": "setCustomValidityValueMissing",
1552
+ "type": {
1553
+ "text": "string"
1554
+ },
1555
+ "description": "Custom help text message to display when validity = `valueMissing`.",
1556
+ "fieldName": "setCustomValidityValueMissing"
1650
1557
  },
1651
1558
  {
1652
- "kind": "field",
1653
- "name": "appearance",
1654
- "privacy": "public",
1559
+ "name": "setCustomValidityValueMissingFilter",
1655
1560
  "type": {
1656
1561
  "text": "string"
1657
1562
  },
1658
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
1659
- "default": "'default'",
1660
- "attribute": "appearance",
1661
- "reflects": true
1563
+ "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
1564
+ "fieldName": "setCustomValidityValueMissingFilter"
1662
1565
  },
1663
1566
  {
1664
- "kind": "field",
1665
- "name": "autocomplete",
1666
- "privacy": "public",
1567
+ "name": "triggerIcon",
1568
+ "type": {
1569
+ "text": "boolean"
1570
+ },
1571
+ "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.\nIcon rendering is currently limited to `type=\"credit-card\"`. Setting `triggerIcon`\nwithout a supported `type` propagates the attribute but does not render a visible icon.",
1572
+ "fieldName": "triggerIcon"
1573
+ },
1574
+ {
1575
+ "name": "type",
1667
1576
  "type": {
1668
1577
  "text": "string"
1669
1578
  },
1670
- "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
1671
- "attribute": "autocomplete",
1672
- "reflects": true
1579
+ "description": "Applies the defined value as the type attribute on `auro-input`.",
1580
+ "fieldName": "type"
1673
1581
  },
1674
1582
  {
1675
- "kind": "field",
1676
- "name": "autoPlacement",
1677
- "privacy": "public",
1583
+ "name": "typedValue",
1678
1584
  "type": {
1679
- "text": "boolean"
1585
+ "text": "string"
1680
1586
  },
1681
- "description": "If declared, bib's position will be automatically calculated where to appear.",
1682
- "attribute": "autoPlacement",
1683
- "reflects": true
1587
+ "description": "Specifies the value of the input element within the combobox.",
1588
+ "fieldName": "typedValue"
1684
1589
  },
1685
1590
  {
1686
- "kind": "field",
1687
- "name": "availableOptions",
1688
- "privacy": "private",
1591
+ "name": "validity",
1689
1592
  "type": {
1690
- "text": "array"
1593
+ "text": "string"
1691
1594
  },
1692
- "description": "Array of available options to display in the dropdown.\nThis array contains all non-hidden options (e.g., hidden by filtering on input value).",
1693
- "attribute": "availableOptions"
1595
+ "description": "Specifies the `validityState` this element is in.",
1596
+ "fieldName": "validity"
1694
1597
  },
1695
1598
  {
1696
- "kind": "field",
1697
- "name": "behavior",
1698
- "privacy": "public",
1599
+ "name": "value",
1699
1600
  "type": {
1700
- "text": "'filter' | 'suggestion'"
1601
+ "text": "string"
1701
1602
  },
1702
- "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.",
1703
- "default": "'suggestion'",
1704
- "attribute": "behavior",
1705
- "reflects": true
1603
+ "description": "Value selected for the dropdown menu. When set programmatically or as a preset attribute, the value must match a selectable option. If it matches an option marked `disabled` or `static`, the selection is rejected: `value` and `optionSelected` are cleared to `undefined`. `hidden` options (including those filtered out by type-ahead) remain selectable by value.",
1604
+ "fieldName": "value"
1706
1605
  },
1707
1606
  {
1708
- "kind": "field",
1709
- "name": "checkmark",
1710
- "privacy": "public",
1607
+ "name": "largeFullscreenHeadline",
1711
1608
  "type": {
1712
1609
  "text": "boolean"
1713
1610
  },
1714
- "description": "When attribute is present auro-menu will apply check marks to selected options.",
1715
- "attribute": "checkmark",
1716
- "reflects": true
1611
+ "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
1612
+ "fieldName": "largeFullscreenHeadline"
1717
1613
  },
1718
1614
  {
1719
- "kind": "field",
1720
- "name": "disabled",
1721
- "privacy": "public",
1615
+ "name": "fullscreenBreakpoint",
1722
1616
  "type": {
1723
- "text": "boolean"
1617
+ "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
1724
1618
  },
1725
- "description": "If set, disables the combobox.",
1726
- "attribute": "disabled",
1727
- "reflects": true
1619
+ "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.",
1620
+ "default": "'sm'",
1621
+ "fieldName": "fullscreenBreakpoint"
1728
1622
  },
1729
1623
  {
1730
- "kind": "field",
1731
- "name": "dropdownId",
1732
- "privacy": "private",
1624
+ "name": "shape",
1733
1625
  "type": {
1734
1626
  "text": "string"
1735
1627
  },
1736
- "description": "ID for the dropdown."
1628
+ "fieldName": "shape",
1629
+ "inheritedFrom": {
1630
+ "name": "AuroElement",
1631
+ "module": "components/layoutElement/src/auroElement.js"
1632
+ }
1737
1633
  },
1738
1634
  {
1739
- "kind": "field",
1740
- "name": "dropdownOpen",
1741
- "privacy": "private",
1635
+ "name": "size",
1636
+ "type": {
1637
+ "text": "string"
1638
+ },
1639
+ "fieldName": "size",
1640
+ "inheritedFrom": {
1641
+ "name": "AuroElement",
1642
+ "module": "components/layoutElement/src/auroElement.js"
1643
+ }
1644
+ },
1645
+ {
1646
+ "name": "ondark",
1742
1647
  "type": {
1743
1648
  "text": "boolean"
1744
1649
  },
1745
- "description": "Whether or not the dropdown is open."
1650
+ "fieldName": "onDark",
1651
+ "inheritedFrom": {
1652
+ "name": "AuroElement",
1653
+ "module": "components/layoutElement/src/auroElement.js"
1654
+ }
1655
+ }
1656
+ ],
1657
+ "superclass": {
1658
+ "name": "AuroElement",
1659
+ "module": "/components/layoutElement/src/auroElement.js"
1660
+ },
1661
+ "tagName": "auro-combobox",
1662
+ "customElement": true
1663
+ }
1664
+ ],
1665
+ "exports": [
1666
+ {
1667
+ "kind": "js",
1668
+ "name": "AuroCombobox",
1669
+ "declaration": {
1670
+ "name": "AuroCombobox",
1671
+ "module": "components/combobox/src/auro-combobox.js"
1672
+ }
1673
+ }
1674
+ ]
1675
+ },
1676
+ {
1677
+ "kind": "javascript-module",
1678
+ "path": "components/combobox/src/comboboxKeyboardStrategy.js",
1679
+ "declarations": [
1680
+ {
1681
+ "kind": "variable",
1682
+ "name": "comboboxKeyboardStrategy",
1683
+ "type": {
1684
+ "text": "object"
1685
+ },
1686
+ "default": "{ ArrowDown(component, evt, ctx) { // If the clear button has focus, let the browser handle ArrowDown normally. if (isClearBtnFocused(ctx)) { return; } // option display and navigation are prevented if there are no available options if (component.availableOptions.length > 0) { evt.preventDefault(); // navigate if bib is open otherwise open it if (component.dropdown.isPopoverVisible) { navigateArrow(component, 'down'); } else { component.showBib(); } } }, ArrowUp(component, evt, ctx) { // If the clear button has focus, let the browser handle ArrowUp normally. if (isClearBtnFocused(ctx)) { return; } // option display and navigation are prevented if there are no available options if (component.availableOptions.length > 0) { evt.preventDefault(); // navigate if bib is open otherwise open it if (component.dropdown.isPopoverVisible) { navigateArrow(component, 'up'); } else { component.showBib(); } } }, End(component, evt, ctx) { if (ctx.isExpanded) { evt.preventDefault(); evt.stopPropagation(); component.activateLastEnabledAvailableOption(); } }, Enter(component, evt, ctx) { // Forms should not submit on Enter from a combobox, regardless of which // child element (input, clear button, menu) is focused. evt.stopPropagation(); if (isClearBtnFocused(ctx)) { // Let the browser dispatch Enter to the focused clear button so its // built-in activation fires and clears the selection. Do NOT call // preventDefault — that would block the activation. return; } if (ctx.isExpanded && component.menu.optionActive) { reconcileMenuIndex(component.menu); component.menu.makeSelection(); if (ctx.isModal) { component.setTriggerInputFocus(); } evt.preventDefault(); } else { evt.preventDefault(); component.showBib(); } }, Escape(component, evt, ctx) { if (!ctx.isExpanded) { return; } // Prevent the Escape key from bubbling up and closing any parent dialogs / drawers / popups evt.stopPropagation(); if (ctx.isModal) { component.setTriggerInputFocus(); } component.hideBib(); }, Home(component, evt, ctx) { if (ctx.isExpanded) { evt.preventDefault(); evt.stopPropagation(); component.activateFirstEnabledAvailableOption(); } }, Tab(component, evt, ctx) { // Runs for both Tab and Shift+Tab. // // Current behavior: // Tab — select the active option, close the bib, and (in fullscreen // modal mode only) explicitly move focus to the trigger's // clear button. In desktop popover mode the browser's native // tab traversal takes focus forward from the input. // Shift+Tab — select the active option and close the bib. Focus then // lands on the trigger's clear button as a byproduct of the // shadow-DOM tab order, so keyboard users must press // Shift+Tab three times to exit the component (clear button // → input → previous element on the page). // // Intended behavior for Shift+Tab (per team decision, tracked in // AB#1590650): a single Shift+Tab should select the active option, close // the bib, and move focus directly to the previous focusable element on // the page — symmetric with Tab. if (ctx.isExpanded && !isClearBtnFocused(ctx)) { // When the clear button is focused, Tab events do not bubble out of // its shadow DOM, so this handler only fires when the clear button // is NOT focused. In that case, select the active option and close. reconcileMenuIndex(component.menu); component.menu.makeSelection(); component.hideBib(); // In fullscreen modal mode, closing the dialog does not // automatically restores focus to the input. In the tab case, // Explicitly move focus to the trigger's clear button so the // user can continues tabbing through the page normally. if (ctx.isModal && !evt.shiftKey) { component.setClearBtnFocus(); } } } }"
1687
+ }
1688
+ ],
1689
+ "exports": [
1690
+ {
1691
+ "kind": "js",
1692
+ "name": "comboboxKeyboardStrategy",
1693
+ "declaration": {
1694
+ "name": "comboboxKeyboardStrategy",
1695
+ "module": "components/combobox/src/comboboxKeyboardStrategy.js"
1696
+ }
1697
+ }
1698
+ ]
1699
+ },
1700
+ {
1701
+ "kind": "javascript-module",
1702
+ "path": "components/combobox/src/index.js",
1703
+ "declarations": [],
1704
+ "exports": [
1705
+ {
1706
+ "kind": "js",
1707
+ "name": "AuroCombobox",
1708
+ "declaration": {
1709
+ "name": "AuroCombobox",
1710
+ "module": "components/combobox/src/index.js"
1711
+ }
1712
+ }
1713
+ ]
1714
+ },
1715
+ {
1716
+ "kind": "javascript-module",
1717
+ "path": "components/combobox/src/registered.js",
1718
+ "declarations": [],
1719
+ "exports": [
1720
+ {
1721
+ "kind": "js",
1722
+ "name": "AuroCombobox",
1723
+ "declaration": {
1724
+ "name": "AuroCombobox",
1725
+ "module": "components/combobox/src/registered.js"
1726
+ }
1727
+ }
1728
+ ]
1729
+ },
1730
+ {
1731
+ "kind": "javascript-module",
1732
+ "path": "components/checkbox/src/auro-checkbox-group.js",
1733
+ "declarations": [
1734
+ {
1735
+ "kind": "class",
1736
+ "description": "The `auro-checkbox-group` element is a wrapper for `auro-checkbox` elements.",
1737
+ "name": "AuroCheckboxGroup",
1738
+ "slots": [
1739
+ {
1740
+ "description": "Allows for the legend to be overridden.",
1741
+ "name": "legend"
1742
+ },
1743
+ {
1744
+ "description": "Allows overriding the optional display text \"(optional)\", which appears next to the label.",
1745
+ "name": "optionalLabel"
1746
+ },
1747
+ {
1748
+ "description": "Allows for the helper text to be overridden.",
1749
+ "name": "helpText"
1750
+ },
1751
+ {
1752
+ "description": "The default slot for the checkbox items.",
1753
+ "name": "default"
1754
+ }
1755
+ ],
1756
+ "members": [
1757
+ {
1758
+ "kind": "method",
1759
+ "name": "_initializeDefaults"
1760
+ },
1761
+ {
1762
+ "kind": "method",
1763
+ "name": "register",
1764
+ "static": true,
1765
+ "parameters": [
1766
+ {
1767
+ "name": "name",
1768
+ "default": "\"auro-checkbox-group\"",
1769
+ "description": "The name of the element that you want to register.",
1770
+ "optional": true,
1771
+ "type": {
1772
+ "text": "string"
1773
+ }
1774
+ }
1775
+ ],
1776
+ "description": "This will register this element with the browser."
1777
+ },
1778
+ {
1779
+ "kind": "method",
1780
+ "name": "handleValueUpdate",
1781
+ "parameters": [
1782
+ {
1783
+ "name": "value",
1784
+ "description": "The value of the checkbox.",
1785
+ "type": {
1786
+ "text": "String"
1787
+ }
1788
+ },
1789
+ {
1790
+ "name": "selected",
1791
+ "description": "The checked state of the checkbox.",
1792
+ "type": {
1793
+ "text": "Boolean"
1794
+ }
1795
+ }
1796
+ ],
1797
+ "description": "Helper method to handle checkbox value changing.",
1798
+ "privacy": "private",
1799
+ "return": {
1800
+ "type": {
1801
+ "text": "void"
1802
+ }
1803
+ }
1746
1804
  },
1747
1805
  {
1748
- "kind": "field",
1749
- "name": "dvInputOnly",
1750
- "privacy": "public",
1751
- "type": {
1752
- "text": "boolean"
1753
- },
1754
- "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
1755
- "attribute": "dvInputOnly",
1756
- "reflects": true
1806
+ "kind": "method",
1807
+ "name": "handlePreselectedItems",
1808
+ "description": "Helper method that handles the state of preselected checkboxes.",
1809
+ "privacy": "private",
1810
+ "return": {
1811
+ "type": {
1812
+ "text": "void"
1813
+ }
1814
+ }
1757
1815
  },
1758
1816
  {
1759
- "kind": "field",
1760
- "name": "error",
1761
- "privacy": "public",
1762
- "type": {
1763
- "text": "string"
1764
- },
1765
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1766
- "attribute": "error",
1767
- "reflects": true
1817
+ "kind": "method",
1818
+ "name": "handleItems",
1819
+ "description": "Helper method that handles the state of checkboxes.",
1820
+ "privacy": "private",
1821
+ "return": {
1822
+ "type": {
1823
+ "text": "void"
1824
+ }
1825
+ }
1768
1826
  },
1769
1827
  {
1770
- "kind": "field",
1771
- "name": "format",
1772
- "privacy": "public",
1773
- "type": {
1774
- "text": "string"
1775
- },
1776
- "description": "Specifies the input mask format.",
1777
- "attribute": "format",
1778
- "reflects": true
1828
+ "kind": "method",
1829
+ "name": "reset",
1830
+ "description": "Resets component to initial state.",
1831
+ "return": {
1832
+ "type": {
1833
+ "text": "void"
1834
+ }
1835
+ }
1779
1836
  },
1780
1837
  {
1781
- "kind": "field",
1782
- "name": "inputmode",
1783
- "privacy": "public",
1784
- "type": {
1785
- "text": "string"
1786
- },
1787
- "description": "Exposes inputmode attribute for input.",
1788
- "attribute": "inputmode",
1789
- "reflects": true
1838
+ "kind": "method",
1839
+ "name": "validate",
1840
+ "parameters": [
1841
+ {
1842
+ "name": "force",
1843
+ "default": "false",
1844
+ "description": "Whether to force validation.",
1845
+ "optional": true,
1846
+ "type": {
1847
+ "text": "boolean"
1848
+ }
1849
+ }
1850
+ ],
1851
+ "description": "Validates value."
1790
1852
  },
1791
1853
  {
1792
1854
  "kind": "field",
1793
- "name": "layout",
1855
+ "name": "appearance",
1794
1856
  "privacy": "public",
1795
1857
  "type": {
1796
- "text": "string"
1797
- },
1798
- "description": "Sets the layout of the combobox.",
1799
- "default": "'classic'",
1800
- "attribute": "layout",
1801
- "reflects": true,
1802
- "inheritedFrom": {
1803
- "name": "AuroElement",
1804
- "module": "components/layoutElement/src/auroElement.js"
1805
- }
1806
- },
1807
- {
1808
- "kind": "field",
1809
- "name": "matchWidth",
1810
- "privacy": "private",
1811
- "type": {
1812
- "text": "boolean"
1858
+ "text": "'default' | 'inverse'"
1813
1859
  },
1814
- "description": "If declared, the popover and trigger will be set to the same width.",
1815
- "attribute": "matchWidth",
1860
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
1861
+ "default": "'default'",
1862
+ "attribute": "appearance",
1816
1863
  "reflects": true
1817
1864
  },
1818
1865
  {
1819
1866
  "kind": "field",
1820
- "name": "noFilter",
1867
+ "name": "disabled",
1821
1868
  "privacy": "public",
1822
1869
  "type": {
1823
1870
  "text": "boolean"
1824
1871
  },
1825
- "description": "If set, combobox will not filter menuoptions based on input.",
1826
- "attribute": "noFilter",
1872
+ "description": "If set, disables the checkbox group.",
1873
+ "attribute": "disabled",
1827
1874
  "reflects": true
1828
1875
  },
1829
1876
  {
1830
1877
  "kind": "field",
1831
- "name": "noFlip",
1878
+ "name": "error",
1832
1879
  "privacy": "public",
1833
1880
  "type": {
1834
- "text": "boolean"
1881
+ "text": "string"
1835
1882
  },
1836
- "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
1837
- "attribute": "noFlip",
1883
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
1884
+ "attribute": "error",
1838
1885
  "reflects": true
1839
1886
  },
1840
1887
  {
1841
1888
  "kind": "field",
1842
- "name": "shift",
1889
+ "name": "horizontal",
1843
1890
  "privacy": "public",
1844
1891
  "type": {
1845
1892
  "text": "boolean"
1846
1893
  },
1847
- "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
1848
- "attribute": "shift",
1894
+ "description": "If set, checkboxes will be aligned horizontally.",
1895
+ "attribute": "horizontal",
1849
1896
  "reflects": true
1850
1897
  },
1851
1898
  {
@@ -1861,714 +1908,667 @@
1861
1908
  },
1862
1909
  {
1863
1910
  "kind": "field",
1864
- "name": "offset",
1911
+ "name": "onDark",
1865
1912
  "privacy": "public",
1866
1913
  "type": {
1867
- "text": "number"
1914
+ "text": "boolean"
1868
1915
  },
1869
- "description": "Gap between the trigger element and bib.",
1870
- "default": "0",
1871
- "attribute": "offset",
1916
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1917
+ "attribute": "onDark",
1872
1918
  "reflects": true
1873
1919
  },
1874
1920
  {
1875
1921
  "kind": "field",
1876
- "name": "onDark",
1922
+ "name": "required",
1877
1923
  "privacy": "public",
1878
1924
  "type": {
1879
1925
  "text": "boolean"
1880
1926
  },
1881
- "attribute": "onDark",
1882
- "reflects": true,
1883
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
1884
- "inheritedFrom": {
1885
- "name": "AuroElement",
1886
- "module": "components/layoutElement/src/auroElement.js"
1887
- }
1927
+ "description": "Populates the `required` attribute on the element. Used for client-side validation.",
1928
+ "attribute": "required",
1929
+ "reflects": true
1888
1930
  },
1889
1931
  {
1890
1932
  "kind": "field",
1891
- "name": "optionSelected",
1933
+ "name": "setCustomValidity",
1892
1934
  "privacy": "public",
1893
1935
  "type": {
1894
- "text": "HTMLElement"
1936
+ "text": "string"
1895
1937
  },
1896
- "description": "Specifies the current selected option.",
1897
- "attribute": "optionSelected"
1938
+ "description": "Sets a custom help text message to display for all validityStates.",
1939
+ "attribute": "setCustomValidity"
1898
1940
  },
1899
1941
  {
1900
1942
  "kind": "field",
1901
- "name": "persistInput",
1943
+ "name": "setCustomValidityCustomError",
1902
1944
  "privacy": "public",
1903
1945
  "type": {
1904
- "text": "boolean"
1946
+ "text": "string"
1905
1947
  },
1906
- "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.",
1907
- "attribute": "persistInput",
1908
- "reflects": true
1948
+ "description": "Custom help text message to display when validity = `customError`.",
1949
+ "attribute": "setCustomValidityCustomError"
1909
1950
  },
1910
1951
  {
1911
1952
  "kind": "field",
1912
- "name": "placement",
1953
+ "name": "setCustomValidityValueMissing",
1913
1954
  "privacy": "public",
1914
1955
  "type": {
1915
- "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
1956
+ "text": "string"
1916
1957
  },
1917
- "description": "Position where the bib should appear relative to the trigger.",
1918
- "default": "'bottom-start'",
1919
- "attribute": "placement",
1920
- "reflects": true
1958
+ "description": "Custom help text message to display when validity = `valueMissing`.",
1959
+ "attribute": "setCustomValidityValueMissing"
1921
1960
  },
1922
1961
  {
1923
1962
  "kind": "field",
1924
- "name": "placeholder",
1963
+ "name": "validity",
1925
1964
  "privacy": "public",
1926
1965
  "type": {
1927
1966
  "text": "string"
1928
1967
  },
1929
- "description": "Define custom placeholder text, only supported by date input formats.",
1930
- "attribute": "placeholder",
1968
+ "description": "Specifies the `validityState` this element is in.",
1969
+ "attribute": "validity",
1931
1970
  "reflects": true
1932
- },
1971
+ }
1972
+ ],
1973
+ "events": [
1933
1974
  {
1934
- "kind": "field",
1935
- "name": "required",
1936
- "privacy": "public",
1975
+ "name": "input",
1937
1976
  "type": {
1938
- "text": "boolean"
1939
- },
1940
- "description": "Populates the `required` attribute on the input. Used for client-side validation.",
1941
- "attribute": "required",
1942
- "reflects": true
1977
+ "text": "CustomEvent"
1978
+ }
1943
1979
  },
1944
1980
  {
1945
- "kind": "field",
1946
- "name": "setCustomValidity",
1947
- "privacy": "public",
1981
+ "description": "Notifies that the `validity` and `errorMessage` values have changed.",
1982
+ "name": "auroFormElement-validated"
1983
+ }
1984
+ ],
1985
+ "attributes": [
1986
+ {
1987
+ "name": "appearance",
1948
1988
  "type": {
1949
- "text": "string"
1989
+ "text": "'default' | 'inverse'"
1950
1990
  },
1951
- "description": "Sets a custom help text message to display for all validityStates.",
1952
- "attribute": "setCustomValidity"
1991
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
1992
+ "default": "'default'",
1993
+ "fieldName": "appearance"
1953
1994
  },
1954
1995
  {
1955
- "kind": "field",
1956
- "name": "setCustomValidityCustomError",
1957
- "privacy": "public",
1996
+ "name": "disabled",
1958
1997
  "type": {
1959
- "text": "string"
1998
+ "text": "boolean"
1960
1999
  },
1961
- "description": "Custom help text message to display when validity = `customError`.",
1962
- "attribute": "setCustomValidityCustomError"
2000
+ "description": "If set, disables the checkbox group.",
2001
+ "fieldName": "disabled"
1963
2002
  },
1964
2003
  {
1965
- "kind": "field",
1966
- "name": "setCustomValidityValueMissing",
1967
- "privacy": "public",
2004
+ "name": "error",
1968
2005
  "type": {
1969
2006
  "text": "string"
1970
2007
  },
1971
- "description": "Custom help text message to display when validity = `valueMissing`.",
1972
- "attribute": "setCustomValidityValueMissing"
2008
+ "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
2009
+ "fieldName": "error"
1973
2010
  },
1974
2011
  {
1975
- "kind": "field",
1976
- "name": "setCustomValidityValueMissingFilter",
1977
- "privacy": "public",
2012
+ "name": "horizontal",
1978
2013
  "type": {
1979
- "text": "string"
2014
+ "text": "boolean"
1980
2015
  },
1981
- "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
1982
- "attribute": "setCustomValidityValueMissingFilter"
2016
+ "description": "If set, checkboxes will be aligned horizontally.",
2017
+ "fieldName": "horizontal"
1983
2018
  },
1984
2019
  {
1985
- "kind": "field",
1986
- "name": "touched",
1987
- "privacy": "private",
2020
+ "name": "noValidate",
1988
2021
  "type": {
1989
2022
  "text": "boolean"
1990
2023
  },
1991
- "description": "Indicates whether the combobox is in a dirty state (has been interacted with)."
2024
+ "description": "If set, disables auto-validation on blur.",
2025
+ "fieldName": "noValidate"
1992
2026
  },
1993
2027
  {
1994
- "kind": "field",
1995
- "name": "triggerIcon",
1996
- "privacy": "public",
2028
+ "name": "onDark",
2029
+ "type": {
2030
+ "text": "boolean"
2031
+ },
2032
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2033
+ "fieldName": "onDark"
2034
+ },
2035
+ {
2036
+ "name": "required",
1997
2037
  "type": {
1998
2038
  "text": "boolean"
1999
2039
  },
2000
- "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.",
2001
- "attribute": "triggerIcon",
2002
- "reflects": true
2040
+ "description": "Populates the `required` attribute on the element. Used for client-side validation.",
2041
+ "fieldName": "required"
2003
2042
  },
2004
2043
  {
2005
- "kind": "field",
2006
- "name": "type",
2007
- "privacy": "public",
2044
+ "name": "setCustomValidity",
2008
2045
  "type": {
2009
2046
  "text": "string"
2010
2047
  },
2011
- "description": "Applies the defined value as the type attribute on `auro-input`.",
2012
- "attribute": "type",
2013
- "reflects": true
2048
+ "description": "Sets a custom help text message to display for all validityStates.",
2049
+ "fieldName": "setCustomValidity"
2014
2050
  },
2015
2051
  {
2016
- "kind": "field",
2017
- "name": "typedValue",
2018
- "privacy": "public",
2052
+ "name": "setCustomValidityCustomError",
2019
2053
  "type": {
2020
2054
  "text": "string"
2021
2055
  },
2022
- "description": "Specifies the value of the input element within the combobox.",
2023
- "attribute": "typedValue",
2024
- "reflects": true
2056
+ "description": "Custom help text message to display when validity = `customError`.",
2057
+ "fieldName": "setCustomValidityCustomError"
2025
2058
  },
2026
2059
  {
2027
- "kind": "field",
2028
- "name": "validity",
2029
- "privacy": "public",
2060
+ "name": "setCustomValidityValueMissing",
2030
2061
  "type": {
2031
2062
  "text": "string"
2032
2063
  },
2033
- "description": "Specifies the `validityState` this element is in.",
2034
- "attribute": "validity",
2035
- "reflects": true
2064
+ "description": "Custom help text message to display when validity = `valueMissing`.",
2065
+ "fieldName": "setCustomValidityValueMissing"
2036
2066
  },
2037
2067
  {
2038
- "kind": "field",
2039
- "name": "value",
2040
- "privacy": "public",
2068
+ "name": "validity",
2041
2069
  "type": {
2042
2070
  "text": "string"
2043
2071
  },
2044
- "description": "Value selected for the dropdown menu.",
2045
- "attribute": "value"
2072
+ "description": "Specifies the `validityState` this element is in.",
2073
+ "fieldName": "validity"
2074
+ }
2075
+ ],
2076
+ "superclass": {
2077
+ "name": "LitElement",
2078
+ "package": "lit"
2079
+ },
2080
+ "tagName": "auro-checkbox-group",
2081
+ "customElement": true
2082
+ }
2083
+ ],
2084
+ "exports": [
2085
+ {
2086
+ "kind": "js",
2087
+ "name": "AuroCheckboxGroup",
2088
+ "declaration": {
2089
+ "name": "AuroCheckboxGroup",
2090
+ "module": "components/checkbox/src/auro-checkbox-group.js"
2091
+ }
2092
+ }
2093
+ ]
2094
+ },
2095
+ {
2096
+ "kind": "javascript-module",
2097
+ "path": "components/checkbox/src/auro-checkbox.js",
2098
+ "declarations": [
2099
+ {
2100
+ "kind": "class",
2101
+ "description": "The `auro-checkbox` element is for the purpose of allowing users to select one or more options of a limited number of choices.",
2102
+ "name": "AuroCheckbox",
2103
+ "cssParts": [
2104
+ {
2105
+ "description": "apply css to a specific checkbox.",
2106
+ "name": "checkbox"
2046
2107
  },
2047
2108
  {
2048
- "kind": "field",
2049
- "name": "largeFullscreenHeadline",
2050
- "privacy": "public",
2051
- "type": {
2052
- "text": "boolean"
2053
- },
2054
- "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
2055
- "attribute": "largeFullscreenHeadline",
2056
- "reflects": true
2109
+ "description": "apply css to a specific checkbox's input.",
2110
+ "name": "checkbox-input"
2057
2111
  },
2058
2112
  {
2059
- "kind": "field",
2060
- "name": "fullscreenBreakpoint",
2061
- "privacy": "public",
2062
- "type": {
2063
- "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
2064
- },
2065
- "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.",
2066
- "default": "'sm'",
2067
- "attribute": "fullscreenBreakpoint",
2068
- "reflects": true
2113
+ "description": "apply css to a specific checkbox's label.",
2114
+ "name": "checkbox-label"
2115
+ }
2116
+ ],
2117
+ "slots": [
2118
+ {
2119
+ "description": "The default slot for the checkbox label.",
2120
+ "name": "default"
2121
+ }
2122
+ ],
2123
+ "members": [
2124
+ {
2125
+ "kind": "method",
2126
+ "name": "_initializeDefaults"
2069
2127
  },
2070
2128
  {
2071
- "kind": "field",
2072
- "name": "optionActive",
2073
- "privacy": "private",
2074
- "type": {
2075
- "text": "object"
2076
- },
2077
- "description": "Specifies the currently active option."
2129
+ "kind": "method",
2130
+ "name": "register",
2131
+ "static": true,
2132
+ "parameters": [
2133
+ {
2134
+ "name": "name",
2135
+ "default": "\"auro-checkbox\"",
2136
+ "description": "The name of element that you want to register to.",
2137
+ "optional": true,
2138
+ "type": {
2139
+ "text": "string"
2140
+ }
2141
+ }
2142
+ ],
2143
+ "description": "This will register this element with the browser."
2078
2144
  },
2079
2145
  {
2080
- "kind": "field",
2081
- "name": "componentHasFocus",
2082
- "description": "Returns true if the element has focus.",
2146
+ "kind": "method",
2147
+ "name": "handleChange",
2148
+ "parameters": [
2149
+ {
2150
+ "name": "event",
2151
+ "description": "The change event from the checkbox input.",
2152
+ "type": {
2153
+ "text": "Event"
2154
+ }
2155
+ }
2156
+ ],
2157
+ "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.",
2083
2158
  "privacy": "private",
2084
2159
  "return": {
2085
2160
  "type": {
2086
- "text": "boolean"
2161
+ "text": "void"
2087
2162
  }
2088
- },
2089
- "readonly": true,
2090
- "inheritedFrom": {
2091
- "name": "AuroElement",
2092
- "module": "components/layoutElement/src/auroElement.js"
2093
2163
  }
2094
2164
  },
2095
2165
  {
2096
2166
  "kind": "method",
2097
- "name": "resetShapeClasses",
2098
- "inheritedFrom": {
2099
- "name": "AuroElement",
2100
- "module": "components/layoutElement/src/auroElement.js"
2167
+ "name": "handleInput",
2168
+ "parameters": [
2169
+ {
2170
+ "name": "event",
2171
+ "description": "The input event from the checkbox input.",
2172
+ "type": {
2173
+ "text": "Event"
2174
+ }
2175
+ }
2176
+ ],
2177
+ "description": "Handles the input event for the checkbox input.\nUpdates the checked state and dispatches a custom 'auroCheckbox-input' event.",
2178
+ "privacy": "private",
2179
+ "return": {
2180
+ "type": {
2181
+ "text": "void"
2182
+ }
2101
2183
  }
2102
2184
  },
2103
2185
  {
2104
2186
  "kind": "method",
2105
- "name": "resetLayoutClasses",
2106
- "inheritedFrom": {
2107
- "name": "AuroElement",
2108
- "module": "components/layoutElement/src/auroElement.js"
2187
+ "name": "handleFocusin",
2188
+ "description": "Function to support",
2189
+ "privacy": "private",
2190
+ "return": {
2191
+ "type": {
2192
+ "text": "void"
2193
+ }
2109
2194
  }
2110
2195
  },
2111
2196
  {
2112
2197
  "kind": "method",
2113
- "name": "updateComponentArchitecture",
2114
- "inheritedFrom": {
2115
- "name": "AuroElement",
2116
- "module": "components/layoutElement/src/auroElement.js"
2117
- }
2118
- },
2119
- {
2120
- "kind": "field",
2121
- "name": "shape",
2122
- "privacy": "public",
2123
- "type": {
2124
- "text": "string"
2125
- },
2126
- "attribute": "shape",
2127
- "reflects": true,
2128
- "inheritedFrom": {
2129
- "name": "AuroElement",
2130
- "module": "components/layoutElement/src/auroElement.js"
2131
- }
2132
- },
2133
- {
2134
- "kind": "field",
2135
- "name": "size",
2136
- "privacy": "public",
2137
- "type": {
2138
- "text": "string"
2139
- },
2140
- "attribute": "size",
2141
- "reflects": true,
2142
- "inheritedFrom": {
2143
- "name": "AuroElement",
2144
- "module": "components/layoutElement/src/auroElement.js"
2145
- }
2146
- }
2147
- ],
2148
- "events": [
2149
- {
2150
- "name": "inputValue",
2151
- "type": {
2152
- "text": "CustomEvent"
2153
- },
2154
- "description": "Notifies that the components internal HTML5 input value has changed."
2155
- },
2156
- {
2157
- "name": "input",
2158
- "type": {
2159
- "text": "CustomEvent"
2160
- },
2161
- "description": "Notifies that the component has a new value set."
2162
- },
2163
- {
2164
- "name": "auroCombobox-valueSet",
2165
- "type": {
2166
- "text": "CustomEvent"
2167
- },
2168
- "description": "(Deprecated) Notifies that the component has a new value set."
2169
- },
2170
- {
2171
- "description": "Notifies that the component value(s) have been validated.",
2172
- "name": "auroFormElement-validated"
2173
- }
2174
- ],
2175
- "attributes": [
2176
- {
2177
- "name": "appearance",
2178
- "type": {
2179
- "text": "string"
2180
- },
2181
- "description": "Defines whether the component will be on lighter or darker backgrounds.",
2182
- "default": "'default'",
2183
- "fieldName": "appearance"
2198
+ "name": "generateIconHtml",
2199
+ "description": "Function to generate checkmark svg.",
2200
+ "privacy": "private",
2201
+ "return": {
2202
+ "type": {
2203
+ "text": "HTMLElement"
2204
+ }
2205
+ }
2184
2206
  },
2185
2207
  {
2186
- "name": "autocomplete",
2187
- "type": {
2188
- "text": "string"
2189
- },
2190
- "description": "An enumerated attribute that defines what the user agent can suggest for autofill. At this time, only `autocomplete=\"off\"` is supported.",
2191
- "fieldName": "autocomplete"
2208
+ "kind": "method",
2209
+ "name": "reset",
2210
+ "description": "Resets component to initial state.",
2211
+ "return": {
2212
+ "type": {
2213
+ "text": "void"
2214
+ }
2215
+ }
2192
2216
  },
2193
2217
  {
2194
- "name": "autoPlacement",
2195
- "type": {
2196
- "text": "boolean"
2197
- },
2198
- "description": "If declared, bib's position will be automatically calculated where to appear.",
2199
- "fieldName": "autoPlacement"
2218
+ "kind": "method",
2219
+ "name": "updateAriaLabel",
2220
+ "description": "Updates the aria-label based on slot content.",
2221
+ "privacy": "private",
2222
+ "return": {
2223
+ "type": {
2224
+ "text": "void"
2225
+ }
2226
+ }
2200
2227
  },
2201
2228
  {
2202
- "name": "availableOptions",
2203
- "type": {
2204
- "text": "array"
2205
- },
2206
- "description": "Array of available options to display in the dropdown.\nThis array contains all non-hidden options (e.g., hidden by filtering on input value).",
2207
- "fieldName": "availableOptions"
2229
+ "kind": "method",
2230
+ "name": "handleKeyDown",
2231
+ "parameters": [
2232
+ {
2233
+ "name": "event",
2234
+ "description": "The keydown event from the checkbox input.",
2235
+ "type": {
2236
+ "text": "KeyboardEvent"
2237
+ }
2238
+ }
2239
+ ],
2240
+ "description": "Handles keydown event to toggle the checkbox with Space key.",
2241
+ "privacy": "private",
2242
+ "return": {
2243
+ "type": {
2244
+ "text": "void"
2245
+ }
2246
+ }
2208
2247
  },
2209
2248
  {
2210
- "name": "behavior",
2249
+ "kind": "field",
2250
+ "name": "appearance",
2251
+ "privacy": "public",
2211
2252
  "type": {
2212
- "text": "'filter' | 'suggestion'"
2253
+ "text": "'default' | 'inverse'"
2213
2254
  },
2214
- "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.",
2215
- "default": "'suggestion'",
2216
- "fieldName": "behavior"
2255
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
2256
+ "default": "'default'",
2257
+ "attribute": "appearance",
2258
+ "reflects": true
2217
2259
  },
2218
2260
  {
2219
- "name": "checkmark",
2261
+ "kind": "field",
2262
+ "name": "checked",
2263
+ "privacy": "public",
2220
2264
  "type": {
2221
2265
  "text": "boolean"
2222
2266
  },
2223
- "description": "When attribute is present auro-menu will apply check marks to selected options.",
2224
- "fieldName": "checkmark"
2267
+ "description": "If set to true, the checkbox will be filled with a checkmark.",
2268
+ "attribute": "checked",
2269
+ "reflects": true
2225
2270
  },
2226
2271
  {
2272
+ "kind": "field",
2227
2273
  "name": "disabled",
2274
+ "privacy": "public",
2228
2275
  "type": {
2229
2276
  "text": "boolean"
2230
2277
  },
2231
- "description": "If set, disables the combobox.",
2232
- "fieldName": "disabled"
2233
- },
2234
- {
2235
- "name": "dvInputOnly",
2236
- "type": {
2237
- "text": "boolean"
2238
- },
2239
- "description": "If defined, the display value slot content will only mask the HTML5 input element. The inputs label will not be masked.",
2240
- "fieldName": "dvInputOnly"
2278
+ "description": "If set to true, the checkbox will not be clickable.",
2279
+ "attribute": "disabled",
2280
+ "reflects": true
2241
2281
  },
2242
2282
  {
2283
+ "kind": "field",
2243
2284
  "name": "error",
2285
+ "privacy": "public",
2244
2286
  "type": {
2245
- "text": "string"
2287
+ "text": "boolean"
2246
2288
  },
2247
- "description": "When defined, sets persistent validity to `customError` and sets the validation message to the attribute value.",
2248
- "fieldName": "error"
2289
+ "description": "If set to true, the checkbox will be displayed with an error state.",
2290
+ "attribute": "error",
2291
+ "reflects": true
2249
2292
  },
2250
2293
  {
2251
- "name": "format",
2294
+ "kind": "field",
2295
+ "name": "id",
2296
+ "privacy": "public",
2252
2297
  "type": {
2253
2298
  "text": "string"
2254
2299
  },
2255
- "description": "Specifies the input mask format.",
2256
- "fieldName": "format"
2300
+ "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
2301
+ "attribute": "id",
2302
+ "reflects": true
2257
2303
  },
2258
2304
  {
2259
- "name": "inputmode",
2305
+ "kind": "field",
2306
+ "name": "inputId",
2307
+ "privacy": "private",
2260
2308
  "type": {
2261
2309
  "text": "string"
2262
2310
  },
2263
- "description": "Exposes inputmode attribute for input.",
2264
- "fieldName": "inputmode"
2311
+ "description": "The id for input node."
2265
2312
  },
2266
2313
  {
2267
- "name": "layout",
2314
+ "kind": "field",
2315
+ "name": "name",
2316
+ "privacy": "public",
2268
2317
  "type": {
2269
2318
  "text": "string"
2270
2319
  },
2271
- "description": "Sets the layout of the combobox.",
2272
- "default": "'classic'",
2273
- "fieldName": "layout",
2274
- "inheritedFrom": {
2275
- "name": "AuroElement",
2276
- "module": "components/layoutElement/src/auroElement.js"
2277
- }
2278
- },
2279
- {
2280
- "name": "matchWidth",
2281
- "type": {
2282
- "text": "boolean"
2283
- },
2284
- "description": "If declared, the popover and trigger will be set to the same width.",
2285
- "fieldName": "matchWidth"
2286
- },
2287
- {
2288
- "name": "noFilter",
2289
- "type": {
2290
- "text": "boolean"
2291
- },
2292
- "description": "If set, combobox will not filter menuoptions based on input.",
2293
- "fieldName": "noFilter"
2320
+ "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
2321
+ "attribute": "name"
2294
2322
  },
2295
2323
  {
2296
- "name": "noFlip",
2324
+ "kind": "field",
2325
+ "name": "onDark",
2326
+ "privacy": "public",
2297
2327
  "type": {
2298
2328
  "text": "boolean"
2299
2329
  },
2300
- "description": "If declared, the bib will NOT flip to an alternate position\nwhen there isn't enough space in the specified `placement`.",
2301
- "fieldName": "noFlip"
2330
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2331
+ "attribute": "onDark",
2332
+ "reflects": true
2302
2333
  },
2303
2334
  {
2304
- "name": "shift",
2335
+ "kind": "field",
2336
+ "name": "touched",
2337
+ "privacy": "private",
2305
2338
  "type": {
2306
2339
  "text": "boolean"
2307
2340
  },
2308
- "description": "If declared, the dropdown will shift its position to avoid being cut off by the viewport.",
2309
- "fieldName": "shift"
2341
+ "description": "Indicates whether the checkbox has been interacted with."
2310
2342
  },
2311
2343
  {
2312
- "name": "noValidate",
2344
+ "kind": "field",
2345
+ "name": "value",
2346
+ "privacy": "public",
2313
2347
  "type": {
2314
- "text": "boolean"
2348
+ "text": "string"
2315
2349
  },
2316
- "description": "If set, disables auto-validation on blur.",
2317
- "fieldName": "noValidate"
2350
+ "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
2351
+ "attribute": "value"
2318
2352
  },
2319
2353
  {
2320
- "name": "offset",
2354
+ "kind": "field",
2355
+ "name": "tabIndex",
2356
+ "privacy": "private",
2321
2357
  "type": {
2322
2358
  "text": "number"
2323
2359
  },
2324
- "description": "Gap between the trigger element and bib.",
2325
- "default": "0",
2326
- "fieldName": "offset"
2360
+ "description": "The tabindex attribute for the checkbox.",
2361
+ "attribute": "tabindex",
2362
+ "reflects": true
2327
2363
  },
2328
2364
  {
2329
- "name": "onDark",
2365
+ "kind": "field",
2366
+ "name": "ariaChecked",
2367
+ "privacy": "private",
2330
2368
  "type": {
2331
- "text": "boolean"
2369
+ "text": "string"
2332
2370
  },
2333
- "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2334
- "fieldName": "onDark"
2371
+ "description": "The aria-checked attribute for the checkbox.",
2372
+ "attribute": "aria-checked",
2373
+ "reflects": true
2335
2374
  },
2336
2375
  {
2337
- "name": "optionSelected",
2376
+ "kind": "field",
2377
+ "name": "ariaDisabled",
2378
+ "privacy": "private",
2338
2379
  "type": {
2339
- "text": "HTMLElement"
2380
+ "text": "string"
2340
2381
  },
2341
- "description": "Specifies the current selected option.",
2342
- "fieldName": "optionSelected"
2382
+ "description": "The aria-disabled attribute for the checkbox.",
2383
+ "attribute": "aria-disabled",
2384
+ "reflects": true
2343
2385
  },
2344
2386
  {
2345
- "name": "persistInput",
2387
+ "kind": "field",
2388
+ "name": "role",
2389
+ "privacy": "private",
2346
2390
  "type": {
2347
- "text": "boolean"
2391
+ "text": "string"
2348
2392
  },
2349
- "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.",
2350
- "fieldName": "persistInput"
2351
- },
2393
+ "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
2394
+ "attribute": "role",
2395
+ "reflects": true
2396
+ }
2397
+ ],
2398
+ "events": [
2352
2399
  {
2353
- "name": "placement",
2400
+ "name": "auroCheckbox-input",
2354
2401
  "type": {
2355
- "text": "'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'"
2356
- },
2357
- "description": "Position where the bib should appear relative to the trigger.",
2358
- "default": "'bottom-start'",
2359
- "fieldName": "placement"
2402
+ "text": "CustomEvent"
2403
+ }
2360
2404
  },
2361
2405
  {
2362
- "name": "placeholder",
2406
+ "name": "auroCheckbox-focusin",
2363
2407
  "type": {
2364
- "text": "string"
2365
- },
2366
- "description": "Define custom placeholder text, only supported by date input formats.",
2367
- "fieldName": "placeholder"
2408
+ "text": "CustomEvent"
2409
+ }
2368
2410
  },
2369
2411
  {
2370
- "name": "required",
2412
+ "name": "auroCheckbox-focusout",
2371
2413
  "type": {
2372
- "text": "boolean"
2373
- },
2374
- "description": "Populates the `required` attribute on the input. Used for client-side validation.",
2375
- "fieldName": "required"
2414
+ "text": "CustomEvent"
2415
+ }
2376
2416
  },
2377
2417
  {
2378
- "name": "setCustomValidity",
2379
- "type": {
2380
- "text": "string"
2381
- },
2382
- "description": "Sets a custom help text message to display for all validityStates.",
2383
- "fieldName": "setCustomValidity"
2418
+ "description": "(Deprecated) Notifies when checked value is changed.",
2419
+ "name": "change"
2384
2420
  },
2385
2421
  {
2386
- "name": "setCustomValidityCustomError",
2422
+ "description": "Notifies when when checked value is changed by user's interface.",
2423
+ "name": "input"
2424
+ }
2425
+ ],
2426
+ "attributes": [
2427
+ {
2428
+ "name": "appearance",
2387
2429
  "type": {
2388
- "text": "string"
2430
+ "text": "'default' | 'inverse'"
2389
2431
  },
2390
- "description": "Custom help text message to display when validity = `customError`.",
2391
- "fieldName": "setCustomValidityCustomError"
2432
+ "description": "Defines whether the component will be on lighter or darker backgrounds.",
2433
+ "default": "'default'",
2434
+ "fieldName": "appearance"
2392
2435
  },
2393
2436
  {
2394
- "name": "setCustomValidityValueMissing",
2437
+ "name": "checked",
2395
2438
  "type": {
2396
- "text": "string"
2439
+ "text": "boolean"
2397
2440
  },
2398
- "description": "Custom help text message to display when validity = `valueMissing`.",
2399
- "fieldName": "setCustomValidityValueMissing"
2441
+ "description": "If set to true, the checkbox will be filled with a checkmark.",
2442
+ "fieldName": "checked"
2400
2443
  },
2401
2444
  {
2402
- "name": "setCustomValidityValueMissingFilter",
2445
+ "name": "disabled",
2403
2446
  "type": {
2404
- "text": "string"
2447
+ "text": "boolean"
2405
2448
  },
2406
- "description": "Custom help text message to display when validity = `valueMissing` due to the user not choosing a menu option when behavior = \"filter\".",
2407
- "fieldName": "setCustomValidityValueMissingFilter"
2449
+ "description": "If set to true, the checkbox will not be clickable.",
2450
+ "fieldName": "disabled"
2408
2451
  },
2409
2452
  {
2410
- "name": "triggerIcon",
2453
+ "name": "error",
2411
2454
  "type": {
2412
2455
  "text": "boolean"
2413
2456
  },
2414
- "description": "If set, the `icon` attribute will be applied to the trigger `auro-input` element.",
2415
- "fieldName": "triggerIcon"
2457
+ "description": "If set to true, the checkbox will be displayed with an error state.",
2458
+ "fieldName": "error"
2416
2459
  },
2417
2460
  {
2418
- "name": "type",
2461
+ "name": "id",
2419
2462
  "type": {
2420
2463
  "text": "string"
2421
2464
  },
2422
- "description": "Applies the defined value as the type attribute on `auro-input`.",
2423
- "fieldName": "type"
2465
+ "description": "The id global attribute defines an identifier (ID) which must be unique in the whole document.",
2466
+ "fieldName": "id"
2424
2467
  },
2425
2468
  {
2426
- "name": "typedValue",
2469
+ "name": "name",
2427
2470
  "type": {
2428
2471
  "text": "string"
2429
2472
  },
2430
- "description": "Specifies the value of the input element within the combobox.",
2431
- "fieldName": "typedValue"
2473
+ "description": "Accepts any string and is used to identify related checkboxes when submitting form data.",
2474
+ "fieldName": "name"
2432
2475
  },
2433
2476
  {
2434
- "name": "validity",
2477
+ "name": "onDark",
2435
2478
  "type": {
2436
- "text": "string"
2479
+ "text": "boolean"
2437
2480
  },
2438
- "description": "Specifies the `validityState` this element is in.",
2439
- "fieldName": "validity"
2481
+ "description": "DEPRECATED - use `appearance=\"inverse\"` instead.",
2482
+ "fieldName": "onDark"
2440
2483
  },
2441
2484
  {
2442
2485
  "name": "value",
2443
2486
  "type": {
2444
2487
  "text": "string"
2445
2488
  },
2446
- "description": "Value selected for the dropdown menu.",
2489
+ "description": "Sets the element's input value. Must be unique within an auro-checkbox-group element.",
2447
2490
  "fieldName": "value"
2448
2491
  },
2449
2492
  {
2450
- "name": "largeFullscreenHeadline",
2451
- "type": {
2452
- "text": "boolean"
2453
- },
2454
- "description": "If declared, make bib.fullscreen.headline in HeadingDisplay.\nOtherwise, Heading 600",
2455
- "fieldName": "largeFullscreenHeadline"
2456
- },
2457
- {
2458
- "name": "fullscreenBreakpoint",
2493
+ "name": "tabindex",
2459
2494
  "type": {
2460
- "text": "'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'"
2495
+ "text": "number"
2461
2496
  },
2462
- "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.",
2463
- "default": "'sm'",
2464
- "fieldName": "fullscreenBreakpoint"
2497
+ "description": "The tabindex attribute for the checkbox.",
2498
+ "fieldName": "tabIndex"
2465
2499
  },
2466
2500
  {
2467
- "name": "shape",
2501
+ "name": "aria-checked",
2468
2502
  "type": {
2469
2503
  "text": "string"
2470
2504
  },
2471
- "fieldName": "shape",
2472
- "inheritedFrom": {
2473
- "name": "AuroElement",
2474
- "module": "components/layoutElement/src/auroElement.js"
2475
- }
2505
+ "description": "The aria-checked attribute for the checkbox.",
2506
+ "fieldName": "ariaChecked"
2476
2507
  },
2477
2508
  {
2478
- "name": "size",
2509
+ "name": "aria-disabled",
2479
2510
  "type": {
2480
2511
  "text": "string"
2481
2512
  },
2482
- "fieldName": "size",
2483
- "inheritedFrom": {
2484
- "name": "AuroElement",
2485
- "module": "components/layoutElement/src/auroElement.js"
2486
- }
2513
+ "description": "The aria-disabled attribute for the checkbox.",
2514
+ "fieldName": "ariaDisabled"
2487
2515
  },
2488
2516
  {
2489
- "name": "ondark",
2517
+ "name": "role",
2490
2518
  "type": {
2491
- "text": "boolean"
2519
+ "text": "string"
2492
2520
  },
2493
- "fieldName": "onDark",
2494
- "inheritedFrom": {
2495
- "name": "AuroElement",
2496
- "module": "components/layoutElement/src/auroElement.js"
2497
- }
2521
+ "description": "The ARIA role for the element. Must remain 'checkbox' for screen readers\nto correctly identify this as a checkbox control.",
2522
+ "fieldName": "role"
2498
2523
  }
2499
2524
  ],
2500
2525
  "superclass": {
2501
- "name": "AuroElement",
2502
- "module": "/components/layoutElement/src/auroElement.js"
2526
+ "name": "LitElement",
2527
+ "package": "lit"
2503
2528
  },
2504
- "tagName": "auro-combobox",
2529
+ "tagName": "auro-checkbox",
2505
2530
  "customElement": true
2506
2531
  }
2507
2532
  ],
2508
2533
  "exports": [
2509
2534
  {
2510
2535
  "kind": "js",
2511
- "name": "AuroCombobox",
2536
+ "name": "AuroCheckbox",
2512
2537
  "declaration": {
2513
- "name": "AuroCombobox",
2514
- "module": "components/combobox/src/auro-combobox.js"
2538
+ "name": "AuroCheckbox",
2539
+ "module": "components/checkbox/src/auro-checkbox.js"
2515
2540
  }
2516
2541
  }
2517
2542
  ]
2518
2543
  },
2519
2544
  {
2520
2545
  "kind": "javascript-module",
2521
- "path": "components/combobox/src/comboboxKeyboardStrategy.js",
2522
- "declarations": [
2523
- {
2524
- "kind": "variable",
2525
- "name": "comboboxKeyboardStrategy",
2526
- "type": {
2527
- "text": "object"
2528
- },
2529
- "default": "{ ArrowDown(component, evt, ctx) { // If the clear button has focus, let the browser handle ArrowDown normally. if (isClearBtnFocused(ctx)) { return; } // option display and navigation are prevented if there are no available options if (component.availableOptions.length > 0) { evt.preventDefault(); // navigate if bib is open otherwise open it if (component.dropdown.isPopoverVisible) { navigateArrow(component, 'down'); } else { component.showBib(); } } }, ArrowUp(component, evt, ctx) { // If the clear button has focus, let the browser handle ArrowUp normally. if (isClearBtnFocused(ctx)) { return; } // option display and navigation are prevented if there are no available options if (component.availableOptions.length > 0) { evt.preventDefault(); // navigate if bib is open otherwise open it if (component.dropdown.isPopoverVisible) { navigateArrow(component, 'up'); } else { component.showBib(); } } }, End(component, evt, ctx) { if (ctx.isExpanded) { evt.preventDefault(); evt.stopPropagation(); component.activateLastEnabledAvailableOption(); } }, Enter(component, evt, ctx) { // Forms should not submit on Enter from a combobox, regardless of which // child element (input, clear button, menu) is focused. evt.stopPropagation(); if (isClearBtnFocused(ctx)) { // Let the browser dispatch Enter to the focused clear button so its // built-in activation fires and clears the selection. Do NOT call // preventDefault — that would block the activation. return; } if (ctx.isExpanded && component.menu.optionActive) { reconcileMenuIndex(component.menu); component.menu.makeSelection(); if (ctx.isModal) { component.setTriggerInputFocus(); } evt.preventDefault(); } else { evt.preventDefault(); component.showBib(); } }, Escape(component, evt, ctx) { if (!ctx.isExpanded) { return; } // Prevent the Escape key from bubbling up and closing any parent dialogs / drawers / popups evt.stopPropagation(); if (ctx.isModal) { component.setTriggerInputFocus(); } component.hideBib(); }, Home(component, evt, ctx) { if (ctx.isExpanded) { evt.preventDefault(); evt.stopPropagation(); component.activateFirstEnabledAvailableOption(); } }, Tab(component, evt, ctx) { if (ctx.isExpanded && !isClearBtnFocused(ctx)) { // When the clear button is focused, Tab events do not bubble out of // its shadow DOM, so this handler only fires when the clear button // is NOT focused. In that case, select the active option and close. reconcileMenuIndex(component.menu); component.menu.makeSelection(); component.hideBib(); // In fullscreen modal mode, closing the dialog does not // automatically restores focus to the input. In the tab case, // Explicitly move focus to the trigger's clear button so the // user can continues tabbing through the page normally. if (ctx.isModal && !evt.shiftKey) { component.setClearBtnFocus(); } } } }"
2530
- }
2531
- ],
2546
+ "path": "components/checkbox/src/index.js",
2547
+ "declarations": [],
2532
2548
  "exports": [
2533
2549
  {
2534
2550
  "kind": "js",
2535
- "name": "comboboxKeyboardStrategy",
2551
+ "name": "AuroCheckbox",
2536
2552
  "declaration": {
2537
- "name": "comboboxKeyboardStrategy",
2538
- "module": "components/combobox/src/comboboxKeyboardStrategy.js"
2553
+ "name": "AuroCheckbox",
2554
+ "module": "components/checkbox/src/index.js"
2539
2555
  }
2540
- }
2541
- ]
2542
- },
2543
- {
2544
- "kind": "javascript-module",
2545
- "path": "components/combobox/src/index.js",
2546
- "declarations": [],
2547
- "exports": [
2556
+ },
2548
2557
  {
2549
2558
  "kind": "js",
2550
- "name": "AuroCombobox",
2559
+ "name": "AuroCheckboxGroup",
2551
2560
  "declaration": {
2552
- "name": "AuroCombobox",
2553
- "module": "components/combobox/src/index.js"
2561
+ "name": "AuroCheckboxGroup",
2562
+ "module": "components/checkbox/src/index.js"
2554
2563
  }
2555
2564
  }
2556
2565
  ]
2557
2566
  },
2558
2567
  {
2559
2568
  "kind": "javascript-module",
2560
- "path": "components/combobox/src/registered.js",
2569
+ "path": "components/checkbox/src/registered.js",
2561
2570
  "declarations": [],
2562
- "exports": [
2563
- {
2564
- "kind": "js",
2565
- "name": "AuroCombobox",
2566
- "declaration": {
2567
- "name": "AuroCombobox",
2568
- "module": "components/combobox/src/registered.js"
2569
- }
2570
- }
2571
- ]
2571
+ "exports": []
2572
2572
  },
2573
2573
  {
2574
2574
  "kind": "javascript-module",
@@ -16533,6 +16533,26 @@
16533
16533
  }
16534
16534
  }
16535
16535
  },
16536
+ {
16537
+ "kind": "function",
16538
+ "name": "serializeMultiSelectValue",
16539
+ "parameters": [
16540
+ {
16541
+ "name": "values",
16542
+ "description": "The selected values.",
16543
+ "type": {
16544
+ "text": "Array<string>|undefined"
16545
+ }
16546
+ }
16547
+ ],
16548
+ "description": "Serializes a multi-select value array back into the String `value` property.\nAn empty (or missing) array collapses to `undefined` so an emptied selection\nclears `value` rather than reflecting a `\"[]\"` attribute.",
16549
+ "privacy": "private",
16550
+ "return": {
16551
+ "type": {
16552
+ "text": "string|undefined"
16553
+ }
16554
+ }
16555
+ },
16536
16556
  {
16537
16557
  "kind": "function",
16538
16558
  "name": "arraysAreEqual",
@@ -16580,6 +16600,25 @@
16580
16600
  }
16581
16601
  }
16582
16602
  },
16603
+ {
16604
+ "kind": "function",
16605
+ "name": "isSelectableByValue",
16606
+ "parameters": [
16607
+ {
16608
+ "name": "option",
16609
+ "description": "The option to check.",
16610
+ "type": {
16611
+ "text": "HTMLElement"
16612
+ }
16613
+ }
16614
+ ],
16615
+ "description": "Validates if an option may be selected by matching a programmatic value.\nUnlike `isOptionInteractive`, `hidden` is allowed: the combobox toggles\n`hidden` as its type-ahead filter, so a filtered-out option is still a\nvalid programmatic selection. Only disabled and static options — which are\nnever selectable — are rejected.",
16616
+ "return": {
16617
+ "type": {
16618
+ "text": "boolean"
16619
+ }
16620
+ }
16621
+ },
16583
16622
  {
16584
16623
  "kind": "function",
16585
16624
  "name": "dispatchMenuEvent",
@@ -16620,6 +16659,14 @@
16620
16659
  "module": "components/menu/src/auro-menu-utils.js"
16621
16660
  }
16622
16661
  },
16662
+ {
16663
+ "kind": "js",
16664
+ "name": "serializeMultiSelectValue",
16665
+ "declaration": {
16666
+ "name": "serializeMultiSelectValue",
16667
+ "module": "components/menu/src/auro-menu-utils.js"
16668
+ }
16669
+ },
16623
16670
  {
16624
16671
  "kind": "js",
16625
16672
  "name": "arraysAreEqual",
@@ -16636,6 +16683,14 @@
16636
16683
  "module": "components/menu/src/auro-menu-utils.js"
16637
16684
  }
16638
16685
  },
16686
+ {
16687
+ "kind": "js",
16688
+ "name": "isSelectableByValue",
16689
+ "declaration": {
16690
+ "name": "isSelectableByValue",
16691
+ "module": "components/menu/src/auro-menu-utils.js"
16692
+ }
16693
+ },
16639
16694
  {
16640
16695
  "kind": "js",
16641
16696
  "name": "dispatchMenuEvent",
@@ -16770,7 +16825,7 @@
16770
16825
  }
16771
16826
  }
16772
16827
  ],
16773
- "description": "Selects options by value.",
16828
+ "description": "Selects options by value. Options marked `disabled` or `static` are not selectable; `hidden` options remain selectable. In single-select mode, if the value matches a non-selectable option the selection is cleared and `auroMenu-selectValueFailure` is dispatched. In multi-select mode, non-selectable entries are dropped and the remaining selectable entries are selected; `auroMenu-selectValueFailure` is dispatched only when none of the entries match a selectable option. Passing `undefined`, `null`, an empty string, or an empty array clears the selection without dispatching a failure.",
16774
16829
  "privacy": "public"
16775
16830
  },
16776
16831
  {
@@ -17120,7 +17175,7 @@
17120
17175
  "type": {
17121
17176
  "text": "string"
17122
17177
  },
17123
- "description": "The value of the selected option. In multi-select mode, this is a JSON stringified array of selected option values.",
17178
+ "description": "The value of the selected option. In multi-select mode, this is a JSON stringified array of selected option values.\nOptions marked `disabled` or `static` are not selectable by value; `hidden` options remain selectable. In single-select mode, if the value matches a non-selectable option the selection is cleared (`optionSelected` becomes `undefined`) and `auroMenu-selectValueFailure` is dispatched. In multi-select mode, non-selectable entries are dropped from the value and the remaining selectable entries are selected; `auroMenu-selectValueFailure` is dispatched only when none of the entries match a selectable option.",
17124
17179
  "default": "undefined",
17125
17180
  "attribute": "value",
17126
17181
  "reflects": true
@@ -17132,9 +17187,9 @@
17132
17187
  "type": {
17133
17188
  "text": "object"
17134
17189
  },
17135
- "description": "An array of currently selected menu options, type `HTMLElement` by default. In multi-select mode, `optionSelected` is an array of HTML elements.",
17136
- "default": "undefined",
17137
- "attribute": "optionSelected"
17190
+ "description": "The currently selected menu option(s). In single-select mode this is a single `HTMLElement` (or `undefined` when nothing is selected). In multi-select mode this is an array of `HTMLElement`s.",
17191
+ "readonly": true,
17192
+ "default": "undefined"
17138
17193
  },
17139
17194
  {
17140
17195
  "kind": "field",
@@ -17167,8 +17222,8 @@
17167
17222
  "text": "object"
17168
17223
  },
17169
17224
  "description": "Specifies the current active menuOption.",
17170
- "default": "undefined",
17171
- "attribute": "optionactive"
17225
+ "readonly": true,
17226
+ "default": "undefined"
17172
17227
  },
17173
17228
  {
17174
17229
  "kind": "field",
@@ -17380,30 +17435,12 @@
17380
17435
  "default": "false",
17381
17436
  "fieldName": "noCheckmark"
17382
17437
  },
17383
- {
17384
- "name": "optionactive",
17385
- "type": {
17386
- "text": "object"
17387
- },
17388
- "description": "Specifies the current active menuOption.",
17389
- "default": "undefined",
17390
- "fieldName": "optionActive"
17391
- },
17392
- {
17393
- "name": "optionSelected",
17394
- "type": {
17395
- "text": "object"
17396
- },
17397
- "description": "An array of currently selected menu options, type `HTMLElement` by default. In multi-select mode, `optionSelected` is an array of HTML elements.",
17398
- "default": "undefined",
17399
- "fieldName": "optionSelected"
17400
- },
17401
17438
  {
17402
17439
  "name": "value",
17403
17440
  "type": {
17404
17441
  "text": "string"
17405
17442
  },
17406
- "description": "The value of the selected option. In multi-select mode, this is a JSON stringified array of selected option values.",
17443
+ "description": "The value of the selected option. In multi-select mode, this is a JSON stringified array of selected option values.\nOptions marked `disabled` or `static` are not selectable by value; `hidden` options remain selectable. In single-select mode, if the value matches a non-selectable option the selection is cleared (`optionSelected` becomes `undefined`) and `auroMenu-selectValueFailure` is dispatched. In multi-select mode, non-selectable entries are dropped from the value and the remaining selectable entries are selected; `auroMenu-selectValueFailure` is dispatched only when none of the entries match a selectable option.",
17407
17444
  "default": "undefined",
17408
17445
  "fieldName": "value"
17409
17446
  },
@@ -17620,6 +17657,8 @@
17620
17657
  "type": {
17621
17658
  "text": "boolean"
17622
17659
  },
17660
+ "description": "**Deprecated.** Use the `value` attribute on `auro-menu` to set the selected option when the menu renders (or call `menu.selectByValue(value)` programmatically). Support for the child-level `selected` attribute will be removed in a future major release.",
17661
+ "deprecated": "Use the `value` attribute on `auro-menu` instead.",
17623
17662
  "default": "false",
17624
17663
  "attribute": "selected",
17625
17664
  "reflects": true
@@ -17658,6 +17697,18 @@
17658
17697
  "attribute": "nomatch",
17659
17698
  "reflects": true
17660
17699
  },
17700
+ {
17701
+ "kind": "field",
17702
+ "name": "persistent",
17703
+ "privacy": "public",
17704
+ "type": {
17705
+ "text": "boolean"
17706
+ },
17707
+ "description": "When true, this option is excluded from `matchWord` DOM rewriting — useful for utility rows (e.g., \"Add new…\") that must render identically regardless of the current filter.",
17708
+ "default": "false",
17709
+ "attribute": "persistent",
17710
+ "reflects": true
17711
+ },
17661
17712
  {
17662
17713
  "kind": "field",
17663
17714
  "name": "tabIndex",
@@ -17783,6 +17834,13 @@
17783
17834
  }
17784
17835
  ],
17785
17836
  "attributes": [
17837
+ {
17838
+ "type": {
17839
+ "text": "Boolean"
17840
+ },
17841
+ "description": "When present, marks the option as non-interactive — it renders but is skipped during keyboard navigation and cannot be selected. Useful for section headers, informational rows inside a menu, or attaching event listeners.",
17842
+ "name": "static"
17843
+ },
17786
17844
  {
17787
17845
  "name": "noCheckmark",
17788
17846
  "type": {
@@ -17796,6 +17854,8 @@
17796
17854
  "type": {
17797
17855
  "text": "boolean"
17798
17856
  },
17857
+ "description": "**Deprecated.** Use the `value` attribute on `auro-menu` to set the selected option when the menu renders (or call `menu.selectByValue(value)` programmatically). Support for the child-level `selected` attribute will be removed in a future major release.",
17858
+ "deprecated": "Use the `value` attribute on `auro-menu` instead.",
17799
17859
  "default": "false",
17800
17860
  "fieldName": "selected"
17801
17861
  },
@@ -17838,6 +17898,15 @@
17838
17898
  "default": "false",
17839
17899
  "fieldName": "noMatch"
17840
17900
  },
17901
+ {
17902
+ "name": "persistent",
17903
+ "type": {
17904
+ "text": "boolean"
17905
+ },
17906
+ "description": "When true, this option is excluded from `matchWord` DOM rewriting — useful for utility rows (e.g., \"Add new…\") that must render identically regardless of the current filter.",
17907
+ "default": "false",
17908
+ "fieldName": "persistent"
17909
+ },
17841
17910
  {
17842
17911
  "name": "layout",
17843
17912
  "type": {
@@ -19387,9 +19456,14 @@
19387
19456
  "name": "setMenuValue",
19388
19457
  "parameters": [
19389
19458
  {
19390
- "name": "value"
19459
+ "name": "value",
19460
+ "description": "The value to match against the menu options.",
19461
+ "type": {
19462
+ "text": "string"
19463
+ }
19391
19464
  }
19392
- ]
19465
+ ],
19466
+ "description": "Sets the selected value by matching it against the menu options. Options marked `disabled` or `static` are not selectable: if the value matches one, the selection is rejected and `value` is cleared to `undefined` while `optionSelected` is cleared to `undefined` in single-select or `[]` in multiSelect. `hidden` options remain selectable."
19393
19467
  },
19394
19468
  {
19395
19469
  "kind": "method",
@@ -20002,7 +20076,7 @@
20002
20076
  "type": {
20003
20077
  "text": "string"
20004
20078
  },
20005
- "description": "Value selected for the component.",
20079
+ "description": "Value selected for the component. When set programmatically or as a preset attribute, the value must match a selectable option. If it matches an option marked `disabled` or `static`, the selection is rejected: `value` is cleared to `undefined` while `optionSelected` is cleared to `undefined` in single-select or `[]` in multiSelect. `hidden` options remain selectable by value.",
20006
20080
  "attribute": "value",
20007
20081
  "reflects": true
20008
20082
  },
@@ -20351,7 +20425,7 @@
20351
20425
  "type": {
20352
20426
  "text": "string"
20353
20427
  },
20354
- "description": "Value selected for the component.",
20428
+ "description": "Value selected for the component. When set programmatically or as a preset attribute, the value must match a selectable option. If it matches an option marked `disabled` or `static`, the selection is rejected: `value` is cleared to `undefined` while `optionSelected` is cleared to `undefined` in single-select or `[]` in multiSelect. `hidden` options remain selectable by value.",
20355
20429
  "fieldName": "value"
20356
20430
  },
20357
20431
  {