@emuanalytics/flow-rdf-ui 4.0.7 → 4.0.9

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.
@@ -267,471 +267,167 @@
267
267
  },
268
268
  {
269
269
  "kind": "javascript-module",
270
- "path": "components/badge/badge.component.js",
270
+ "path": "components/animation/animation.component.js",
271
271
  "declarations": [
272
272
  {
273
273
  "kind": "class",
274
274
  "description": "",
275
- "name": "FlowUiBadge",
276
- "cssParts": [
277
- {
278
- "description": "The component's base wrapper.",
279
- "name": "base"
280
- }
281
- ],
275
+ "name": "FlowUiAnimation",
282
276
  "slots": [
283
277
  {
284
- "description": "The badge's content.",
278
+ "description": "The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<flow-ui-animation>` elements.",
285
279
  "name": ""
286
280
  }
287
281
  ],
288
282
  "members": [
289
283
  {
290
284
  "kind": "field",
291
- "name": "variant",
285
+ "name": "animation",
292
286
  "type": {
293
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
287
+ "text": "Animation | undefined"
294
288
  },
295
- "default": "'primary'",
296
- "description": "The badge's theme variant.",
297
- "attribute": "variant",
298
- "reflects": true
289
+ "privacy": "private"
299
290
  },
300
291
  {
301
292
  "kind": "field",
302
- "name": "pill",
293
+ "name": "hasStarted",
303
294
  "type": {
304
295
  "text": "boolean"
305
296
  },
306
- "default": "false",
307
- "description": "Draws a pill-style badge with rounded edges.",
308
- "attribute": "pill",
309
- "reflects": true
297
+ "privacy": "private",
298
+ "default": "false"
310
299
  },
311
300
  {
312
301
  "kind": "field",
313
- "name": "pulse",
302
+ "name": "defaultSlot",
314
303
  "type": {
315
- "text": "boolean"
304
+ "text": "Promise<HTMLSlotElement>"
316
305
  },
317
- "default": "false",
318
- "description": "Makes the badge pulsate to draw attention.",
319
- "attribute": "pulse",
320
- "reflects": true
321
- }
322
- ],
323
- "attributes": [
306
+ "privacy": "private"
307
+ },
324
308
  {
325
- "name": "variant",
309
+ "kind": "field",
310
+ "name": "name",
326
311
  "type": {
327
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
312
+ "text": "string"
328
313
  },
329
- "default": "'primary'",
330
- "description": "The badge's theme variant.",
331
- "fieldName": "variant"
314
+ "default": "'none'",
315
+ "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.",
316
+ "attribute": "name"
332
317
  },
333
318
  {
334
- "name": "pill",
319
+ "kind": "field",
320
+ "name": "play",
335
321
  "type": {
336
322
  "text": "boolean"
337
323
  },
338
324
  "default": "false",
339
- "description": "Draws a pill-style badge with rounded edges.",
340
- "fieldName": "pill"
325
+ "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
326
+ "attribute": "play",
327
+ "reflects": true
341
328
  },
342
329
  {
343
- "name": "pulse",
330
+ "kind": "field",
331
+ "name": "delay",
344
332
  "type": {
345
- "text": "boolean"
333
+ "text": "number"
346
334
  },
347
- "default": "false",
348
- "description": "Makes the badge pulsate to draw attention.",
349
- "fieldName": "pulse"
350
- }
351
- ],
352
- "superclass": {
353
- "name": "FlowRdfElement",
354
- "module": "/src/internal/flow-ui-rdf-element"
355
- },
356
- "tagName": "flow-ui-badge",
357
- "summary": "Badges are used to draw attention and display statuses or counts.",
358
- "customElement": true
359
- }
360
- ],
361
- "exports": [
362
- {
363
- "kind": "js",
364
- "name": "default",
365
- "declaration": {
366
- "name": "FlowUiBadge",
367
- "module": "components/badge/badge.component.js"
368
- }
369
- }
370
- ]
371
- },
372
- {
373
- "kind": "javascript-module",
374
- "path": "components/badge/badge.js",
375
- "declarations": [],
376
- "exports": [
377
- {
378
- "kind": "js",
379
- "name": "default",
380
- "declaration": {
381
- "name": "FlowUiBadge",
382
- "module": "components/badge/badge.js"
383
- }
384
- }
385
- ]
386
- },
387
- {
388
- "kind": "javascript-module",
389
- "path": "components/avatar/avatar.component.js",
390
- "declarations": [
391
- {
392
- "kind": "class",
393
- "description": "",
394
- "name": "FlowUiAvatar",
395
- "cssProperties": [
396
- {
397
- "description": "The size of the avatar.",
398
- "name": "--size"
399
- }
400
- ],
401
- "cssParts": [
402
- {
403
- "description": "The component's base wrapper.",
404
- "name": "base"
405
- },
406
- {
407
- "description": "The container that wraps the avatar's icon.",
408
- "name": "icon"
409
- },
410
- {
411
- "description": "The container that wraps the avatar's initials.",
412
- "name": "initials"
335
+ "default": "0",
336
+ "description": "The number of milliseconds to delay the start of the animation.",
337
+ "attribute": "delay"
413
338
  },
414
- {
415
- "description": "The avatar image. Only shown when the `image` attribute is set.",
416
- "name": "image"
417
- }
418
- ],
419
- "slots": [
420
- {
421
- "description": "The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.",
422
- "name": "icon"
423
- }
424
- ],
425
- "members": [
426
339
  {
427
340
  "kind": "field",
428
- "name": "hasError",
341
+ "name": "direction",
429
342
  "type": {
430
- "text": "boolean"
343
+ "text": "PlaybackDirection"
431
344
  },
432
- "privacy": "private",
433
- "default": "false"
345
+ "default": "'normal'",
346
+ "description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)",
347
+ "attribute": "direction"
434
348
  },
435
349
  {
436
350
  "kind": "field",
437
- "name": "image",
351
+ "name": "duration",
438
352
  "type": {
439
- "text": "string"
353
+ "text": "number"
440
354
  },
441
- "default": "''",
442
- "description": "The image source to use for the avatar.",
443
- "attribute": "image"
355
+ "default": "1000",
356
+ "description": "The number of milliseconds each iteration of the animation takes to complete.",
357
+ "attribute": "duration"
444
358
  },
445
359
  {
446
360
  "kind": "field",
447
- "name": "label",
361
+ "name": "easing",
448
362
  "type": {
449
363
  "text": "string"
450
364
  },
451
- "default": "''",
452
- "description": "A label to use to describe the avatar to assistive devices.",
453
- "attribute": "label"
365
+ "default": "'linear'",
366
+ "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
367
+ "attribute": "easing"
454
368
  },
455
369
  {
456
370
  "kind": "field",
457
- "name": "initials",
371
+ "name": "endDelay",
458
372
  "type": {
459
- "text": "string"
373
+ "text": "number"
460
374
  },
461
- "default": "''",
462
- "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
463
- "attribute": "initials"
375
+ "default": "0",
376
+ "description": "The number of milliseconds to delay after the active period of an animation sequence.",
377
+ "attribute": "end-delay"
464
378
  },
465
379
  {
466
380
  "kind": "field",
467
- "name": "loading",
381
+ "name": "fill",
468
382
  "type": {
469
- "text": "'eager' | 'lazy'"
383
+ "text": "FillMode"
470
384
  },
471
- "default": "'eager'",
472
- "description": "Indicates how the browser should load the image.",
473
- "attribute": "loading"
385
+ "default": "'auto'",
386
+ "description": "Sets how the animation applies styles to its target before and after its execution.",
387
+ "attribute": "fill"
474
388
  },
475
389
  {
476
390
  "kind": "field",
477
- "name": "shape",
478
- "type": {
479
- "text": "'circle' | 'square' | 'rounded'"
480
- },
481
- "default": "'circle'",
482
- "description": "The shape of the avatar.",
483
- "attribute": "shape",
484
- "reflects": true
485
- }
486
- ],
487
- "attributes": [
391
+ "name": "iterations",
392
+ "default": "Infinity",
393
+ "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
394
+ "attribute": "iterations"
395
+ },
488
396
  {
489
- "name": "image",
397
+ "kind": "field",
398
+ "name": "iterationStart",
490
399
  "type": {
491
- "text": "string"
400
+ "text": "number"
492
401
  },
493
- "default": "''",
494
- "description": "The image source to use for the avatar.",
495
- "fieldName": "image"
402
+ "default": "0",
403
+ "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
404
+ "attribute": "iteration-start"
496
405
  },
497
406
  {
498
- "name": "label",
407
+ "kind": "field",
408
+ "name": "keyframes",
499
409
  "type": {
500
- "text": "string"
410
+ "text": "Keyframe[] | undefined"
501
411
  },
502
- "default": "''",
503
- "description": "A label to use to describe the avatar to assistive devices.",
504
- "fieldName": "label"
412
+ "description": "The keyframes to use for the animation. If this is set, `name` will be ignored."
505
413
  },
506
414
  {
507
- "name": "initials",
415
+ "kind": "field",
416
+ "name": "playbackRate",
508
417
  "type": {
509
- "text": "string"
418
+ "text": "number"
510
419
  },
511
- "default": "''",
512
- "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
513
- "fieldName": "initials"
420
+ "default": "1",
421
+ "description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.",
422
+ "attribute": "playback-rate"
514
423
  },
515
424
  {
516
- "name": "loading",
425
+ "kind": "field",
426
+ "name": "currentTime",
517
427
  "type": {
518
- "text": "'eager' | 'lazy'"
428
+ "text": "CSSNumberish"
519
429
  },
520
- "default": "'eager'",
521
- "description": "Indicates how the browser should load the image.",
522
- "fieldName": "loading"
523
- },
524
- {
525
- "name": "shape",
526
- "type": {
527
- "text": "'circle' | 'square' | 'rounded'"
528
- },
529
- "default": "'circle'",
530
- "description": "The shape of the avatar.",
531
- "fieldName": "shape"
532
- }
533
- ],
534
- "superclass": {
535
- "name": "FlowRdfElement",
536
- "module": "/src/internal/flow-ui-rdf-element"
537
- },
538
- "tagName": "flow-ui-avatar",
539
- "summary": "Avatars are used to represent a person or object.",
540
- "dependencies": [
541
- "flow-ui-icon"
542
- ],
543
- "customElement": true
544
- }
545
- ],
546
- "exports": [
547
- {
548
- "kind": "js",
549
- "name": "default",
550
- "declaration": {
551
- "name": "FlowUiAvatar",
552
- "module": "components/avatar/avatar.component.js"
553
- }
554
- }
555
- ]
556
- },
557
- {
558
- "kind": "javascript-module",
559
- "path": "components/avatar/avatar.js",
560
- "declarations": [],
561
- "exports": [
562
- {
563
- "kind": "js",
564
- "name": "default",
565
- "declaration": {
566
- "name": "FlowUiAvatar",
567
- "module": "components/avatar/avatar.js"
568
- }
569
- }
570
- ]
571
- },
572
- {
573
- "kind": "javascript-module",
574
- "path": "components/animation/animation.component.js",
575
- "declarations": [
576
- {
577
- "kind": "class",
578
- "description": "",
579
- "name": "FlowUiAnimation",
580
- "slots": [
581
- {
582
- "description": "The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<flow-ui-animation>` elements.",
583
- "name": ""
584
- }
585
- ],
586
- "members": [
587
- {
588
- "kind": "field",
589
- "name": "animation",
590
- "type": {
591
- "text": "Animation | undefined"
592
- },
593
- "privacy": "private"
594
- },
595
- {
596
- "kind": "field",
597
- "name": "hasStarted",
598
- "type": {
599
- "text": "boolean"
600
- },
601
- "privacy": "private",
602
- "default": "false"
603
- },
604
- {
605
- "kind": "field",
606
- "name": "defaultSlot",
607
- "type": {
608
- "text": "Promise<HTMLSlotElement>"
609
- },
610
- "privacy": "private"
611
- },
612
- {
613
- "kind": "field",
614
- "name": "name",
615
- "type": {
616
- "text": "string"
617
- },
618
- "default": "'none'",
619
- "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.",
620
- "attribute": "name"
621
- },
622
- {
623
- "kind": "field",
624
- "name": "play",
625
- "type": {
626
- "text": "boolean"
627
- },
628
- "default": "false",
629
- "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
630
- "attribute": "play",
631
- "reflects": true
632
- },
633
- {
634
- "kind": "field",
635
- "name": "delay",
636
- "type": {
637
- "text": "number"
638
- },
639
- "default": "0",
640
- "description": "The number of milliseconds to delay the start of the animation.",
641
- "attribute": "delay"
642
- },
643
- {
644
- "kind": "field",
645
- "name": "direction",
646
- "type": {
647
- "text": "PlaybackDirection"
648
- },
649
- "default": "'normal'",
650
- "description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)",
651
- "attribute": "direction"
652
- },
653
- {
654
- "kind": "field",
655
- "name": "duration",
656
- "type": {
657
- "text": "number"
658
- },
659
- "default": "1000",
660
- "description": "The number of milliseconds each iteration of the animation takes to complete.",
661
- "attribute": "duration"
662
- },
663
- {
664
- "kind": "field",
665
- "name": "easing",
666
- "type": {
667
- "text": "string"
668
- },
669
- "default": "'linear'",
670
- "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
671
- "attribute": "easing"
672
- },
673
- {
674
- "kind": "field",
675
- "name": "endDelay",
676
- "type": {
677
- "text": "number"
678
- },
679
- "default": "0",
680
- "description": "The number of milliseconds to delay after the active period of an animation sequence.",
681
- "attribute": "end-delay"
682
- },
683
- {
684
- "kind": "field",
685
- "name": "fill",
686
- "type": {
687
- "text": "FillMode"
688
- },
689
- "default": "'auto'",
690
- "description": "Sets how the animation applies styles to its target before and after its execution.",
691
- "attribute": "fill"
692
- },
693
- {
694
- "kind": "field",
695
- "name": "iterations",
696
- "default": "Infinity",
697
- "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
698
- "attribute": "iterations"
699
- },
700
- {
701
- "kind": "field",
702
- "name": "iterationStart",
703
- "type": {
704
- "text": "number"
705
- },
706
- "default": "0",
707
- "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
708
- "attribute": "iteration-start"
709
- },
710
- {
711
- "kind": "field",
712
- "name": "keyframes",
713
- "type": {
714
- "text": "Keyframe[] | undefined"
715
- },
716
- "description": "The keyframes to use for the animation. If this is set, `name` will be ignored."
717
- },
718
- {
719
- "kind": "field",
720
- "name": "playbackRate",
721
- "type": {
722
- "text": "number"
723
- },
724
- "default": "1",
725
- "description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.",
726
- "attribute": "playback-rate"
727
- },
728
- {
729
- "kind": "field",
730
- "name": "currentTime",
731
- "type": {
732
- "text": "CSSNumberish"
733
- },
734
- "description": "Gets and sets the current animation time."
430
+ "description": "Gets and sets the current animation time."
735
431
  },
736
432
  {
737
433
  "kind": "field",
@@ -974,122 +670,160 @@
974
670
  },
975
671
  {
976
672
  "kind": "javascript-module",
977
- "path": "components/breadcrumb-item/breadcrumb-item.component.js",
673
+ "path": "components/avatar/avatar.component.js",
978
674
  "declarations": [
979
675
  {
980
676
  "kind": "class",
981
677
  "description": "",
982
- "name": "FlowUiBreadcrumbItem",
678
+ "name": "FlowUiAvatar",
679
+ "cssProperties": [
680
+ {
681
+ "description": "The size of the avatar.",
682
+ "name": "--size"
683
+ }
684
+ ],
983
685
  "cssParts": [
984
686
  {
985
687
  "description": "The component's base wrapper.",
986
688
  "name": "base"
987
689
  },
988
690
  {
989
- "description": "The breadcrumb item's label.",
990
- "name": "label"
991
- },
992
- {
993
- "description": "The container that wraps the prefix.",
994
- "name": "prefix"
691
+ "description": "The container that wraps the avatar's icon.",
692
+ "name": "icon"
995
693
  },
996
694
  {
997
- "description": "The container that wraps the suffix.",
998
- "name": "suffix"
695
+ "description": "The container that wraps the avatar's initials.",
696
+ "name": "initials"
999
697
  },
1000
698
  {
1001
- "description": "The container that wraps the separator.",
1002
- "name": "separator"
699
+ "description": "The avatar image. Only shown when the `image` attribute is set.",
700
+ "name": "image"
1003
701
  }
1004
702
  ],
1005
703
  "slots": [
1006
704
  {
1007
- "description": "The breadcrumb item's label.",
1008
- "name": ""
1009
- },
1010
- {
1011
- "description": "An optional prefix, usually an icon or icon button.",
1012
- "name": "prefix"
1013
- },
1014
- {
1015
- "description": "An optional suffix, usually an icon or icon button.",
1016
- "name": "suffix"
1017
- },
1018
- {
1019
- "description": "The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.",
1020
- "name": "separator"
705
+ "description": "The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.",
706
+ "name": "icon"
1021
707
  }
1022
708
  ],
1023
709
  "members": [
1024
710
  {
1025
711
  "kind": "field",
1026
- "name": "hasSlotController",
712
+ "name": "hasError",
713
+ "type": {
714
+ "text": "boolean"
715
+ },
1027
716
  "privacy": "private",
1028
- "readonly": true,
1029
- "default": "new HasSlotController(this, 'prefix', 'suffix')"
717
+ "default": "false"
1030
718
  },
1031
719
  {
1032
720
  "kind": "field",
1033
- "name": "href",
721
+ "name": "image",
1034
722
  "type": {
1035
- "text": "string | undefined"
723
+ "text": "string"
1036
724
  },
1037
- "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
1038
- "attribute": "href"
725
+ "default": "''",
726
+ "description": "The image source to use for the avatar.",
727
+ "attribute": "image"
1039
728
  },
1040
729
  {
1041
730
  "kind": "field",
1042
- "name": "target",
731
+ "name": "label",
1043
732
  "type": {
1044
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
733
+ "text": "string"
1045
734
  },
1046
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
1047
- "attribute": "target"
735
+ "default": "''",
736
+ "description": "A label to use to describe the avatar to assistive devices.",
737
+ "attribute": "label"
1048
738
  },
1049
739
  {
1050
740
  "kind": "field",
1051
- "name": "rel",
741
+ "name": "initials",
1052
742
  "type": {
1053
743
  "text": "string"
1054
744
  },
1055
- "default": "'noreferrer noopener'",
1056
- "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
1057
- "attribute": "rel"
745
+ "default": "''",
746
+ "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
747
+ "attribute": "initials"
748
+ },
749
+ {
750
+ "kind": "field",
751
+ "name": "loading",
752
+ "type": {
753
+ "text": "'eager' | 'lazy'"
754
+ },
755
+ "default": "'eager'",
756
+ "description": "Indicates how the browser should load the image.",
757
+ "attribute": "loading"
758
+ },
759
+ {
760
+ "kind": "field",
761
+ "name": "shape",
762
+ "type": {
763
+ "text": "'circle' | 'square' | 'rounded'"
764
+ },
765
+ "default": "'circle'",
766
+ "description": "The shape of the avatar.",
767
+ "attribute": "shape",
768
+ "reflects": true
1058
769
  }
1059
770
  ],
1060
771
  "attributes": [
1061
772
  {
1062
- "name": "href",
773
+ "name": "image",
1063
774
  "type": {
1064
- "text": "string | undefined"
775
+ "text": "string"
1065
776
  },
1066
- "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
1067
- "fieldName": "href"
777
+ "default": "''",
778
+ "description": "The image source to use for the avatar.",
779
+ "fieldName": "image"
1068
780
  },
1069
781
  {
1070
- "name": "target",
782
+ "name": "label",
1071
783
  "type": {
1072
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
784
+ "text": "string"
1073
785
  },
1074
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
1075
- "fieldName": "target"
786
+ "default": "''",
787
+ "description": "A label to use to describe the avatar to assistive devices.",
788
+ "fieldName": "label"
1076
789
  },
1077
790
  {
1078
- "name": "rel",
791
+ "name": "initials",
1079
792
  "type": {
1080
793
  "text": "string"
1081
794
  },
1082
- "default": "'noreferrer noopener'",
1083
- "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
1084
- "fieldName": "rel"
795
+ "default": "''",
796
+ "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
797
+ "fieldName": "initials"
798
+ },
799
+ {
800
+ "name": "loading",
801
+ "type": {
802
+ "text": "'eager' | 'lazy'"
803
+ },
804
+ "default": "'eager'",
805
+ "description": "Indicates how the browser should load the image.",
806
+ "fieldName": "loading"
807
+ },
808
+ {
809
+ "name": "shape",
810
+ "type": {
811
+ "text": "'circle' | 'square' | 'rounded'"
812
+ },
813
+ "default": "'circle'",
814
+ "description": "The shape of the avatar.",
815
+ "fieldName": "shape"
1085
816
  }
1086
817
  ],
1087
818
  "superclass": {
1088
819
  "name": "FlowRdfElement",
1089
820
  "module": "/src/internal/flow-ui-rdf-element"
1090
821
  },
1091
- "tagName": "flow-ui-breadcrumb-item",
1092
- "summary": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.",
822
+ "tagName": "flow-ui-avatar",
823
+ "summary": "Avatars are used to represent a person or object.",
824
+ "dependencies": [
825
+ "flow-ui-icon"
826
+ ],
1093
827
  "customElement": true
1094
828
  }
1095
829
  ],
@@ -1098,35 +832,35 @@
1098
832
  "kind": "js",
1099
833
  "name": "default",
1100
834
  "declaration": {
1101
- "name": "FlowUiBreadcrumbItem",
1102
- "module": "components/breadcrumb-item/breadcrumb-item.component.js"
835
+ "name": "FlowUiAvatar",
836
+ "module": "components/avatar/avatar.component.js"
1103
837
  }
1104
838
  }
1105
839
  ]
1106
840
  },
1107
841
  {
1108
842
  "kind": "javascript-module",
1109
- "path": "components/breadcrumb-item/breadcrumb-item.js",
843
+ "path": "components/avatar/avatar.js",
1110
844
  "declarations": [],
1111
845
  "exports": [
1112
846
  {
1113
847
  "kind": "js",
1114
848
  "name": "default",
1115
849
  "declaration": {
1116
- "name": "FlowUiBreadcrumbItem",
1117
- "module": "components/breadcrumb-item/breadcrumb-item.js"
850
+ "name": "FlowUiAvatar",
851
+ "module": "components/avatar/avatar.js"
1118
852
  }
1119
853
  }
1120
854
  ]
1121
855
  },
1122
856
  {
1123
857
  "kind": "javascript-module",
1124
- "path": "components/button-group/button-group.component.js",
858
+ "path": "components/badge/badge.component.js",
1125
859
  "declarations": [
1126
860
  {
1127
861
  "kind": "class",
1128
862
  "description": "",
1129
- "name": "FlowUiButtonGroup",
863
+ "name": "FlowUiBadge",
1130
864
  "cssParts": [
1131
865
  {
1132
866
  "description": "The component's base wrapper.",
@@ -1135,116 +869,80 @@
1135
869
  ],
1136
870
  "slots": [
1137
871
  {
1138
- "description": "One or more `<flow-ui-button>` elements to display in the button group.",
872
+ "description": "The badge's content.",
1139
873
  "name": ""
1140
874
  }
1141
875
  ],
1142
876
  "members": [
1143
877
  {
1144
878
  "kind": "field",
1145
- "name": "label",
879
+ "name": "variant",
1146
880
  "type": {
1147
- "text": "string"
881
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
1148
882
  },
1149
- "default": "''",
1150
- "description": "Text label for assistive devices.",
1151
- "attribute": "label"
883
+ "default": "'primary'",
884
+ "description": "The badge's theme variant.",
885
+ "attribute": "variant",
886
+ "reflects": true
1152
887
  },
1153
888
  {
1154
889
  "kind": "field",
1155
- "name": "vertical",
890
+ "name": "pill",
1156
891
  "type": {
1157
892
  "text": "boolean"
1158
893
  },
1159
894
  "default": "false",
1160
- "description": "Use vertical layout for the button group.",
1161
- "attribute": "vertical",
895
+ "description": "Draws a pill-style badge with rounded edges.",
896
+ "attribute": "pill",
1162
897
  "reflects": true
1163
898
  },
1164
899
  {
1165
- "kind": "method",
1166
- "name": "handleFocus",
1167
- "privacy": "private",
1168
- "parameters": [
1169
- {
1170
- "name": "event",
1171
- "type": {
1172
- "text": "Event"
1173
- }
1174
- }
1175
- ]
1176
- },
1177
- {
1178
- "kind": "method",
1179
- "name": "handleBlur",
1180
- "privacy": "private",
1181
- "parameters": [
1182
- {
1183
- "name": "event",
1184
- "type": {
1185
- "text": "Event"
1186
- }
1187
- }
1188
- ]
1189
- },
1190
- {
1191
- "kind": "method",
1192
- "name": "handleMouseOver",
1193
- "privacy": "private",
1194
- "parameters": [
1195
- {
1196
- "name": "event",
1197
- "type": {
1198
- "text": "Event"
1199
- }
1200
- }
1201
- ]
1202
- },
1203
- {
1204
- "kind": "method",
1205
- "name": "handleMouseOut",
1206
- "privacy": "private",
1207
- "parameters": [
1208
- {
1209
- "name": "event",
1210
- "type": {
1211
- "text": "Event"
1212
- }
1213
- }
1214
- ]
1215
- },
1216
- {
1217
- "kind": "method",
1218
- "name": "handleSlotChange",
1219
- "privacy": "private"
900
+ "kind": "field",
901
+ "name": "pulse",
902
+ "type": {
903
+ "text": "boolean"
904
+ },
905
+ "default": "false",
906
+ "description": "Makes the badge pulsate to draw attention.",
907
+ "attribute": "pulse",
908
+ "reflects": true
1220
909
  }
1221
910
  ],
1222
911
  "attributes": [
1223
912
  {
1224
- "name": "label",
913
+ "name": "variant",
1225
914
  "type": {
1226
- "text": "string"
915
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
1227
916
  },
1228
- "default": "''",
1229
- "description": "Text label for assistive devices.",
1230
- "fieldName": "label"
917
+ "default": "'primary'",
918
+ "description": "The badge's theme variant.",
919
+ "fieldName": "variant"
1231
920
  },
1232
921
  {
1233
- "name": "vertical",
922
+ "name": "pill",
1234
923
  "type": {
1235
924
  "text": "boolean"
1236
925
  },
1237
926
  "default": "false",
1238
- "description": "Use vertical layout for the button group.",
1239
- "fieldName": "vertical"
927
+ "description": "Draws a pill-style badge with rounded edges.",
928
+ "fieldName": "pill"
929
+ },
930
+ {
931
+ "name": "pulse",
932
+ "type": {
933
+ "text": "boolean"
934
+ },
935
+ "default": "false",
936
+ "description": "Makes the badge pulsate to draw attention.",
937
+ "fieldName": "pulse"
1240
938
  }
1241
939
  ],
1242
940
  "superclass": {
1243
941
  "name": "FlowRdfElement",
1244
942
  "module": "/src/internal/flow-ui-rdf-element"
1245
943
  },
1246
- "tagName": "flow-ui-button-group",
1247
- "summary": "Button groups can be used to group related buttons into sections.",
944
+ "tagName": "flow-ui-badge",
945
+ "summary": "Badges are used to draw attention and display statuses or counts.",
1248
946
  "customElement": true
1249
947
  }
1250
948
  ],
@@ -1253,389 +951,659 @@
1253
951
  "kind": "js",
1254
952
  "name": "default",
1255
953
  "declaration": {
1256
- "name": "FlowUiButtonGroup",
1257
- "module": "components/button-group/button-group.component.js"
954
+ "name": "FlowUiBadge",
955
+ "module": "components/badge/badge.component.js"
1258
956
  }
1259
957
  }
1260
958
  ]
1261
959
  },
1262
960
  {
1263
961
  "kind": "javascript-module",
1264
- "path": "components/button-group/button-group.js",
962
+ "path": "components/badge/badge.js",
1265
963
  "declarations": [],
1266
964
  "exports": [
1267
965
  {
1268
966
  "kind": "js",
1269
967
  "name": "default",
1270
968
  "declaration": {
1271
- "name": "FlowUiButtonGroup",
1272
- "module": "components/button-group/button-group.js"
969
+ "name": "FlowUiBadge",
970
+ "module": "components/badge/badge.js"
1273
971
  }
1274
972
  }
1275
973
  ]
1276
974
  },
1277
975
  {
1278
976
  "kind": "javascript-module",
1279
- "path": "components/button/button.component.js",
977
+ "path": "components/breadcrumb-item/breadcrumb-item.component.js",
1280
978
  "declarations": [
1281
979
  {
1282
980
  "kind": "class",
1283
981
  "description": "",
1284
- "name": "FlowUiButton",
982
+ "name": "FlowUiBreadcrumbItem",
1285
983
  "cssParts": [
1286
984
  {
1287
985
  "description": "The component's base wrapper.",
1288
986
  "name": "base"
1289
987
  },
1290
988
  {
1291
- "description": "The container that wraps the prefix.",
1292
- "name": "prefix"
989
+ "description": "The breadcrumb item's label.",
990
+ "name": "label"
1293
991
  },
1294
992
  {
1295
- "description": "The button's label.",
1296
- "name": "label"
993
+ "description": "The container that wraps the prefix.",
994
+ "name": "prefix"
1297
995
  },
1298
996
  {
1299
997
  "description": "The container that wraps the suffix.",
1300
998
  "name": "suffix"
1301
999
  },
1302
1000
  {
1303
- "description": "The button's caret icon, an `<flow-ui-icon>` element.",
1304
- "name": "caret"
1001
+ "description": "The container that wraps the separator.",
1002
+ "name": "separator"
1305
1003
  }
1306
1004
  ],
1307
1005
  "slots": [
1308
1006
  {
1309
- "description": "The button's label.",
1007
+ "description": "The breadcrumb item's label.",
1310
1008
  "name": ""
1311
1009
  },
1312
1010
  {
1313
- "description": "A presentational prefix icon or similar element.",
1011
+ "description": "An optional prefix, usually an icon or icon button.",
1314
1012
  "name": "prefix"
1315
1013
  },
1316
1014
  {
1317
- "description": "A presentational suffix icon or similar element.",
1015
+ "description": "An optional suffix, usually an icon or icon button.",
1318
1016
  "name": "suffix"
1017
+ },
1018
+ {
1019
+ "description": "The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.",
1020
+ "name": "separator"
1319
1021
  }
1320
1022
  ],
1321
1023
  "members": [
1322
- {
1323
- "kind": "field",
1324
- "name": "formControlController",
1325
- "privacy": "private",
1326
- "readonly": true,
1327
- "default": "new FormControlController(this, {\n form: (input) => {\n // Buttons support a form attribute that points to an arbitrary form, so if this attribute is set we need to query\n // the form from the same root using its id\n if (input.hasAttribute('form')) {\n const doc = input.getRootNode() as Document | ShadowRoot;\n const formId = input.getAttribute('form')!;\n return doc.getElementById(formId) as HTMLFormElement;\n }\n\n // Fall back to the closest containing form\n return input.closest('form');\n },\n assumeInteractionOn: ['click']\n })"
1328
- },
1329
1024
  {
1330
1025
  "kind": "field",
1331
1026
  "name": "hasSlotController",
1332
1027
  "privacy": "private",
1333
1028
  "readonly": true,
1334
- "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')"
1335
- },
1336
- {
1337
- "kind": "field",
1338
- "name": "localize",
1339
- "privacy": "private",
1340
- "readonly": true,
1341
- "default": "new LocalizeController(this)"
1029
+ "default": "new HasSlotController(this, 'prefix', 'suffix')"
1342
1030
  },
1343
1031
  {
1344
1032
  "kind": "field",
1345
- "name": "hasFocus",
1033
+ "name": "href",
1346
1034
  "type": {
1347
- "text": "boolean"
1035
+ "text": "string | undefined"
1348
1036
  },
1349
- "privacy": "private",
1350
- "default": "false"
1037
+ "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
1038
+ "attribute": "href"
1351
1039
  },
1352
1040
  {
1353
1041
  "kind": "field",
1354
- "name": "title",
1042
+ "name": "target",
1355
1043
  "type": {
1356
- "text": "string"
1044
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
1357
1045
  },
1358
- "default": "''",
1359
- "attribute": "title"
1046
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
1047
+ "attribute": "target"
1360
1048
  },
1361
1049
  {
1362
1050
  "kind": "field",
1363
- "name": "variant",
1051
+ "name": "rel",
1364
1052
  "type": {
1365
- "text": "| 'default'\n | 'primary'\n | 'secondary'\n | 'success'\n | 'neutral'\n | 'warning'\n | 'danger'\n | 'text'"
1053
+ "text": "string"
1366
1054
  },
1367
- "default": "'default'",
1368
- "description": "The button's theme variant.",
1369
- "attribute": "variant",
1370
- "reflects": true
1371
- },
1055
+ "default": "'noreferrer noopener'",
1056
+ "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
1057
+ "attribute": "rel"
1058
+ }
1059
+ ],
1060
+ "attributes": [
1372
1061
  {
1373
- "kind": "field",
1374
- "name": "size",
1062
+ "name": "href",
1375
1063
  "type": {
1376
- "text": "'small' | 'medium' | 'large'"
1064
+ "text": "string | undefined"
1377
1065
  },
1378
- "default": "'medium'",
1379
- "description": "The button's size.",
1380
- "attribute": "size",
1381
- "reflects": true
1066
+ "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
1067
+ "fieldName": "href"
1382
1068
  },
1383
1069
  {
1384
- "kind": "field",
1385
- "name": "caret",
1070
+ "name": "target",
1386
1071
  "type": {
1387
- "text": "boolean"
1072
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
1388
1073
  },
1389
- "default": "false",
1390
- "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
1391
- "attribute": "caret",
1392
- "reflects": true
1074
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
1075
+ "fieldName": "target"
1393
1076
  },
1394
1077
  {
1395
- "kind": "field",
1396
- "name": "disabled",
1078
+ "name": "rel",
1397
1079
  "type": {
1398
- "text": "boolean"
1080
+ "text": "string"
1399
1081
  },
1400
- "default": "false",
1401
- "description": "Disables the button.",
1402
- "attribute": "disabled",
1403
- "reflects": true
1404
- },
1082
+ "default": "'noreferrer noopener'",
1083
+ "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
1084
+ "fieldName": "rel"
1085
+ }
1086
+ ],
1087
+ "superclass": {
1088
+ "name": "FlowRdfElement",
1089
+ "module": "/src/internal/flow-ui-rdf-element"
1090
+ },
1091
+ "tagName": "flow-ui-breadcrumb-item",
1092
+ "summary": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.",
1093
+ "customElement": true
1094
+ }
1095
+ ],
1096
+ "exports": [
1097
+ {
1098
+ "kind": "js",
1099
+ "name": "default",
1100
+ "declaration": {
1101
+ "name": "FlowUiBreadcrumbItem",
1102
+ "module": "components/breadcrumb-item/breadcrumb-item.component.js"
1103
+ }
1104
+ }
1105
+ ]
1106
+ },
1107
+ {
1108
+ "kind": "javascript-module",
1109
+ "path": "components/breadcrumb-item/breadcrumb-item.js",
1110
+ "declarations": [],
1111
+ "exports": [
1112
+ {
1113
+ "kind": "js",
1114
+ "name": "default",
1115
+ "declaration": {
1116
+ "name": "FlowUiBreadcrumbItem",
1117
+ "module": "components/breadcrumb-item/breadcrumb-item.js"
1118
+ }
1119
+ }
1120
+ ]
1121
+ },
1122
+ {
1123
+ "kind": "javascript-module",
1124
+ "path": "components/breadcrumb/breadcrumb.component.js",
1125
+ "declarations": [
1126
+ {
1127
+ "kind": "class",
1128
+ "description": "",
1129
+ "name": "FlowUiBreadcrumb",
1130
+ "cssParts": [
1405
1131
  {
1406
- "kind": "field",
1407
- "name": "loading",
1408
- "type": {
1409
- "text": "boolean"
1410
- },
1411
- "default": "false",
1412
- "description": "Draws the button in a loading state.",
1413
- "attribute": "loading",
1414
- "reflects": true
1415
- },
1132
+ "description": "The component's base wrapper.",
1133
+ "name": "base"
1134
+ }
1135
+ ],
1136
+ "slots": [
1416
1137
  {
1417
- "kind": "field",
1418
- "name": "outline",
1419
- "type": {
1420
- "text": "boolean"
1421
- },
1422
- "default": "false",
1423
- "description": "Draws an outlined button.",
1424
- "attribute": "outline",
1425
- "reflects": true
1138
+ "description": "One or more breadcrumb items to display.",
1139
+ "name": ""
1426
1140
  },
1427
1141
  {
1428
- "kind": "field",
1429
- "name": "pill",
1430
- "type": {
1431
- "text": "boolean"
1432
- },
1433
- "default": "false",
1434
- "description": "Draws a pill-style button with rounded edges.",
1435
- "attribute": "pill",
1436
- "reflects": true
1437
- },
1142
+ "description": "The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.",
1143
+ "name": "separator"
1144
+ }
1145
+ ],
1146
+ "members": [
1438
1147
  {
1439
1148
  "kind": "field",
1440
- "name": "fabCircle",
1441
- "type": {
1442
- "text": "boolean"
1443
- },
1444
- "default": "false",
1445
- "description": "Draws a circular FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
1446
- "attribute": "fab-circle",
1447
- "reflects": true
1149
+ "name": "localize",
1150
+ "privacy": "private",
1151
+ "readonly": true,
1152
+ "default": "new LocalizeController(this)"
1448
1153
  },
1449
1154
  {
1450
1155
  "kind": "field",
1451
- "name": "fabSquare",
1452
- "type": {
1453
- "text": "boolean"
1454
- },
1455
- "default": "false",
1456
- "description": "Draws a square FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
1457
- "attribute": "fab-square",
1458
- "reflects": true
1156
+ "name": "separatorDir",
1157
+ "privacy": "private"
1459
1158
  },
1460
1159
  {
1461
1160
  "kind": "field",
1462
- "name": "type",
1161
+ "name": "defaultSlot",
1463
1162
  "type": {
1464
- "text": "'button' | 'submit' | 'reset'"
1163
+ "text": "HTMLSlotElement"
1465
1164
  },
1466
- "default": "'button'",
1467
- "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
1468
- "attribute": "type"
1165
+ "privacy": "private"
1469
1166
  },
1470
1167
  {
1471
1168
  "kind": "field",
1472
- "name": "name",
1169
+ "name": "separatorSlot",
1473
1170
  "type": {
1474
- "text": "string"
1171
+ "text": "HTMLSlotElement"
1475
1172
  },
1476
- "default": "''",
1477
- "description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
1478
- "attribute": "name"
1173
+ "privacy": "private"
1479
1174
  },
1480
1175
  {
1481
1176
  "kind": "field",
1482
- "name": "value",
1177
+ "name": "label",
1483
1178
  "type": {
1484
1179
  "text": "string"
1485
1180
  },
1486
1181
  "default": "''",
1487
- "description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
1488
- "attribute": "value"
1182
+ "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
1183
+ "attribute": "label"
1489
1184
  },
1490
1185
  {
1491
- "kind": "field",
1492
- "name": "href",
1493
- "type": {
1494
- "text": "string"
1495
- },
1496
- "default": "''",
1497
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1498
- "attribute": "href"
1186
+ "kind": "method",
1187
+ "name": "getSeparator",
1188
+ "privacy": "private"
1499
1189
  },
1500
1190
  {
1501
- "kind": "field",
1502
- "name": "target",
1503
- "type": {
1504
- "text": "'_blank' | '_parent' | '_self' | '_top'"
1505
- },
1506
- "description": "Tells the browser where to open the link. Only used when `href` is present.",
1507
- "attribute": "target"
1508
- },
1191
+ "kind": "method",
1192
+ "name": "handleSlotChange",
1193
+ "privacy": "private"
1194
+ }
1195
+ ],
1196
+ "attributes": [
1509
1197
  {
1510
- "kind": "field",
1511
- "name": "rel",
1198
+ "name": "label",
1512
1199
  "type": {
1513
1200
  "text": "string"
1514
1201
  },
1515
- "default": "'noreferrer noopener'",
1516
- "description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
1517
- "attribute": "rel"
1518
- },
1519
- {
1520
- "kind": "field",
1521
- "name": "download",
1522
- "type": {
1523
- "text": "string | undefined"
1524
- },
1525
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
1526
- "attribute": "download"
1202
+ "default": "''",
1203
+ "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
1204
+ "fieldName": "label"
1205
+ }
1206
+ ],
1207
+ "superclass": {
1208
+ "name": "FlowRdfElement",
1209
+ "module": "/src/internal/flow-ui-rdf-element"
1210
+ },
1211
+ "tagName": "flow-ui-breadcrumb",
1212
+ "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
1213
+ "dependencies": [
1214
+ "flow-ui-icon"
1215
+ ],
1216
+ "customElement": true
1217
+ }
1218
+ ],
1219
+ "exports": [
1220
+ {
1221
+ "kind": "js",
1222
+ "name": "default",
1223
+ "declaration": {
1224
+ "name": "FlowUiBreadcrumb",
1225
+ "module": "components/breadcrumb/breadcrumb.component.js"
1226
+ }
1227
+ }
1228
+ ]
1229
+ },
1230
+ {
1231
+ "kind": "javascript-module",
1232
+ "path": "components/breadcrumb/breadcrumb.js",
1233
+ "declarations": [],
1234
+ "exports": [
1235
+ {
1236
+ "kind": "js",
1237
+ "name": "default",
1238
+ "declaration": {
1239
+ "name": "FlowUiBreadcrumb",
1240
+ "module": "components/breadcrumb/breadcrumb.js"
1241
+ }
1242
+ }
1243
+ ]
1244
+ },
1245
+ {
1246
+ "kind": "javascript-module",
1247
+ "path": "components/button/button.component.js",
1248
+ "declarations": [
1249
+ {
1250
+ "kind": "class",
1251
+ "description": "",
1252
+ "name": "FlowUiButton",
1253
+ "cssParts": [
1254
+ {
1255
+ "description": "The component's base wrapper.",
1256
+ "name": "base"
1257
+ },
1258
+ {
1259
+ "description": "The container that wraps the prefix.",
1260
+ "name": "prefix"
1261
+ },
1262
+ {
1263
+ "description": "The button's label.",
1264
+ "name": "label"
1527
1265
  },
1266
+ {
1267
+ "description": "The container that wraps the suffix.",
1268
+ "name": "suffix"
1269
+ },
1270
+ {
1271
+ "description": "The button's caret icon, an `<flow-ui-icon>` element.",
1272
+ "name": "caret"
1273
+ }
1274
+ ],
1275
+ "slots": [
1276
+ {
1277
+ "description": "The button's label.",
1278
+ "name": ""
1279
+ },
1280
+ {
1281
+ "description": "A presentational prefix icon or similar element.",
1282
+ "name": "prefix"
1283
+ },
1284
+ {
1285
+ "description": "A presentational suffix icon or similar element.",
1286
+ "name": "suffix"
1287
+ }
1288
+ ],
1289
+ "members": [
1528
1290
  {
1529
1291
  "kind": "field",
1530
- "name": "form",
1292
+ "name": "formControlController",
1293
+ "privacy": "private",
1294
+ "readonly": true,
1295
+ "default": "new FormControlController(this, {\n form: (input) => {\n // Buttons support a form attribute that points to an arbitrary form, so if this attribute is set we need to query\n // the form from the same root using its id\n if (input.hasAttribute('form')) {\n const doc = input.getRootNode() as Document | ShadowRoot;\n const formId = input.getAttribute('form')!;\n return doc.getElementById(formId) as HTMLFormElement;\n }\n\n // Fall back to the closest containing form\n return input.closest('form');\n },\n assumeInteractionOn: ['click']\n })"
1296
+ },
1297
+ {
1298
+ "kind": "field",
1299
+ "name": "hasSlotController",
1300
+ "privacy": "private",
1301
+ "readonly": true,
1302
+ "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')"
1303
+ },
1304
+ {
1305
+ "kind": "field",
1306
+ "name": "localize",
1307
+ "privacy": "private",
1308
+ "readonly": true,
1309
+ "default": "new LocalizeController(this)"
1310
+ },
1311
+ {
1312
+ "kind": "field",
1313
+ "name": "hasFocus",
1531
1314
  "type": {
1532
- "text": "string"
1315
+ "text": "boolean"
1533
1316
  },
1534
- "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1535
- "attribute": "form"
1317
+ "privacy": "private",
1318
+ "default": "false"
1536
1319
  },
1537
1320
  {
1538
1321
  "kind": "field",
1539
- "name": "formAction",
1322
+ "name": "title",
1540
1323
  "type": {
1541
1324
  "text": "string"
1542
1325
  },
1543
- "description": "Used to override the form owner's `action` attribute.",
1544
- "attribute": "formaction"
1326
+ "default": "''",
1327
+ "attribute": "title"
1545
1328
  },
1546
1329
  {
1547
1330
  "kind": "field",
1548
- "name": "formEnctype",
1331
+ "name": "variant",
1549
1332
  "type": {
1550
- "text": "'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'"
1333
+ "text": "| 'default'\n | 'primary'\n | 'secondary'\n | 'success'\n | 'neutral'\n | 'warning'\n | 'danger'\n | 'text'"
1551
1334
  },
1552
- "description": "Used to override the form owner's `enctype` attribute.",
1553
- "attribute": "formenctype"
1335
+ "default": "'default'",
1336
+ "description": "The button's theme variant.",
1337
+ "attribute": "variant",
1338
+ "reflects": true
1554
1339
  },
1555
1340
  {
1556
1341
  "kind": "field",
1557
- "name": "formMethod",
1342
+ "name": "size",
1558
1343
  "type": {
1559
- "text": "'post' | 'get'"
1344
+ "text": "'small' | 'medium' | 'large'"
1560
1345
  },
1561
- "description": "Used to override the form owner's `method` attribute.",
1562
- "attribute": "formmethod"
1346
+ "default": "'medium'",
1347
+ "description": "The button's size.",
1348
+ "attribute": "size",
1349
+ "reflects": true
1563
1350
  },
1564
1351
  {
1565
1352
  "kind": "field",
1566
- "name": "formNoValidate",
1353
+ "name": "caret",
1567
1354
  "type": {
1568
1355
  "text": "boolean"
1569
1356
  },
1570
- "description": "Used to override the form owner's `novalidate` attribute.",
1571
- "attribute": "formnovalidate"
1357
+ "default": "false",
1358
+ "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
1359
+ "attribute": "caret",
1360
+ "reflects": true
1572
1361
  },
1573
1362
  {
1574
1363
  "kind": "field",
1575
- "name": "formTarget",
1364
+ "name": "disabled",
1576
1365
  "type": {
1577
- "text": "'_self' | '_blank' | '_parent' | '_top' | string"
1366
+ "text": "boolean"
1578
1367
  },
1579
- "description": "Used to override the form owner's `target` attribute.",
1580
- "attribute": "formtarget"
1368
+ "default": "false",
1369
+ "description": "Disables the button.",
1370
+ "attribute": "disabled",
1371
+ "reflects": true
1581
1372
  },
1582
1373
  {
1583
1374
  "kind": "field",
1584
- "name": "validity",
1585
- "description": "Gets the validity state object",
1586
- "readonly": true
1375
+ "name": "loading",
1376
+ "type": {
1377
+ "text": "boolean"
1378
+ },
1379
+ "default": "false",
1380
+ "description": "Draws the button in a loading state.",
1381
+ "attribute": "loading",
1382
+ "reflects": true
1587
1383
  },
1588
1384
  {
1589
1385
  "kind": "field",
1590
- "name": "validationMessage",
1591
- "description": "Gets the validation message",
1592
- "readonly": true
1593
- },
1594
- {
1595
- "kind": "method",
1596
- "name": "handleBlur",
1597
- "privacy": "private"
1598
- },
1599
- {
1600
- "kind": "method",
1601
- "name": "handleFocus",
1602
- "privacy": "private"
1386
+ "name": "outline",
1387
+ "type": {
1388
+ "text": "boolean"
1389
+ },
1390
+ "default": "false",
1391
+ "description": "Draws an outlined button.",
1392
+ "attribute": "outline",
1393
+ "reflects": true
1603
1394
  },
1604
1395
  {
1605
- "kind": "method",
1606
- "name": "handleClick",
1607
- "privacy": "private"
1396
+ "kind": "field",
1397
+ "name": "pill",
1398
+ "type": {
1399
+ "text": "boolean"
1400
+ },
1401
+ "default": "false",
1402
+ "description": "Draws a pill-style button with rounded edges.",
1403
+ "attribute": "pill",
1404
+ "reflects": true
1608
1405
  },
1609
1406
  {
1610
- "kind": "method",
1611
- "name": "handleHostClick",
1612
- "privacy": "private",
1613
- "parameters": [
1614
- {
1615
- "name": "event",
1616
- "type": {
1617
- "text": "MouseEvent"
1618
- }
1619
- }
1620
- ]
1407
+ "kind": "field",
1408
+ "name": "fabCircle",
1409
+ "type": {
1410
+ "text": "boolean"
1411
+ },
1412
+ "default": "false",
1413
+ "description": "Draws a circular FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
1414
+ "attribute": "fab-circle",
1415
+ "reflects": true
1621
1416
  },
1622
1417
  {
1623
- "kind": "method",
1624
- "name": "handleInvalid",
1625
- "privacy": "private",
1626
- "parameters": [
1627
- {
1628
- "name": "event",
1629
- "type": {
1630
- "text": "Event"
1631
- }
1632
- }
1633
- ]
1418
+ "kind": "field",
1419
+ "name": "fabSquare",
1420
+ "type": {
1421
+ "text": "boolean"
1422
+ },
1423
+ "default": "false",
1424
+ "description": "Draws a square FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
1425
+ "attribute": "fab-square",
1426
+ "reflects": true
1634
1427
  },
1635
1428
  {
1636
- "kind": "method",
1637
- "name": "isButton",
1638
- "privacy": "private"
1429
+ "kind": "field",
1430
+ "name": "type",
1431
+ "type": {
1432
+ "text": "'button' | 'submit' | 'reset'"
1433
+ },
1434
+ "default": "'button'",
1435
+ "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
1436
+ "attribute": "type"
1437
+ },
1438
+ {
1439
+ "kind": "field",
1440
+ "name": "name",
1441
+ "type": {
1442
+ "text": "string"
1443
+ },
1444
+ "default": "''",
1445
+ "description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
1446
+ "attribute": "name"
1447
+ },
1448
+ {
1449
+ "kind": "field",
1450
+ "name": "value",
1451
+ "type": {
1452
+ "text": "string"
1453
+ },
1454
+ "default": "''",
1455
+ "description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
1456
+ "attribute": "value"
1457
+ },
1458
+ {
1459
+ "kind": "field",
1460
+ "name": "href",
1461
+ "type": {
1462
+ "text": "string"
1463
+ },
1464
+ "default": "''",
1465
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1466
+ "attribute": "href"
1467
+ },
1468
+ {
1469
+ "kind": "field",
1470
+ "name": "target",
1471
+ "type": {
1472
+ "text": "'_blank' | '_parent' | '_self' | '_top'"
1473
+ },
1474
+ "description": "Tells the browser where to open the link. Only used when `href` is present.",
1475
+ "attribute": "target"
1476
+ },
1477
+ {
1478
+ "kind": "field",
1479
+ "name": "rel",
1480
+ "type": {
1481
+ "text": "string"
1482
+ },
1483
+ "default": "'noreferrer noopener'",
1484
+ "description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
1485
+ "attribute": "rel"
1486
+ },
1487
+ {
1488
+ "kind": "field",
1489
+ "name": "download",
1490
+ "type": {
1491
+ "text": "string | undefined"
1492
+ },
1493
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
1494
+ "attribute": "download"
1495
+ },
1496
+ {
1497
+ "kind": "field",
1498
+ "name": "form",
1499
+ "type": {
1500
+ "text": "string"
1501
+ },
1502
+ "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1503
+ "attribute": "form"
1504
+ },
1505
+ {
1506
+ "kind": "field",
1507
+ "name": "formAction",
1508
+ "type": {
1509
+ "text": "string"
1510
+ },
1511
+ "description": "Used to override the form owner's `action` attribute.",
1512
+ "attribute": "formaction"
1513
+ },
1514
+ {
1515
+ "kind": "field",
1516
+ "name": "formEnctype",
1517
+ "type": {
1518
+ "text": "'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'"
1519
+ },
1520
+ "description": "Used to override the form owner's `enctype` attribute.",
1521
+ "attribute": "formenctype"
1522
+ },
1523
+ {
1524
+ "kind": "field",
1525
+ "name": "formMethod",
1526
+ "type": {
1527
+ "text": "'post' | 'get'"
1528
+ },
1529
+ "description": "Used to override the form owner's `method` attribute.",
1530
+ "attribute": "formmethod"
1531
+ },
1532
+ {
1533
+ "kind": "field",
1534
+ "name": "formNoValidate",
1535
+ "type": {
1536
+ "text": "boolean"
1537
+ },
1538
+ "description": "Used to override the form owner's `novalidate` attribute.",
1539
+ "attribute": "formnovalidate"
1540
+ },
1541
+ {
1542
+ "kind": "field",
1543
+ "name": "formTarget",
1544
+ "type": {
1545
+ "text": "'_self' | '_blank' | '_parent' | '_top' | string"
1546
+ },
1547
+ "description": "Used to override the form owner's `target` attribute.",
1548
+ "attribute": "formtarget"
1549
+ },
1550
+ {
1551
+ "kind": "field",
1552
+ "name": "validity",
1553
+ "description": "Gets the validity state object",
1554
+ "readonly": true
1555
+ },
1556
+ {
1557
+ "kind": "field",
1558
+ "name": "validationMessage",
1559
+ "description": "Gets the validation message",
1560
+ "readonly": true
1561
+ },
1562
+ {
1563
+ "kind": "method",
1564
+ "name": "handleBlur",
1565
+ "privacy": "private"
1566
+ },
1567
+ {
1568
+ "kind": "method",
1569
+ "name": "handleFocus",
1570
+ "privacy": "private"
1571
+ },
1572
+ {
1573
+ "kind": "method",
1574
+ "name": "handleClick",
1575
+ "privacy": "private"
1576
+ },
1577
+ {
1578
+ "kind": "method",
1579
+ "name": "handleHostClick",
1580
+ "privacy": "private",
1581
+ "parameters": [
1582
+ {
1583
+ "name": "event",
1584
+ "type": {
1585
+ "text": "MouseEvent"
1586
+ }
1587
+ }
1588
+ ]
1589
+ },
1590
+ {
1591
+ "kind": "method",
1592
+ "name": "handleInvalid",
1593
+ "privacy": "private",
1594
+ "parameters": [
1595
+ {
1596
+ "name": "event",
1597
+ "type": {
1598
+ "text": "Event"
1599
+ }
1600
+ }
1601
+ ]
1602
+ },
1603
+ {
1604
+ "kind": "method",
1605
+ "name": "isButton",
1606
+ "privacy": "private"
1639
1607
  },
1640
1608
  {
1641
1609
  "kind": "method",
@@ -1958,12 +1926,12 @@
1958
1926
  },
1959
1927
  {
1960
1928
  "kind": "javascript-module",
1961
- "path": "components/breadcrumb/breadcrumb.component.js",
1929
+ "path": "components/button-group/button-group.component.js",
1962
1930
  "declarations": [
1963
1931
  {
1964
1932
  "kind": "class",
1965
1933
  "description": "",
1966
- "name": "FlowUiBreadcrumb",
1934
+ "name": "FlowUiButtonGroup",
1967
1935
  "cssParts": [
1968
1936
  {
1969
1937
  "description": "The component's base wrapper.",
@@ -1972,84 +1940,116 @@
1972
1940
  ],
1973
1941
  "slots": [
1974
1942
  {
1975
- "description": "One or more breadcrumb items to display.",
1943
+ "description": "One or more `<flow-ui-button>` elements to display in the button group.",
1976
1944
  "name": ""
1977
- },
1978
- {
1979
- "description": "The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.",
1980
- "name": "separator"
1981
1945
  }
1982
1946
  ],
1983
1947
  "members": [
1984
1948
  {
1985
1949
  "kind": "field",
1986
- "name": "localize",
1987
- "privacy": "private",
1988
- "readonly": true,
1989
- "default": "new LocalizeController(this)"
1990
- },
1991
- {
1992
- "kind": "field",
1993
- "name": "separatorDir",
1994
- "privacy": "private"
1995
- },
1996
- {
1997
- "kind": "field",
1998
- "name": "defaultSlot",
1950
+ "name": "label",
1999
1951
  "type": {
2000
- "text": "HTMLSlotElement"
1952
+ "text": "string"
2001
1953
  },
2002
- "privacy": "private"
1954
+ "default": "''",
1955
+ "description": "Text label for assistive devices.",
1956
+ "attribute": "label"
2003
1957
  },
2004
1958
  {
2005
1959
  "kind": "field",
2006
- "name": "separatorSlot",
1960
+ "name": "vertical",
2007
1961
  "type": {
2008
- "text": "HTMLSlotElement"
1962
+ "text": "boolean"
2009
1963
  },
2010
- "privacy": "private"
1964
+ "default": "false",
1965
+ "description": "Use vertical layout for the button group.",
1966
+ "attribute": "vertical",
1967
+ "reflects": true
2011
1968
  },
2012
1969
  {
2013
- "kind": "field",
2014
- "name": "label",
2015
- "type": {
2016
- "text": "string"
2017
- },
2018
- "default": "''",
2019
- "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
2020
- "attribute": "label"
1970
+ "kind": "method",
1971
+ "name": "handleFocus",
1972
+ "privacy": "private",
1973
+ "parameters": [
1974
+ {
1975
+ "name": "event",
1976
+ "type": {
1977
+ "text": "Event"
1978
+ }
1979
+ }
1980
+ ]
2021
1981
  },
2022
1982
  {
2023
1983
  "kind": "method",
2024
- "name": "getSeparator",
2025
- "privacy": "private"
1984
+ "name": "handleBlur",
1985
+ "privacy": "private",
1986
+ "parameters": [
1987
+ {
1988
+ "name": "event",
1989
+ "type": {
1990
+ "text": "Event"
1991
+ }
1992
+ }
1993
+ ]
2026
1994
  },
2027
1995
  {
2028
1996
  "kind": "method",
2029
- "name": "handleSlotChange",
2030
- "privacy": "private"
2031
- }
2032
- ],
2033
- "attributes": [
1997
+ "name": "handleMouseOver",
1998
+ "privacy": "private",
1999
+ "parameters": [
2000
+ {
2001
+ "name": "event",
2002
+ "type": {
2003
+ "text": "Event"
2004
+ }
2005
+ }
2006
+ ]
2007
+ },
2008
+ {
2009
+ "kind": "method",
2010
+ "name": "handleMouseOut",
2011
+ "privacy": "private",
2012
+ "parameters": [
2013
+ {
2014
+ "name": "event",
2015
+ "type": {
2016
+ "text": "Event"
2017
+ }
2018
+ }
2019
+ ]
2020
+ },
2021
+ {
2022
+ "kind": "method",
2023
+ "name": "handleSlotChange",
2024
+ "privacy": "private"
2025
+ }
2026
+ ],
2027
+ "attributes": [
2034
2028
  {
2035
2029
  "name": "label",
2036
2030
  "type": {
2037
2031
  "text": "string"
2038
2032
  },
2039
2033
  "default": "''",
2040
- "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
2034
+ "description": "Text label for assistive devices.",
2041
2035
  "fieldName": "label"
2036
+ },
2037
+ {
2038
+ "name": "vertical",
2039
+ "type": {
2040
+ "text": "boolean"
2041
+ },
2042
+ "default": "false",
2043
+ "description": "Use vertical layout for the button group.",
2044
+ "fieldName": "vertical"
2042
2045
  }
2043
2046
  ],
2044
2047
  "superclass": {
2045
2048
  "name": "FlowRdfElement",
2046
2049
  "module": "/src/internal/flow-ui-rdf-element"
2047
2050
  },
2048
- "tagName": "flow-ui-breadcrumb",
2049
- "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
2050
- "dependencies": [
2051
- "flow-ui-icon"
2052
- ],
2051
+ "tagName": "flow-ui-button-group",
2052
+ "summary": "Button groups can be used to group related buttons into sections.",
2053
2053
  "customElement": true
2054
2054
  }
2055
2055
  ],
@@ -2058,23 +2058,23 @@
2058
2058
  "kind": "js",
2059
2059
  "name": "default",
2060
2060
  "declaration": {
2061
- "name": "FlowUiBreadcrumb",
2062
- "module": "components/breadcrumb/breadcrumb.component.js"
2061
+ "name": "FlowUiButtonGroup",
2062
+ "module": "components/button-group/button-group.component.js"
2063
2063
  }
2064
2064
  }
2065
2065
  ]
2066
2066
  },
2067
2067
  {
2068
2068
  "kind": "javascript-module",
2069
- "path": "components/breadcrumb/breadcrumb.js",
2069
+ "path": "components/button-group/button-group.js",
2070
2070
  "declarations": [],
2071
2071
  "exports": [
2072
2072
  {
2073
2073
  "kind": "js",
2074
2074
  "name": "default",
2075
2075
  "declaration": {
2076
- "name": "FlowUiBreadcrumb",
2077
- "module": "components/breadcrumb/breadcrumb.js"
2076
+ "name": "FlowUiButtonGroup",
2077
+ "module": "components/button-group/button-group.js"
2078
2078
  }
2079
2079
  }
2080
2080
  ]
@@ -8698,114 +8698,40 @@
8698
8698
  },
8699
8699
  {
8700
8700
  "kind": "javascript-module",
8701
- "path": "components/input/input.component.js",
8701
+ "path": "components/icon-button/icon-button.component.js",
8702
8702
  "declarations": [
8703
8703
  {
8704
8704
  "kind": "class",
8705
8705
  "description": "",
8706
- "name": "FlowUiInput",
8706
+ "name": "FlowUiIconButton",
8707
8707
  "cssParts": [
8708
- {
8709
- "description": "The form control that wraps the label, input, and help text.",
8710
- "name": "form-control"
8711
- },
8712
- {
8713
- "description": "The label's wrapper.",
8714
- "name": "form-control-label"
8715
- },
8716
- {
8717
- "description": "The input's wrapper.",
8718
- "name": "form-control-input"
8719
- },
8720
- {
8721
- "description": "The help text's wrapper.",
8722
- "name": "form-control-help-text"
8723
- },
8724
8708
  {
8725
8709
  "description": "The component's base wrapper.",
8726
8710
  "name": "base"
8727
- },
8728
- {
8729
- "description": "The internal `<input>` control.",
8730
- "name": "input"
8731
- },
8732
- {
8733
- "description": "The container that wraps the prefix.",
8734
- "name": "prefix"
8735
- },
8736
- {
8737
- "description": "The clear button.",
8738
- "name": "clear-button"
8739
- },
8740
- {
8741
- "description": "The password toggle button.",
8742
- "name": "password-toggle-button"
8743
- },
8744
- {
8745
- "description": "The container that wraps the suffix.",
8746
- "name": "suffix"
8747
8711
  }
8748
8712
  ],
8749
8713
  "slots": [
8750
8714
  {
8751
- "description": "The input's label. Alternatively, you can use the `label` attribute.",
8752
- "name": "label"
8753
- },
8754
- {
8755
- "description": "Used to prepend a presentational icon or similar element to the input.",
8756
- "name": "prefix"
8757
- },
8758
- {
8759
- "description": "Used to append a presentational icon or similar element to the input.",
8760
- "name": "suffix"
8761
- },
8762
- {
8763
- "description": "An icon to use in lieu of the default clear icon.",
8764
- "name": "clear-icon"
8765
- },
8766
- {
8767
- "description": "An icon to use in lieu of the default show password icon.",
8768
- "name": "show-password-icon"
8769
- },
8770
- {
8771
- "description": "An icon to use in lieu of the default hide password icon.",
8772
- "name": "hide-password-icon"
8773
- },
8774
- {
8775
- "description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.",
8776
- "name": "help-text"
8715
+ "description": "The tooltip content to display when the user hovers over the icon button. Alternatively, you can use the `tooltip` attribute.",
8716
+ "name": "tooltip"
8777
8717
  }
8778
8718
  ],
8779
8719
  "members": [
8780
- {
8781
- "kind": "field",
8782
- "name": "formControlController",
8783
- "privacy": "private",
8784
- "readonly": true,
8785
- "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })"
8786
- },
8787
8720
  {
8788
8721
  "kind": "field",
8789
8722
  "name": "hasSlotController",
8790
8723
  "privacy": "private",
8791
8724
  "readonly": true,
8792
- "default": "new HasSlotController(this, 'help-text', 'label')"
8793
- },
8794
- {
8795
- "kind": "field",
8796
- "name": "localize",
8797
- "privacy": "private",
8798
- "readonly": true,
8799
- "default": "new LocalizeController(this)"
8725
+ "default": "new HasSlotController(this, 'tooltip')"
8800
8726
  },
8801
8727
  {
8802
8728
  "kind": "field",
8803
- "name": "_numberFormatter",
8729
+ "name": "tooltipAnimating",
8804
8730
  "type": {
8805
- "text": "(val: string | number | undefined) => string"
8731
+ "text": "boolean"
8806
8732
  },
8807
8733
  "privacy": "private",
8808
- "default": "DEFAULT_FORMATTER"
8734
+ "default": "false"
8809
8735
  },
8810
8736
  {
8811
8737
  "kind": "field",
@@ -8816,78 +8742,59 @@
8816
8742
  "privacy": "private",
8817
8743
  "default": "false"
8818
8744
  },
8819
- {
8820
- "kind": "field",
8821
- "name": "type",
8822
- "type": {
8823
- "text": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'"
8824
- },
8825
- "default": "'text'",
8826
- "description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
8827
- "attribute": "type",
8828
- "reflects": true
8829
- },
8830
8745
  {
8831
8746
  "kind": "field",
8832
8747
  "name": "name",
8833
8748
  "type": {
8834
- "text": "string"
8749
+ "text": "string | undefined"
8835
8750
  },
8836
- "default": "''",
8837
- "description": "The name of the input, submitted as a name/value pair with form data.",
8751
+ "description": "The name of the icon to draw. Available names depend on the icon library being used.",
8838
8752
  "attribute": "name"
8839
8753
  },
8840
8754
  {
8841
8755
  "kind": "field",
8842
- "name": "value",
8756
+ "name": "library",
8843
8757
  "type": {
8844
- "text": "string"
8758
+ "text": "string | undefined"
8845
8759
  },
8846
- "default": "''",
8847
- "description": "The current value of the input, submitted as a name/value pair with form data.",
8848
- "attribute": "value"
8760
+ "description": "The name of a registered custom icon library.",
8761
+ "attribute": "library"
8849
8762
  },
8850
8763
  {
8851
8764
  "kind": "field",
8852
- "name": "defaultValue",
8765
+ "name": "src",
8853
8766
  "type": {
8854
- "text": "string"
8767
+ "text": "string | undefined"
8855
8768
  },
8856
- "default": "''",
8857
- "description": "The default value of the form control. Primarily used for resetting the form control."
8769
+ "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
8770
+ "attribute": "src"
8858
8771
  },
8859
8772
  {
8860
8773
  "kind": "field",
8861
- "name": "size",
8774
+ "name": "href",
8862
8775
  "type": {
8863
- "text": "'small' | 'medium' | 'large'"
8776
+ "text": "string | undefined"
8864
8777
  },
8865
- "default": "'medium'",
8866
- "description": "The input's size.",
8867
- "attribute": "size",
8868
- "reflects": true
8778
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
8779
+ "attribute": "href"
8869
8780
  },
8870
8781
  {
8871
8782
  "kind": "field",
8872
- "name": "filled",
8783
+ "name": "target",
8873
8784
  "type": {
8874
- "text": "boolean"
8785
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
8875
8786
  },
8876
- "default": "false",
8877
- "description": "Draws a filled input.",
8878
- "attribute": "filled",
8879
- "reflects": true
8787
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
8788
+ "attribute": "target"
8880
8789
  },
8881
8790
  {
8882
8791
  "kind": "field",
8883
- "name": "pill",
8792
+ "name": "download",
8884
8793
  "type": {
8885
- "text": "boolean"
8794
+ "text": "string | undefined"
8886
8795
  },
8887
- "default": "false",
8888
- "description": "Draws a pill-style input with rounded edges.",
8889
- "attribute": "pill",
8890
- "reflects": true
8796
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
8797
+ "attribute": "download"
8891
8798
  },
8892
8799
  {
8893
8800
  "kind": "field",
@@ -8896,1260 +8803,1353 @@
8896
8803
  "text": "string"
8897
8804
  },
8898
8805
  "default": "''",
8899
- "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
8806
+ "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
8900
8807
  "attribute": "label"
8901
8808
  },
8902
8809
  {
8903
8810
  "kind": "field",
8904
- "name": "helpText",
8811
+ "name": "tooltip",
8905
8812
  "type": {
8906
8813
  "text": "string"
8907
8814
  },
8908
8815
  "default": "''",
8909
- "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
8910
- "attribute": "help-text"
8911
- },
8912
- {
8913
- "kind": "field",
8914
- "name": "clearable",
8915
- "type": {
8916
- "text": "boolean"
8917
- },
8918
- "default": "false",
8919
- "description": "Adds a clear button when the input is not empty.",
8920
- "attribute": "clearable"
8816
+ "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
8817
+ "attribute": "tooltip"
8921
8818
  },
8922
8819
  {
8923
8820
  "kind": "field",
8924
- "name": "disabled",
8821
+ "name": "tooltipPlacement",
8925
8822
  "type": {
8926
- "text": "boolean"
8823
+ "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
8927
8824
  },
8928
- "default": "false",
8929
- "description": "Disables the input.",
8930
- "attribute": "disabled",
8931
- "reflects": true
8825
+ "default": "'top'",
8826
+ "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
8827
+ "attribute": "tooltip-placement"
8932
8828
  },
8933
8829
  {
8934
8830
  "kind": "field",
8935
- "name": "placeholder",
8831
+ "name": "tooltipDistance",
8936
8832
  "type": {
8937
- "text": "string"
8833
+ "text": "number"
8938
8834
  },
8939
- "default": "''",
8940
- "description": "Placeholder text to show as a hint when the input is empty.",
8941
- "attribute": "placeholder"
8835
+ "default": "8",
8836
+ "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
8837
+ "attribute": "tooltip-distance"
8942
8838
  },
8943
8839
  {
8944
8840
  "kind": "field",
8945
- "name": "format",
8841
+ "name": "tooltipSkidding",
8946
8842
  "type": {
8947
- "text": "string"
8843
+ "text": "number"
8948
8844
  },
8949
- "default": "''",
8950
- "description": "Number format to use for input controls with `type=\"number\"`. (D3 format string)",
8951
- "attribute": "format"
8845
+ "default": "0",
8846
+ "description": "The distance in pixels from which to offset the tooltip along the icon button.",
8847
+ "attribute": "tooltip-skidding"
8952
8848
  },
8953
8849
  {
8954
8850
  "kind": "field",
8955
- "name": "readonly",
8851
+ "name": "disabled",
8956
8852
  "type": {
8957
8853
  "text": "boolean"
8958
8854
  },
8959
8855
  "default": "false",
8960
- "description": "Makes the input readonly.",
8961
- "attribute": "readonly",
8856
+ "description": "Disables the button.",
8857
+ "attribute": "disabled",
8962
8858
  "reflects": true
8963
8859
  },
8964
8860
  {
8965
8861
  "kind": "field",
8966
- "name": "passwordToggle",
8862
+ "name": "confirm",
8967
8863
  "type": {
8968
- "text": "boolean"
8864
+ "text": "string"
8969
8865
  },
8970
- "default": "false",
8971
- "description": "Adds a button to toggle the password's visibility. Only applies to password types.",
8972
- "attribute": "password-toggle"
8866
+ "default": "''",
8867
+ "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
8868
+ "attribute": "confirm"
8973
8869
  },
8974
8870
  {
8975
- "kind": "field",
8976
- "name": "passwordVisible",
8977
- "type": {
8978
- "text": "boolean"
8979
- },
8980
- "default": "false",
8981
- "description": "Determines whether or not the password is currently visible. Only applies to password input types.",
8982
- "attribute": "password-visible"
8871
+ "kind": "method",
8872
+ "name": "handleBlur",
8873
+ "privacy": "private"
8983
8874
  },
8984
8875
  {
8985
- "kind": "field",
8986
- "name": "noSpinButtons",
8987
- "type": {
8988
- "text": "boolean"
8989
- },
8990
- "default": "false",
8991
- "description": "Hides the browser's built-in increment/decrement spin buttons for number inputs.",
8992
- "attribute": "no-spin-buttons"
8876
+ "kind": "method",
8877
+ "name": "handleFocus",
8878
+ "privacy": "private"
8993
8879
  },
8994
8880
  {
8995
- "kind": "field",
8996
- "name": "form",
8997
- "type": {
8998
- "text": "string"
8999
- },
9000
- "default": "''",
9001
- "description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
9002
- "attribute": "form",
9003
- "reflects": true
8881
+ "kind": "method",
8882
+ "name": "handleClick",
8883
+ "privacy": "protected",
8884
+ "parameters": [
8885
+ {
8886
+ "name": "event",
8887
+ "type": {
8888
+ "text": "MouseEvent"
8889
+ }
8890
+ }
8891
+ ]
9004
8892
  },
9005
8893
  {
9006
- "kind": "field",
9007
- "name": "required",
9008
- "type": {
9009
- "text": "boolean"
9010
- },
9011
- "default": "false",
9012
- "description": "Makes the input a required field.",
9013
- "attribute": "required",
9014
- "reflects": true
8894
+ "kind": "method",
8895
+ "name": "click",
8896
+ "description": "Simulates a click on the icon button."
9015
8897
  },
9016
8898
  {
9017
- "kind": "field",
9018
- "name": "pattern",
9019
- "type": {
9020
- "text": "string"
9021
- },
9022
- "description": "A regular expression pattern to validate input against.",
9023
- "attribute": "pattern"
8899
+ "kind": "method",
8900
+ "name": "focus",
8901
+ "parameters": [
8902
+ {
8903
+ "name": "options",
8904
+ "optional": true,
8905
+ "type": {
8906
+ "text": "FocusOptions"
8907
+ }
8908
+ }
8909
+ ],
8910
+ "description": "Sets focus on the icon button."
9024
8911
  },
9025
8912
  {
9026
- "kind": "field",
9027
- "name": "minlength",
8913
+ "kind": "method",
8914
+ "name": "blur",
8915
+ "description": "Removes focus from the icon button."
8916
+ },
8917
+ {
8918
+ "kind": "method",
8919
+ "name": "hideConfirm",
8920
+ "description": "Hide the confirmation tooltip if it is showing"
8921
+ },
8922
+ {
8923
+ "kind": "method",
8924
+ "name": "showConfirm",
8925
+ "description": "Show the confirmation tooltip"
8926
+ },
8927
+ {
8928
+ "kind": "method",
8929
+ "name": "handleConfirmClick",
8930
+ "privacy": "private"
8931
+ },
8932
+ {
8933
+ "kind": "method",
8934
+ "name": "renderWithTooltip",
8935
+ "privacy": "private",
8936
+ "parameters": [
8937
+ {
8938
+ "name": "contents",
8939
+ "type": {
8940
+ "text": "TemplateResult"
8941
+ }
8942
+ }
8943
+ ]
8944
+ },
8945
+ {
8946
+ "kind": "method",
8947
+ "name": "renderWithConfirmation",
8948
+ "privacy": "private",
8949
+ "parameters": [
8950
+ {
8951
+ "name": "contents",
8952
+ "type": {
8953
+ "text": "TemplateResult"
8954
+ }
8955
+ }
8956
+ ]
8957
+ }
8958
+ ],
8959
+ "events": [
8960
+ {
8961
+ "description": "Emitted when the icon button loses focus.",
8962
+ "name": "flow-ui-blur",
8963
+ "reactName": "onFlowUiBlur"
8964
+ },
8965
+ {
8966
+ "description": "Emitted when the icon button gains focus.",
8967
+ "name": "flow-ui-focus",
8968
+ "reactName": "onFlowUiFocus"
8969
+ }
8970
+ ],
8971
+ "attributes": [
8972
+ {
8973
+ "name": "name",
9028
8974
  "type": {
9029
- "text": "number"
8975
+ "text": "string | undefined"
9030
8976
  },
9031
- "description": "The minimum length of input that will be considered valid.",
9032
- "attribute": "minlength"
8977
+ "description": "The name of the icon to draw. Available names depend on the icon library being used.",
8978
+ "fieldName": "name"
9033
8979
  },
9034
8980
  {
9035
- "kind": "field",
9036
- "name": "maxlength",
8981
+ "name": "library",
9037
8982
  "type": {
9038
- "text": "number"
8983
+ "text": "string | undefined"
9039
8984
  },
9040
- "description": "The maximum length of input that will be considered valid.",
9041
- "attribute": "maxlength"
8985
+ "description": "The name of a registered custom icon library.",
8986
+ "fieldName": "library"
9042
8987
  },
9043
8988
  {
9044
- "kind": "field",
9045
- "name": "min",
8989
+ "name": "src",
9046
8990
  "type": {
9047
- "text": "number | string"
8991
+ "text": "string | undefined"
9048
8992
  },
9049
- "description": "The input's minimum value. Only applies to date and number input types.",
9050
- "attribute": "min"
8993
+ "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
8994
+ "fieldName": "src"
9051
8995
  },
9052
8996
  {
9053
- "kind": "field",
9054
- "name": "max",
8997
+ "name": "href",
9055
8998
  "type": {
9056
- "text": "number | string"
8999
+ "text": "string | undefined"
9057
9000
  },
9058
- "description": "The input's maximum value. Only applies to date and number input types.",
9059
- "attribute": "max"
9001
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
9002
+ "fieldName": "href"
9060
9003
  },
9061
9004
  {
9062
- "kind": "field",
9063
- "name": "step",
9005
+ "name": "target",
9064
9006
  "type": {
9065
- "text": "number | 'any'"
9007
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
9066
9008
  },
9067
- "description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
9068
- "attribute": "step"
9009
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
9010
+ "fieldName": "target"
9069
9011
  },
9070
9012
  {
9071
- "kind": "field",
9072
- "name": "autocapitalize",
9013
+ "name": "download",
9073
9014
  "type": {
9074
- "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
9015
+ "text": "string | undefined"
9075
9016
  },
9076
- "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
9077
- "attribute": "autocapitalize"
9017
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
9018
+ "fieldName": "download"
9078
9019
  },
9079
9020
  {
9080
- "kind": "field",
9081
- "name": "autocorrect",
9021
+ "name": "label",
9082
9022
  "type": {
9083
- "text": "'off' | 'on'"
9023
+ "text": "string"
9084
9024
  },
9085
- "description": "Indicates whether the browser's autocorrect feature is on or off.",
9086
- "attribute": "autocorrect"
9025
+ "default": "''",
9026
+ "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
9027
+ "fieldName": "label"
9087
9028
  },
9088
9029
  {
9089
- "kind": "field",
9090
- "name": "autocomplete",
9030
+ "name": "tooltip",
9091
9031
  "type": {
9092
9032
  "text": "string"
9093
9033
  },
9094
- "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
9095
- "attribute": "autocomplete"
9034
+ "default": "''",
9035
+ "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
9036
+ "fieldName": "tooltip"
9096
9037
  },
9097
9038
  {
9098
- "kind": "field",
9099
- "name": "autofocus",
9039
+ "name": "tooltip-placement",
9100
9040
  "type": {
9101
- "text": "boolean"
9041
+ "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
9102
9042
  },
9103
- "description": "Indicates that the input should receive focus on page load.",
9104
- "attribute": "autofocus"
9043
+ "default": "'top'",
9044
+ "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
9045
+ "fieldName": "tooltipPlacement"
9105
9046
  },
9106
9047
  {
9107
- "kind": "field",
9108
- "name": "enterkeyhint",
9048
+ "name": "tooltip-distance",
9109
9049
  "type": {
9110
- "text": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
9050
+ "text": "number"
9111
9051
  },
9112
- "description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
9113
- "attribute": "enterkeyhint"
9052
+ "default": "8",
9053
+ "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
9054
+ "fieldName": "tooltipDistance"
9114
9055
  },
9115
9056
  {
9116
- "kind": "field",
9117
- "name": "spellcheck",
9057
+ "name": "tooltip-skidding",
9118
9058
  "type": {
9119
- "text": "boolean"
9059
+ "text": "number"
9120
9060
  },
9121
- "default": "true",
9122
- "description": "Enables spell checking on the input.",
9123
- "attribute": "spellcheck"
9061
+ "default": "0",
9062
+ "description": "The distance in pixels from which to offset the tooltip along the icon button.",
9063
+ "fieldName": "tooltipSkidding"
9124
9064
  },
9125
9065
  {
9126
- "kind": "field",
9127
- "name": "inputmode",
9066
+ "name": "disabled",
9128
9067
  "type": {
9129
- "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
9068
+ "text": "boolean"
9130
9069
  },
9131
- "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
9132
- "attribute": "inputmode"
9070
+ "default": "false",
9071
+ "description": "Disables the button.",
9072
+ "fieldName": "disabled"
9133
9073
  },
9134
9074
  {
9135
- "kind": "field",
9136
- "name": "valueAsDate",
9137
- "description": "Gets or sets the current value as a `Date` object. Returns `null` if the value can't be converted."
9075
+ "name": "confirm",
9076
+ "type": {
9077
+ "text": "string"
9078
+ },
9079
+ "default": "''",
9080
+ "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
9081
+ "fieldName": "confirm"
9082
+ }
9083
+ ],
9084
+ "superclass": {
9085
+ "name": "FlowRdfElement",
9086
+ "module": "/src/internal/flow-ui-rdf-element"
9087
+ },
9088
+ "tagName": "flow-ui-icon-button",
9089
+ "summary": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.",
9090
+ "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/icon-button",
9091
+ "status": "stable",
9092
+ "since": "2.0",
9093
+ "dependencies": [
9094
+ "flow-ui-icon",
9095
+ "flow-ui-tooltip"
9096
+ ],
9097
+ "customElement": true
9098
+ }
9099
+ ],
9100
+ "exports": [
9101
+ {
9102
+ "kind": "js",
9103
+ "name": "default",
9104
+ "declaration": {
9105
+ "name": "FlowUiIconButton",
9106
+ "module": "components/icon-button/icon-button.component.js"
9107
+ }
9108
+ }
9109
+ ]
9110
+ },
9111
+ {
9112
+ "kind": "javascript-module",
9113
+ "path": "components/icon-button/icon-button.js",
9114
+ "declarations": [],
9115
+ "exports": [
9116
+ {
9117
+ "kind": "js",
9118
+ "name": "*",
9119
+ "declaration": {
9120
+ "name": "*",
9121
+ "package": "./icon-button.component"
9122
+ }
9123
+ },
9124
+ {
9125
+ "kind": "js",
9126
+ "name": "default",
9127
+ "declaration": {
9128
+ "name": "FlowUiIconButton",
9129
+ "module": "components/icon-button/icon-button.js"
9130
+ }
9131
+ }
9132
+ ]
9133
+ },
9134
+ {
9135
+ "kind": "javascript-module",
9136
+ "path": "components/input/input.component.js",
9137
+ "declarations": [
9138
+ {
9139
+ "kind": "class",
9140
+ "description": "",
9141
+ "name": "FlowUiInput",
9142
+ "cssParts": [
9143
+ {
9144
+ "description": "The form control that wraps the label, input, and help text.",
9145
+ "name": "form-control"
9138
9146
  },
9139
9147
  {
9140
- "kind": "field",
9141
- "name": "valueAsNumber",
9142
- "description": "Gets or sets the current value as a number. Returns `NaN` if the value can't be converted."
9148
+ "description": "The label's wrapper.",
9149
+ "name": "form-control-label"
9143
9150
  },
9144
9151
  {
9145
- "kind": "field",
9146
- "name": "validity",
9147
- "description": "Gets the validity state object",
9148
- "readonly": true
9152
+ "description": "The input's wrapper.",
9153
+ "name": "form-control-input"
9149
9154
  },
9150
9155
  {
9151
- "kind": "field",
9152
- "name": "validationMessage",
9153
- "description": "Gets the validation message",
9154
- "readonly": true
9156
+ "description": "The help text's wrapper.",
9157
+ "name": "form-control-help-text"
9155
9158
  },
9156
9159
  {
9157
- "kind": "method",
9158
- "name": "handleBlur",
9159
- "privacy": "private"
9160
+ "description": "The component's base wrapper.",
9161
+ "name": "base"
9160
9162
  },
9161
9163
  {
9162
- "kind": "method",
9163
- "name": "handleChange",
9164
- "privacy": "private"
9164
+ "description": "The internal `<input>` control.",
9165
+ "name": "input"
9165
9166
  },
9166
9167
  {
9167
- "kind": "method",
9168
- "name": "handleClearClick",
9168
+ "description": "The container that wraps the prefix.",
9169
+ "name": "prefix"
9170
+ },
9171
+ {
9172
+ "description": "The clear button.",
9173
+ "name": "clear-button"
9174
+ },
9175
+ {
9176
+ "description": "The password toggle button.",
9177
+ "name": "password-toggle-button"
9178
+ },
9179
+ {
9180
+ "description": "The container that wraps the suffix.",
9181
+ "name": "suffix"
9182
+ }
9183
+ ],
9184
+ "slots": [
9185
+ {
9186
+ "description": "The input's label. Alternatively, you can use the `label` attribute.",
9187
+ "name": "label"
9188
+ },
9189
+ {
9190
+ "description": "Used to prepend a presentational icon or similar element to the input.",
9191
+ "name": "prefix"
9192
+ },
9193
+ {
9194
+ "description": "Used to append a presentational icon or similar element to the input.",
9195
+ "name": "suffix"
9196
+ },
9197
+ {
9198
+ "description": "An icon to use in lieu of the default clear icon.",
9199
+ "name": "clear-icon"
9200
+ },
9201
+ {
9202
+ "description": "An icon to use in lieu of the default show password icon.",
9203
+ "name": "show-password-icon"
9204
+ },
9205
+ {
9206
+ "description": "An icon to use in lieu of the default hide password icon.",
9207
+ "name": "hide-password-icon"
9208
+ },
9209
+ {
9210
+ "description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.",
9211
+ "name": "help-text"
9212
+ }
9213
+ ],
9214
+ "members": [
9215
+ {
9216
+ "kind": "field",
9217
+ "name": "formControlController",
9169
9218
  "privacy": "private",
9170
- "parameters": [
9171
- {
9172
- "name": "event",
9173
- "type": {
9174
- "text": "MouseEvent"
9175
- }
9176
- }
9177
- ]
9219
+ "readonly": true,
9220
+ "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })"
9178
9221
  },
9179
9222
  {
9180
- "kind": "method",
9181
- "name": "handleFocus",
9182
- "privacy": "private"
9223
+ "kind": "field",
9224
+ "name": "hasSlotController",
9225
+ "privacy": "private",
9226
+ "readonly": true,
9227
+ "default": "new HasSlotController(this, 'help-text', 'label')"
9183
9228
  },
9184
9229
  {
9185
- "kind": "method",
9186
- "name": "handleInput",
9230
+ "kind": "field",
9231
+ "name": "localize",
9187
9232
  "privacy": "private",
9188
- "parameters": [
9189
- {
9190
- "name": "ev",
9191
- "type": {
9192
- "text": "InputEvent"
9193
- }
9194
- }
9195
- ]
9233
+ "readonly": true,
9234
+ "default": "new LocalizeController(this)"
9196
9235
  },
9197
9236
  {
9198
- "kind": "method",
9199
- "name": "handleInvalid",
9237
+ "kind": "field",
9238
+ "name": "_numberFormatter",
9239
+ "type": {
9240
+ "text": "(val: string | number | undefined) => string"
9241
+ },
9200
9242
  "privacy": "private",
9201
- "parameters": [
9202
- {
9203
- "name": "event",
9204
- "type": {
9205
- "text": "Event"
9206
- }
9207
- }
9208
- ]
9243
+ "default": "DEFAULT_FORMATTER"
9209
9244
  },
9210
9245
  {
9211
- "kind": "method",
9212
- "name": "handleKeyDown",
9246
+ "kind": "field",
9247
+ "name": "hasFocus",
9248
+ "type": {
9249
+ "text": "boolean"
9250
+ },
9213
9251
  "privacy": "private",
9214
- "parameters": [
9215
- {
9216
- "name": "event",
9217
- "type": {
9218
- "text": "KeyboardEvent"
9219
- }
9220
- }
9221
- ]
9252
+ "default": "false"
9222
9253
  },
9223
9254
  {
9224
- "kind": "method",
9225
- "name": "handlePasswordToggle",
9226
- "privacy": "private"
9255
+ "kind": "field",
9256
+ "name": "type",
9257
+ "type": {
9258
+ "text": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'"
9259
+ },
9260
+ "default": "'text'",
9261
+ "description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
9262
+ "attribute": "type",
9263
+ "reflects": true
9227
9264
  },
9228
9265
  {
9229
- "kind": "method",
9230
- "name": "focus",
9231
- "parameters": [
9232
- {
9233
- "name": "options",
9234
- "optional": true,
9235
- "type": {
9236
- "text": "FocusOptions"
9237
- }
9238
- }
9239
- ],
9240
- "description": "Sets focus on the input."
9266
+ "kind": "field",
9267
+ "name": "name",
9268
+ "type": {
9269
+ "text": "string"
9270
+ },
9271
+ "default": "''",
9272
+ "description": "The name of the input, submitted as a name/value pair with form data.",
9273
+ "attribute": "name"
9241
9274
  },
9242
9275
  {
9243
- "kind": "method",
9244
- "name": "blur",
9245
- "description": "Removes focus from the input."
9276
+ "kind": "field",
9277
+ "name": "value",
9278
+ "type": {
9279
+ "text": "string"
9280
+ },
9281
+ "default": "''",
9282
+ "description": "The current value of the input, submitted as a name/value pair with form data.",
9283
+ "attribute": "value"
9246
9284
  },
9247
9285
  {
9248
- "kind": "method",
9249
- "name": "select",
9250
- "description": "Selects all the text in the input."
9286
+ "kind": "field",
9287
+ "name": "defaultValue",
9288
+ "type": {
9289
+ "text": "string"
9290
+ },
9291
+ "default": "''",
9292
+ "description": "The default value of the form control. Primarily used for resetting the form control."
9251
9293
  },
9252
9294
  {
9253
- "kind": "method",
9254
- "name": "setSelectionRange",
9255
- "parameters": [
9256
- {
9257
- "name": "selectionStart",
9258
- "type": {
9259
- "text": "number"
9260
- }
9261
- },
9262
- {
9263
- "name": "selectionEnd",
9264
- "type": {
9265
- "text": "number"
9266
- }
9267
- },
9268
- {
9269
- "name": "selectionDirection",
9270
- "default": "'none'",
9271
- "type": {
9272
- "text": "'forward' | 'backward' | 'none'"
9273
- }
9274
- }
9275
- ],
9276
- "description": "Sets the start and end positions of the text selection (0-based)."
9295
+ "kind": "field",
9296
+ "name": "size",
9297
+ "type": {
9298
+ "text": "'small' | 'medium' | 'large'"
9299
+ },
9300
+ "default": "'medium'",
9301
+ "description": "The input's size.",
9302
+ "attribute": "size",
9303
+ "reflects": true
9277
9304
  },
9278
9305
  {
9279
- "kind": "method",
9280
- "name": "setRangeText",
9281
- "parameters": [
9282
- {
9283
- "name": "replacement",
9284
- "type": {
9285
- "text": "string"
9286
- }
9287
- },
9288
- {
9289
- "name": "start",
9290
- "optional": true,
9291
- "type": {
9292
- "text": "number"
9293
- }
9294
- },
9295
- {
9296
- "name": "end",
9297
- "optional": true,
9298
- "type": {
9299
- "text": "number"
9300
- }
9301
- },
9302
- {
9303
- "name": "selectMode",
9304
- "optional": true,
9305
- "type": {
9306
- "text": "'select' | 'start' | 'end' | 'preserve'"
9307
- }
9308
- }
9309
- ],
9310
- "description": "Replaces a range of text with a new string."
9306
+ "kind": "field",
9307
+ "name": "filled",
9308
+ "type": {
9309
+ "text": "boolean"
9310
+ },
9311
+ "default": "false",
9312
+ "description": "Draws a filled input.",
9313
+ "attribute": "filled",
9314
+ "reflects": true
9311
9315
  },
9312
9316
  {
9313
- "kind": "method",
9314
- "name": "showPicker",
9315
- "description": "Displays the browser picker for an input element (only works if the browser supports it for the input type)."
9317
+ "kind": "field",
9318
+ "name": "pill",
9319
+ "type": {
9320
+ "text": "boolean"
9321
+ },
9322
+ "default": "false",
9323
+ "description": "Draws a pill-style input with rounded edges.",
9324
+ "attribute": "pill",
9325
+ "reflects": true
9316
9326
  },
9317
9327
  {
9318
- "kind": "method",
9319
- "name": "stepUp",
9320
- "description": "Increments the value of a numeric input type by the value of the step attribute."
9328
+ "kind": "field",
9329
+ "name": "label",
9330
+ "type": {
9331
+ "text": "string"
9332
+ },
9333
+ "default": "''",
9334
+ "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
9335
+ "attribute": "label"
9321
9336
  },
9322
9337
  {
9323
- "kind": "method",
9324
- "name": "stepDown",
9325
- "description": "Decrements the value of a numeric input type by the value of the step attribute."
9338
+ "kind": "field",
9339
+ "name": "helpText",
9340
+ "type": {
9341
+ "text": "string"
9342
+ },
9343
+ "default": "''",
9344
+ "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
9345
+ "attribute": "help-text"
9326
9346
  },
9327
9347
  {
9328
- "kind": "method",
9329
- "name": "checkValidity",
9330
- "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid."
9348
+ "kind": "field",
9349
+ "name": "clearable",
9350
+ "type": {
9351
+ "text": "boolean"
9352
+ },
9353
+ "default": "false",
9354
+ "description": "Adds a clear button when the input is not empty.",
9355
+ "attribute": "clearable"
9331
9356
  },
9332
9357
  {
9333
- "kind": "method",
9334
- "name": "getForm",
9335
- "return": {
9336
- "type": {
9337
- "text": "HTMLFormElement | null"
9338
- }
9358
+ "kind": "field",
9359
+ "name": "disabled",
9360
+ "type": {
9361
+ "text": "boolean"
9339
9362
  },
9340
- "description": "Gets the associated form, if one exists."
9363
+ "default": "false",
9364
+ "description": "Disables the input.",
9365
+ "attribute": "disabled",
9366
+ "reflects": true
9341
9367
  },
9342
9368
  {
9343
- "kind": "method",
9344
- "name": "reportValidity",
9345
- "description": "Checks for validity and shows the browser's validation message if the control is invalid."
9369
+ "kind": "field",
9370
+ "name": "placeholder",
9371
+ "type": {
9372
+ "text": "string"
9373
+ },
9374
+ "default": "''",
9375
+ "description": "Placeholder text to show as a hint when the input is empty.",
9376
+ "attribute": "placeholder"
9346
9377
  },
9347
9378
  {
9348
- "kind": "method",
9349
- "name": "setCustomValidity",
9350
- "parameters": [
9351
- {
9352
- "name": "message",
9353
- "type": {
9354
- "text": "string"
9355
- }
9356
- }
9357
- ],
9358
- "description": "Sets a custom validation message. Pass an empty string to restore validity."
9379
+ "kind": "field",
9380
+ "name": "format",
9381
+ "type": {
9382
+ "text": "string"
9383
+ },
9384
+ "default": "''",
9385
+ "description": "Number format to use for input controls with `type=\"number\"`. (D3 format string)",
9386
+ "attribute": "format"
9387
+ },
9388
+ {
9389
+ "kind": "field",
9390
+ "name": "readonly",
9391
+ "type": {
9392
+ "text": "boolean"
9393
+ },
9394
+ "default": "false",
9395
+ "description": "Makes the input readonly.",
9396
+ "attribute": "readonly",
9397
+ "reflects": true
9398
+ },
9399
+ {
9400
+ "kind": "field",
9401
+ "name": "passwordToggle",
9402
+ "type": {
9403
+ "text": "boolean"
9404
+ },
9405
+ "default": "false",
9406
+ "description": "Adds a button to toggle the password's visibility. Only applies to password types.",
9407
+ "attribute": "password-toggle"
9408
+ },
9409
+ {
9410
+ "kind": "field",
9411
+ "name": "passwordVisible",
9412
+ "type": {
9413
+ "text": "boolean"
9414
+ },
9415
+ "default": "false",
9416
+ "description": "Determines whether or not the password is currently visible. Only applies to password input types.",
9417
+ "attribute": "password-visible"
9418
+ },
9419
+ {
9420
+ "kind": "field",
9421
+ "name": "noSpinButtons",
9422
+ "type": {
9423
+ "text": "boolean"
9424
+ },
9425
+ "default": "false",
9426
+ "description": "Hides the browser's built-in increment/decrement spin buttons for number inputs.",
9427
+ "attribute": "no-spin-buttons"
9359
9428
  },
9360
9429
  {
9361
- "kind": "method",
9362
- "name": "fromDisplayValue",
9363
- "privacy": "private",
9364
- "parameters": [
9365
- {
9366
- "name": "displayValue",
9367
- "type": {
9368
- "text": "string"
9369
- }
9370
- }
9371
- ]
9430
+ "kind": "field",
9431
+ "name": "form",
9432
+ "type": {
9433
+ "text": "string"
9434
+ },
9435
+ "default": "''",
9436
+ "description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
9437
+ "attribute": "form",
9438
+ "reflects": true
9372
9439
  },
9373
9440
  {
9374
- "kind": "method",
9375
- "name": "toDisplayValue",
9376
- "privacy": "private",
9377
- "parameters": [
9378
- {
9379
- "name": "value",
9380
- "type": {
9381
- "text": "string"
9382
- }
9383
- }
9384
- ]
9441
+ "kind": "field",
9442
+ "name": "required",
9443
+ "type": {
9444
+ "text": "boolean"
9445
+ },
9446
+ "default": "false",
9447
+ "description": "Makes the input a required field.",
9448
+ "attribute": "required",
9449
+ "reflects": true
9385
9450
  },
9386
9451
  {
9387
- "kind": "method",
9388
- "name": "clampValue",
9389
- "privacy": "private",
9390
- "return": {
9391
- "type": {
9392
- "text": "string"
9393
- }
9452
+ "kind": "field",
9453
+ "name": "pattern",
9454
+ "type": {
9455
+ "text": "string"
9394
9456
  },
9395
- "parameters": [
9396
- {
9397
- "name": "value",
9398
- "type": {
9399
- "text": "string"
9400
- }
9401
- }
9402
- ]
9403
- }
9404
- ],
9405
- "events": [
9406
- {
9407
- "description": "Emitted when the control loses focus.",
9408
- "name": "flow-ui-blur",
9409
- "reactName": "onFlowUiBlur"
9457
+ "description": "A regular expression pattern to validate input against.",
9458
+ "attribute": "pattern"
9410
9459
  },
9411
9460
  {
9412
- "description": "Emitted when an alteration to the control's value is committed by the user.",
9413
- "name": "flow-ui-change",
9414
- "reactName": "onFlowUiChange"
9461
+ "kind": "field",
9462
+ "name": "minlength",
9463
+ "type": {
9464
+ "text": "number"
9465
+ },
9466
+ "description": "The minimum length of input that will be considered valid.",
9467
+ "attribute": "minlength"
9415
9468
  },
9416
9469
  {
9417
- "description": "Emitted when the clear button is activated.",
9418
- "name": "flow-ui-clear",
9419
- "reactName": "onFlowUiClear"
9470
+ "kind": "field",
9471
+ "name": "maxlength",
9472
+ "type": {
9473
+ "text": "number"
9474
+ },
9475
+ "description": "The maximum length of input that will be considered valid.",
9476
+ "attribute": "maxlength"
9420
9477
  },
9421
9478
  {
9422
- "description": "Emitted when the control gains focus.",
9423
- "name": "flow-ui-focus",
9424
- "reactName": "onFlowUiFocus"
9479
+ "kind": "field",
9480
+ "name": "min",
9481
+ "type": {
9482
+ "text": "number | string"
9483
+ },
9484
+ "description": "The input's minimum value. Only applies to date and number input types.",
9485
+ "attribute": "min"
9425
9486
  },
9426
9487
  {
9427
- "description": "Emitted when the control receives input.",
9428
- "name": "flow-ui-input",
9429
- "reactName": "onFlowUiInput"
9488
+ "kind": "field",
9489
+ "name": "max",
9490
+ "type": {
9491
+ "text": "number | string"
9492
+ },
9493
+ "description": "The input's maximum value. Only applies to date and number input types.",
9494
+ "attribute": "max"
9430
9495
  },
9431
9496
  {
9432
- "description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied.",
9433
- "name": "flow-ui-invalid",
9434
- "reactName": "onFlowUiInvalid"
9435
- }
9436
- ],
9437
- "attributes": [
9497
+ "kind": "field",
9498
+ "name": "step",
9499
+ "type": {
9500
+ "text": "number | 'any'"
9501
+ },
9502
+ "description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
9503
+ "attribute": "step"
9504
+ },
9438
9505
  {
9439
- "name": "type",
9506
+ "kind": "field",
9507
+ "name": "autocapitalize",
9440
9508
  "type": {
9441
- "text": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'"
9509
+ "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
9442
9510
  },
9443
- "default": "'text'",
9444
- "description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
9445
- "fieldName": "type"
9511
+ "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
9512
+ "attribute": "autocapitalize"
9446
9513
  },
9447
9514
  {
9448
- "name": "name",
9515
+ "kind": "field",
9516
+ "name": "autocorrect",
9449
9517
  "type": {
9450
- "text": "string"
9518
+ "text": "'off' | 'on'"
9451
9519
  },
9452
- "default": "''",
9453
- "description": "The name of the input, submitted as a name/value pair with form data.",
9454
- "fieldName": "name"
9520
+ "description": "Indicates whether the browser's autocorrect feature is on or off.",
9521
+ "attribute": "autocorrect"
9455
9522
  },
9456
9523
  {
9457
- "name": "value",
9524
+ "kind": "field",
9525
+ "name": "autocomplete",
9458
9526
  "type": {
9459
9527
  "text": "string"
9460
9528
  },
9461
- "default": "''",
9462
- "description": "The current value of the input, submitted as a name/value pair with form data.",
9463
- "fieldName": "value"
9529
+ "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
9530
+ "attribute": "autocomplete"
9464
9531
  },
9465
9532
  {
9466
- "name": "size",
9533
+ "kind": "field",
9534
+ "name": "autofocus",
9467
9535
  "type": {
9468
- "text": "'small' | 'medium' | 'large'"
9536
+ "text": "boolean"
9469
9537
  },
9470
- "default": "'medium'",
9471
- "description": "The input's size.",
9472
- "fieldName": "size"
9538
+ "description": "Indicates that the input should receive focus on page load.",
9539
+ "attribute": "autofocus"
9473
9540
  },
9474
9541
  {
9475
- "name": "filled",
9542
+ "kind": "field",
9543
+ "name": "enterkeyhint",
9476
9544
  "type": {
9477
- "text": "boolean"
9545
+ "text": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
9478
9546
  },
9479
- "default": "false",
9480
- "description": "Draws a filled input.",
9481
- "fieldName": "filled"
9547
+ "description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
9548
+ "attribute": "enterkeyhint"
9482
9549
  },
9483
9550
  {
9484
- "name": "pill",
9551
+ "kind": "field",
9552
+ "name": "spellcheck",
9485
9553
  "type": {
9486
9554
  "text": "boolean"
9487
9555
  },
9488
- "default": "false",
9489
- "description": "Draws a pill-style input with rounded edges.",
9490
- "fieldName": "pill"
9556
+ "default": "true",
9557
+ "description": "Enables spell checking on the input.",
9558
+ "attribute": "spellcheck"
9491
9559
  },
9492
9560
  {
9493
- "name": "label",
9561
+ "kind": "field",
9562
+ "name": "inputmode",
9494
9563
  "type": {
9495
- "text": "string"
9564
+ "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
9496
9565
  },
9497
- "default": "''",
9498
- "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
9499
- "fieldName": "label"
9566
+ "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
9567
+ "attribute": "inputmode"
9568
+ },
9569
+ {
9570
+ "kind": "field",
9571
+ "name": "valueAsDate",
9572
+ "description": "Gets or sets the current value as a `Date` object. Returns `null` if the value can't be converted."
9573
+ },
9574
+ {
9575
+ "kind": "field",
9576
+ "name": "valueAsNumber",
9577
+ "description": "Gets or sets the current value as a number. Returns `NaN` if the value can't be converted."
9578
+ },
9579
+ {
9580
+ "kind": "field",
9581
+ "name": "validity",
9582
+ "description": "Gets the validity state object",
9583
+ "readonly": true
9584
+ },
9585
+ {
9586
+ "kind": "field",
9587
+ "name": "validationMessage",
9588
+ "description": "Gets the validation message",
9589
+ "readonly": true
9590
+ },
9591
+ {
9592
+ "kind": "method",
9593
+ "name": "handleBlur",
9594
+ "privacy": "private"
9595
+ },
9596
+ {
9597
+ "kind": "method",
9598
+ "name": "handleChange",
9599
+ "privacy": "private"
9600
+ },
9601
+ {
9602
+ "kind": "method",
9603
+ "name": "handleClearClick",
9604
+ "privacy": "private",
9605
+ "parameters": [
9606
+ {
9607
+ "name": "event",
9608
+ "type": {
9609
+ "text": "MouseEvent"
9610
+ }
9611
+ }
9612
+ ]
9613
+ },
9614
+ {
9615
+ "kind": "method",
9616
+ "name": "handleFocus",
9617
+ "privacy": "private"
9618
+ },
9619
+ {
9620
+ "kind": "method",
9621
+ "name": "handleInput",
9622
+ "privacy": "private",
9623
+ "parameters": [
9624
+ {
9625
+ "name": "ev",
9626
+ "type": {
9627
+ "text": "InputEvent"
9628
+ }
9629
+ }
9630
+ ]
9631
+ },
9632
+ {
9633
+ "kind": "method",
9634
+ "name": "handleInvalid",
9635
+ "privacy": "private",
9636
+ "parameters": [
9637
+ {
9638
+ "name": "event",
9639
+ "type": {
9640
+ "text": "Event"
9641
+ }
9642
+ }
9643
+ ]
9500
9644
  },
9501
9645
  {
9502
- "name": "help-text",
9503
- "type": {
9504
- "text": "string"
9505
- },
9506
- "default": "''",
9507
- "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
9508
- "fieldName": "helpText"
9646
+ "kind": "method",
9647
+ "name": "handleKeyDown",
9648
+ "privacy": "private",
9649
+ "parameters": [
9650
+ {
9651
+ "name": "event",
9652
+ "type": {
9653
+ "text": "KeyboardEvent"
9654
+ }
9655
+ }
9656
+ ]
9509
9657
  },
9510
9658
  {
9511
- "name": "clearable",
9512
- "type": {
9513
- "text": "boolean"
9514
- },
9515
- "default": "false",
9516
- "description": "Adds a clear button when the input is not empty.",
9517
- "fieldName": "clearable"
9659
+ "kind": "method",
9660
+ "name": "handlePasswordToggle",
9661
+ "privacy": "private"
9518
9662
  },
9519
9663
  {
9520
- "name": "disabled",
9521
- "type": {
9522
- "text": "boolean"
9523
- },
9524
- "default": "false",
9525
- "description": "Disables the input.",
9526
- "fieldName": "disabled"
9664
+ "kind": "method",
9665
+ "name": "focus",
9666
+ "parameters": [
9667
+ {
9668
+ "name": "options",
9669
+ "optional": true,
9670
+ "type": {
9671
+ "text": "FocusOptions"
9672
+ }
9673
+ }
9674
+ ],
9675
+ "description": "Sets focus on the input."
9527
9676
  },
9528
9677
  {
9529
- "name": "placeholder",
9530
- "type": {
9531
- "text": "string"
9532
- },
9533
- "default": "''",
9534
- "description": "Placeholder text to show as a hint when the input is empty.",
9535
- "fieldName": "placeholder"
9678
+ "kind": "method",
9679
+ "name": "blur",
9680
+ "description": "Removes focus from the input."
9536
9681
  },
9537
9682
  {
9538
- "name": "format",
9539
- "type": {
9540
- "text": "string"
9541
- },
9542
- "default": "''",
9543
- "description": "Number format to use for input controls with `type=\"number\"`. (D3 format string)",
9544
- "fieldName": "format"
9683
+ "kind": "method",
9684
+ "name": "select",
9685
+ "description": "Selects all the text in the input."
9545
9686
  },
9546
9687
  {
9547
- "name": "readonly",
9548
- "type": {
9549
- "text": "boolean"
9550
- },
9551
- "default": "false",
9552
- "description": "Makes the input readonly.",
9553
- "fieldName": "readonly"
9688
+ "kind": "method",
9689
+ "name": "setSelectionRange",
9690
+ "parameters": [
9691
+ {
9692
+ "name": "selectionStart",
9693
+ "type": {
9694
+ "text": "number"
9695
+ }
9696
+ },
9697
+ {
9698
+ "name": "selectionEnd",
9699
+ "type": {
9700
+ "text": "number"
9701
+ }
9702
+ },
9703
+ {
9704
+ "name": "selectionDirection",
9705
+ "default": "'none'",
9706
+ "type": {
9707
+ "text": "'forward' | 'backward' | 'none'"
9708
+ }
9709
+ }
9710
+ ],
9711
+ "description": "Sets the start and end positions of the text selection (0-based)."
9554
9712
  },
9555
9713
  {
9556
- "name": "password-toggle",
9557
- "type": {
9558
- "text": "boolean"
9559
- },
9560
- "default": "false",
9561
- "description": "Adds a button to toggle the password's visibility. Only applies to password types.",
9562
- "fieldName": "passwordToggle"
9714
+ "kind": "method",
9715
+ "name": "setRangeText",
9716
+ "parameters": [
9717
+ {
9718
+ "name": "replacement",
9719
+ "type": {
9720
+ "text": "string"
9721
+ }
9722
+ },
9723
+ {
9724
+ "name": "start",
9725
+ "optional": true,
9726
+ "type": {
9727
+ "text": "number"
9728
+ }
9729
+ },
9730
+ {
9731
+ "name": "end",
9732
+ "optional": true,
9733
+ "type": {
9734
+ "text": "number"
9735
+ }
9736
+ },
9737
+ {
9738
+ "name": "selectMode",
9739
+ "optional": true,
9740
+ "type": {
9741
+ "text": "'select' | 'start' | 'end' | 'preserve'"
9742
+ }
9743
+ }
9744
+ ],
9745
+ "description": "Replaces a range of text with a new string."
9563
9746
  },
9564
9747
  {
9565
- "name": "password-visible",
9566
- "type": {
9567
- "text": "boolean"
9568
- },
9569
- "default": "false",
9570
- "description": "Determines whether or not the password is currently visible. Only applies to password input types.",
9571
- "fieldName": "passwordVisible"
9748
+ "kind": "method",
9749
+ "name": "showPicker",
9750
+ "description": "Displays the browser picker for an input element (only works if the browser supports it for the input type)."
9572
9751
  },
9573
9752
  {
9574
- "name": "no-spin-buttons",
9575
- "type": {
9576
- "text": "boolean"
9577
- },
9578
- "default": "false",
9579
- "description": "Hides the browser's built-in increment/decrement spin buttons for number inputs.",
9580
- "fieldName": "noSpinButtons"
9753
+ "kind": "method",
9754
+ "name": "stepUp",
9755
+ "description": "Increments the value of a numeric input type by the value of the step attribute."
9581
9756
  },
9582
9757
  {
9583
- "name": "form",
9584
- "type": {
9585
- "text": "string"
9586
- },
9587
- "default": "''",
9588
- "description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
9589
- "fieldName": "form"
9758
+ "kind": "method",
9759
+ "name": "stepDown",
9760
+ "description": "Decrements the value of a numeric input type by the value of the step attribute."
9590
9761
  },
9591
9762
  {
9592
- "name": "required",
9593
- "type": {
9594
- "text": "boolean"
9595
- },
9596
- "default": "false",
9597
- "description": "Makes the input a required field.",
9598
- "fieldName": "required"
9763
+ "kind": "method",
9764
+ "name": "checkValidity",
9765
+ "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid."
9599
9766
  },
9600
9767
  {
9601
- "name": "pattern",
9602
- "type": {
9603
- "text": "string"
9768
+ "kind": "method",
9769
+ "name": "getForm",
9770
+ "return": {
9771
+ "type": {
9772
+ "text": "HTMLFormElement | null"
9773
+ }
9604
9774
  },
9605
- "description": "A regular expression pattern to validate input against.",
9606
- "fieldName": "pattern"
9775
+ "description": "Gets the associated form, if one exists."
9607
9776
  },
9608
9777
  {
9609
- "name": "minlength",
9610
- "type": {
9611
- "text": "number"
9612
- },
9613
- "description": "The minimum length of input that will be considered valid.",
9614
- "fieldName": "minlength"
9778
+ "kind": "method",
9779
+ "name": "reportValidity",
9780
+ "description": "Checks for validity and shows the browser's validation message if the control is invalid."
9615
9781
  },
9616
9782
  {
9617
- "name": "maxlength",
9618
- "type": {
9619
- "text": "number"
9620
- },
9621
- "description": "The maximum length of input that will be considered valid.",
9622
- "fieldName": "maxlength"
9783
+ "kind": "method",
9784
+ "name": "setCustomValidity",
9785
+ "parameters": [
9786
+ {
9787
+ "name": "message",
9788
+ "type": {
9789
+ "text": "string"
9790
+ }
9791
+ }
9792
+ ],
9793
+ "description": "Sets a custom validation message. Pass an empty string to restore validity."
9623
9794
  },
9624
9795
  {
9625
- "name": "min",
9626
- "type": {
9627
- "text": "number | string"
9628
- },
9629
- "description": "The input's minimum value. Only applies to date and number input types.",
9630
- "fieldName": "min"
9796
+ "kind": "method",
9797
+ "name": "fromDisplayValue",
9798
+ "privacy": "private",
9799
+ "parameters": [
9800
+ {
9801
+ "name": "displayValue",
9802
+ "type": {
9803
+ "text": "string"
9804
+ }
9805
+ }
9806
+ ]
9631
9807
  },
9632
9808
  {
9633
- "name": "max",
9634
- "type": {
9635
- "text": "number | string"
9636
- },
9637
- "description": "The input's maximum value. Only applies to date and number input types.",
9638
- "fieldName": "max"
9809
+ "kind": "method",
9810
+ "name": "toDisplayValue",
9811
+ "privacy": "private",
9812
+ "parameters": [
9813
+ {
9814
+ "name": "value",
9815
+ "type": {
9816
+ "text": "string"
9817
+ }
9818
+ }
9819
+ ]
9639
9820
  },
9640
9821
  {
9641
- "name": "step",
9642
- "type": {
9643
- "text": "number | 'any'"
9822
+ "kind": "method",
9823
+ "name": "clampValue",
9824
+ "privacy": "private",
9825
+ "return": {
9826
+ "type": {
9827
+ "text": "string"
9828
+ }
9644
9829
  },
9645
- "description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
9646
- "fieldName": "step"
9647
- },
9830
+ "parameters": [
9831
+ {
9832
+ "name": "value",
9833
+ "type": {
9834
+ "text": "string"
9835
+ }
9836
+ }
9837
+ ]
9838
+ }
9839
+ ],
9840
+ "events": [
9648
9841
  {
9649
- "name": "autocapitalize",
9650
- "type": {
9651
- "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
9652
- },
9653
- "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
9654
- "fieldName": "autocapitalize"
9842
+ "description": "Emitted when the control loses focus.",
9843
+ "name": "flow-ui-blur",
9844
+ "reactName": "onFlowUiBlur"
9655
9845
  },
9656
9846
  {
9657
- "name": "autocorrect",
9658
- "type": {
9659
- "text": "'off' | 'on'"
9660
- },
9661
- "description": "Indicates whether the browser's autocorrect feature is on or off.",
9662
- "fieldName": "autocorrect"
9847
+ "description": "Emitted when an alteration to the control's value is committed by the user.",
9848
+ "name": "flow-ui-change",
9849
+ "reactName": "onFlowUiChange"
9663
9850
  },
9664
9851
  {
9665
- "name": "autocomplete",
9666
- "type": {
9667
- "text": "string"
9668
- },
9669
- "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
9670
- "fieldName": "autocomplete"
9852
+ "description": "Emitted when the clear button is activated.",
9853
+ "name": "flow-ui-clear",
9854
+ "reactName": "onFlowUiClear"
9671
9855
  },
9672
9856
  {
9673
- "name": "autofocus",
9674
- "type": {
9675
- "text": "boolean"
9676
- },
9677
- "description": "Indicates that the input should receive focus on page load.",
9678
- "fieldName": "autofocus"
9857
+ "description": "Emitted when the control gains focus.",
9858
+ "name": "flow-ui-focus",
9859
+ "reactName": "onFlowUiFocus"
9679
9860
  },
9680
9861
  {
9681
- "name": "enterkeyhint",
9682
- "type": {
9683
- "text": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
9684
- },
9685
- "description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
9686
- "fieldName": "enterkeyhint"
9862
+ "description": "Emitted when the control receives input.",
9863
+ "name": "flow-ui-input",
9864
+ "reactName": "onFlowUiInput"
9687
9865
  },
9688
9866
  {
9689
- "name": "spellcheck",
9867
+ "description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied.",
9868
+ "name": "flow-ui-invalid",
9869
+ "reactName": "onFlowUiInvalid"
9870
+ }
9871
+ ],
9872
+ "attributes": [
9873
+ {
9874
+ "name": "type",
9690
9875
  "type": {
9691
- "text": "boolean"
9876
+ "text": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'"
9692
9877
  },
9693
- "default": "true",
9694
- "description": "Enables spell checking on the input.",
9695
- "fieldName": "spellcheck"
9878
+ "default": "'text'",
9879
+ "description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
9880
+ "fieldName": "type"
9696
9881
  },
9697
9882
  {
9698
- "name": "inputmode",
9883
+ "name": "name",
9699
9884
  "type": {
9700
- "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
9885
+ "text": "string"
9701
9886
  },
9702
- "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
9703
- "fieldName": "inputmode"
9704
- }
9705
- ],
9706
- "superclass": {
9707
- "name": "FlowRdfFormControl",
9708
- "module": "/src/internal/flow-ui-rdf-element"
9709
- },
9710
- "tagName": "flow-ui-input",
9711
- "summary": "Inputs collect data from the user.",
9712
- "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input",
9713
- "status": "stable",
9714
- "since": "2.0",
9715
- "dependencies": [
9716
- "flow-ui-icon",
9717
- "flow-ui-icon-button"
9718
- ],
9719
- "customElement": true
9720
- }
9721
- ],
9722
- "exports": [
9723
- {
9724
- "kind": "js",
9725
- "name": "default",
9726
- "declaration": {
9727
- "name": "FlowUiInput",
9728
- "module": "components/input/input.component.js"
9729
- }
9730
- }
9731
- ]
9732
- },
9733
- {
9734
- "kind": "javascript-module",
9735
- "path": "components/input/input.js",
9736
- "declarations": [],
9737
- "exports": [
9738
- {
9739
- "kind": "js",
9740
- "name": "*",
9741
- "declaration": {
9742
- "name": "*",
9743
- "package": "./input.component"
9744
- }
9745
- },
9746
- {
9747
- "kind": "js",
9748
- "name": "default",
9749
- "declaration": {
9750
- "name": "FlowUiInput",
9751
- "module": "components/input/input.js"
9752
- }
9753
- }
9754
- ]
9755
- },
9756
- {
9757
- "kind": "javascript-module",
9758
- "path": "components/icon-button/icon-button.component.js",
9759
- "declarations": [
9760
- {
9761
- "kind": "class",
9762
- "description": "",
9763
- "name": "FlowUiIconButton",
9764
- "cssParts": [
9765
- {
9766
- "description": "The component's base wrapper.",
9767
- "name": "base"
9768
- }
9769
- ],
9770
- "slots": [
9771
- {
9772
- "description": "The tooltip content to display when the user hovers over the icon button. Alternatively, you can use the `tooltip` attribute.",
9773
- "name": "tooltip"
9774
- }
9775
- ],
9776
- "members": [
9777
- {
9778
- "kind": "field",
9779
- "name": "hasSlotController",
9780
- "privacy": "private",
9781
- "readonly": true,
9782
- "default": "new HasSlotController(this, 'tooltip')"
9887
+ "default": "''",
9888
+ "description": "The name of the input, submitted as a name/value pair with form data.",
9889
+ "fieldName": "name"
9783
9890
  },
9784
9891
  {
9785
- "kind": "field",
9786
- "name": "tooltipAnimating",
9892
+ "name": "value",
9787
9893
  "type": {
9788
- "text": "boolean"
9894
+ "text": "string"
9789
9895
  },
9790
- "privacy": "private",
9791
- "default": "false"
9896
+ "default": "''",
9897
+ "description": "The current value of the input, submitted as a name/value pair with form data.",
9898
+ "fieldName": "value"
9792
9899
  },
9793
9900
  {
9794
- "kind": "field",
9795
- "name": "hasFocus",
9901
+ "name": "size",
9796
9902
  "type": {
9797
- "text": "boolean"
9903
+ "text": "'small' | 'medium' | 'large'"
9798
9904
  },
9799
- "privacy": "private",
9800
- "default": "false"
9905
+ "default": "'medium'",
9906
+ "description": "The input's size.",
9907
+ "fieldName": "size"
9801
9908
  },
9802
9909
  {
9803
- "kind": "field",
9804
- "name": "name",
9910
+ "name": "filled",
9805
9911
  "type": {
9806
- "text": "string | undefined"
9912
+ "text": "boolean"
9807
9913
  },
9808
- "description": "The name of the icon to draw. Available names depend on the icon library being used.",
9809
- "attribute": "name"
9914
+ "default": "false",
9915
+ "description": "Draws a filled input.",
9916
+ "fieldName": "filled"
9810
9917
  },
9811
9918
  {
9812
- "kind": "field",
9813
- "name": "library",
9919
+ "name": "pill",
9814
9920
  "type": {
9815
- "text": "string | undefined"
9921
+ "text": "boolean"
9816
9922
  },
9817
- "description": "The name of a registered custom icon library.",
9818
- "attribute": "library"
9923
+ "default": "false",
9924
+ "description": "Draws a pill-style input with rounded edges.",
9925
+ "fieldName": "pill"
9819
9926
  },
9820
9927
  {
9821
- "kind": "field",
9822
- "name": "src",
9928
+ "name": "label",
9823
9929
  "type": {
9824
- "text": "string | undefined"
9930
+ "text": "string"
9825
9931
  },
9826
- "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
9827
- "attribute": "src"
9932
+ "default": "''",
9933
+ "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
9934
+ "fieldName": "label"
9828
9935
  },
9829
9936
  {
9830
- "kind": "field",
9831
- "name": "href",
9937
+ "name": "help-text",
9832
9938
  "type": {
9833
- "text": "string | undefined"
9939
+ "text": "string"
9834
9940
  },
9835
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
9836
- "attribute": "href"
9941
+ "default": "''",
9942
+ "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
9943
+ "fieldName": "helpText"
9837
9944
  },
9838
9945
  {
9839
- "kind": "field",
9840
- "name": "target",
9946
+ "name": "clearable",
9841
9947
  "type": {
9842
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
9948
+ "text": "boolean"
9843
9949
  },
9844
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
9845
- "attribute": "target"
9950
+ "default": "false",
9951
+ "description": "Adds a clear button when the input is not empty.",
9952
+ "fieldName": "clearable"
9846
9953
  },
9847
9954
  {
9848
- "kind": "field",
9849
- "name": "download",
9955
+ "name": "disabled",
9850
9956
  "type": {
9851
- "text": "string | undefined"
9957
+ "text": "boolean"
9852
9958
  },
9853
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
9854
- "attribute": "download"
9959
+ "default": "false",
9960
+ "description": "Disables the input.",
9961
+ "fieldName": "disabled"
9855
9962
  },
9856
9963
  {
9857
- "kind": "field",
9858
- "name": "label",
9964
+ "name": "placeholder",
9859
9965
  "type": {
9860
9966
  "text": "string"
9861
9967
  },
9862
9968
  "default": "''",
9863
- "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
9864
- "attribute": "label"
9969
+ "description": "Placeholder text to show as a hint when the input is empty.",
9970
+ "fieldName": "placeholder"
9865
9971
  },
9866
9972
  {
9867
- "kind": "field",
9868
- "name": "tooltip",
9973
+ "name": "format",
9869
9974
  "type": {
9870
9975
  "text": "string"
9871
9976
  },
9872
9977
  "default": "''",
9873
- "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
9874
- "attribute": "tooltip"
9978
+ "description": "Number format to use for input controls with `type=\"number\"`. (D3 format string)",
9979
+ "fieldName": "format"
9875
9980
  },
9876
9981
  {
9877
- "kind": "field",
9878
- "name": "tooltipPlacement",
9982
+ "name": "readonly",
9879
9983
  "type": {
9880
- "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
9984
+ "text": "boolean"
9881
9985
  },
9882
- "default": "'top'",
9883
- "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
9884
- "attribute": "tooltip-placement"
9986
+ "default": "false",
9987
+ "description": "Makes the input readonly.",
9988
+ "fieldName": "readonly"
9885
9989
  },
9886
9990
  {
9887
- "kind": "field",
9888
- "name": "tooltipDistance",
9991
+ "name": "password-toggle",
9889
9992
  "type": {
9890
- "text": "number"
9993
+ "text": "boolean"
9891
9994
  },
9892
- "default": "8",
9893
- "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
9894
- "attribute": "tooltip-distance"
9995
+ "default": "false",
9996
+ "description": "Adds a button to toggle the password's visibility. Only applies to password types.",
9997
+ "fieldName": "passwordToggle"
9895
9998
  },
9896
9999
  {
9897
- "kind": "field",
9898
- "name": "tooltipSkidding",
10000
+ "name": "password-visible",
9899
10001
  "type": {
9900
- "text": "number"
10002
+ "text": "boolean"
9901
10003
  },
9902
- "default": "0",
9903
- "description": "The distance in pixels from which to offset the tooltip along the icon button.",
9904
- "attribute": "tooltip-skidding"
10004
+ "default": "false",
10005
+ "description": "Determines whether or not the password is currently visible. Only applies to password input types.",
10006
+ "fieldName": "passwordVisible"
9905
10007
  },
9906
10008
  {
9907
- "kind": "field",
9908
- "name": "disabled",
10009
+ "name": "no-spin-buttons",
9909
10010
  "type": {
9910
10011
  "text": "boolean"
9911
10012
  },
9912
10013
  "default": "false",
9913
- "description": "Disables the button.",
9914
- "attribute": "disabled",
9915
- "reflects": true
10014
+ "description": "Hides the browser's built-in increment/decrement spin buttons for number inputs.",
10015
+ "fieldName": "noSpinButtons"
9916
10016
  },
9917
10017
  {
9918
- "kind": "field",
9919
- "name": "confirm",
10018
+ "name": "form",
9920
10019
  "type": {
9921
10020
  "text": "string"
9922
10021
  },
9923
10022
  "default": "''",
9924
- "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
9925
- "attribute": "confirm"
9926
- },
9927
- {
9928
- "kind": "method",
9929
- "name": "handleBlur",
9930
- "privacy": "private"
9931
- },
9932
- {
9933
- "kind": "method",
9934
- "name": "handleFocus",
9935
- "privacy": "private"
9936
- },
9937
- {
9938
- "kind": "method",
9939
- "name": "handleClick",
9940
- "privacy": "protected",
9941
- "parameters": [
9942
- {
9943
- "name": "event",
9944
- "type": {
9945
- "text": "MouseEvent"
9946
- }
9947
- }
9948
- ]
9949
- },
9950
- {
9951
- "kind": "method",
9952
- "name": "click",
9953
- "description": "Simulates a click on the icon button."
9954
- },
9955
- {
9956
- "kind": "method",
9957
- "name": "focus",
9958
- "parameters": [
9959
- {
9960
- "name": "options",
9961
- "optional": true,
9962
- "type": {
9963
- "text": "FocusOptions"
9964
- }
9965
- }
9966
- ],
9967
- "description": "Sets focus on the icon button."
9968
- },
9969
- {
9970
- "kind": "method",
9971
- "name": "blur",
9972
- "description": "Removes focus from the icon button."
9973
- },
9974
- {
9975
- "kind": "method",
9976
- "name": "hideConfirm",
9977
- "description": "Hide the confirmation tooltip if it is showing"
9978
- },
9979
- {
9980
- "kind": "method",
9981
- "name": "showConfirm",
9982
- "description": "Show the confirmation tooltip"
9983
- },
9984
- {
9985
- "kind": "method",
9986
- "name": "handleConfirmClick",
9987
- "privacy": "private"
9988
- },
9989
- {
9990
- "kind": "method",
9991
- "name": "renderWithTooltip",
9992
- "privacy": "private",
9993
- "parameters": [
9994
- {
9995
- "name": "contents",
9996
- "type": {
9997
- "text": "TemplateResult"
9998
- }
9999
- }
10000
- ]
10023
+ "description": "By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you\nto place the form control outside of a form and associate it with the form that has this `id`. The form must be in\nthe same document or shadow root for this to work.",
10024
+ "fieldName": "form"
10001
10025
  },
10002
10026
  {
10003
- "kind": "method",
10004
- "name": "renderWithConfirmation",
10005
- "privacy": "private",
10006
- "parameters": [
10007
- {
10008
- "name": "contents",
10009
- "type": {
10010
- "text": "TemplateResult"
10011
- }
10012
- }
10013
- ]
10014
- }
10015
- ],
10016
- "events": [
10017
- {
10018
- "description": "Emitted when the icon button loses focus.",
10019
- "name": "flow-ui-blur",
10020
- "reactName": "onFlowUiBlur"
10027
+ "name": "required",
10028
+ "type": {
10029
+ "text": "boolean"
10030
+ },
10031
+ "default": "false",
10032
+ "description": "Makes the input a required field.",
10033
+ "fieldName": "required"
10021
10034
  },
10022
10035
  {
10023
- "description": "Emitted when the icon button gains focus.",
10024
- "name": "flow-ui-focus",
10025
- "reactName": "onFlowUiFocus"
10026
- }
10027
- ],
10028
- "attributes": [
10029
- {
10030
- "name": "name",
10036
+ "name": "pattern",
10031
10037
  "type": {
10032
- "text": "string | undefined"
10038
+ "text": "string"
10033
10039
  },
10034
- "description": "The name of the icon to draw. Available names depend on the icon library being used.",
10035
- "fieldName": "name"
10040
+ "description": "A regular expression pattern to validate input against.",
10041
+ "fieldName": "pattern"
10036
10042
  },
10037
10043
  {
10038
- "name": "library",
10044
+ "name": "minlength",
10039
10045
  "type": {
10040
- "text": "string | undefined"
10046
+ "text": "number"
10041
10047
  },
10042
- "description": "The name of a registered custom icon library.",
10043
- "fieldName": "library"
10048
+ "description": "The minimum length of input that will be considered valid.",
10049
+ "fieldName": "minlength"
10044
10050
  },
10045
10051
  {
10046
- "name": "src",
10052
+ "name": "maxlength",
10047
10053
  "type": {
10048
- "text": "string | undefined"
10054
+ "text": "number"
10049
10055
  },
10050
- "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
10051
- "fieldName": "src"
10056
+ "description": "The maximum length of input that will be considered valid.",
10057
+ "fieldName": "maxlength"
10052
10058
  },
10053
10059
  {
10054
- "name": "href",
10060
+ "name": "min",
10055
10061
  "type": {
10056
- "text": "string | undefined"
10062
+ "text": "number | string"
10057
10063
  },
10058
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
10059
- "fieldName": "href"
10064
+ "description": "The input's minimum value. Only applies to date and number input types.",
10065
+ "fieldName": "min"
10060
10066
  },
10061
10067
  {
10062
- "name": "target",
10068
+ "name": "max",
10063
10069
  "type": {
10064
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
10070
+ "text": "number | string"
10065
10071
  },
10066
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
10067
- "fieldName": "target"
10072
+ "description": "The input's maximum value. Only applies to date and number input types.",
10073
+ "fieldName": "max"
10068
10074
  },
10069
10075
  {
10070
- "name": "download",
10076
+ "name": "step",
10071
10077
  "type": {
10072
- "text": "string | undefined"
10078
+ "text": "number | 'any'"
10073
10079
  },
10074
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
10075
- "fieldName": "download"
10080
+ "description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
10081
+ "fieldName": "step"
10076
10082
  },
10077
10083
  {
10078
- "name": "label",
10084
+ "name": "autocapitalize",
10079
10085
  "type": {
10080
- "text": "string"
10086
+ "text": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
10081
10087
  },
10082
- "default": "''",
10083
- "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
10084
- "fieldName": "label"
10088
+ "description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
10089
+ "fieldName": "autocapitalize"
10085
10090
  },
10086
10091
  {
10087
- "name": "tooltip",
10092
+ "name": "autocorrect",
10088
10093
  "type": {
10089
- "text": "string"
10094
+ "text": "'off' | 'on'"
10090
10095
  },
10091
- "default": "''",
10092
- "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
10093
- "fieldName": "tooltip"
10096
+ "description": "Indicates whether the browser's autocorrect feature is on or off.",
10097
+ "fieldName": "autocorrect"
10094
10098
  },
10095
10099
  {
10096
- "name": "tooltip-placement",
10100
+ "name": "autocomplete",
10097
10101
  "type": {
10098
- "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
10102
+ "text": "string"
10099
10103
  },
10100
- "default": "'top'",
10101
- "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
10102
- "fieldName": "tooltipPlacement"
10104
+ "description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
10105
+ "fieldName": "autocomplete"
10103
10106
  },
10104
10107
  {
10105
- "name": "tooltip-distance",
10108
+ "name": "autofocus",
10106
10109
  "type": {
10107
- "text": "number"
10110
+ "text": "boolean"
10108
10111
  },
10109
- "default": "8",
10110
- "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
10111
- "fieldName": "tooltipDistance"
10112
+ "description": "Indicates that the input should receive focus on page load.",
10113
+ "fieldName": "autofocus"
10112
10114
  },
10113
10115
  {
10114
- "name": "tooltip-skidding",
10116
+ "name": "enterkeyhint",
10115
10117
  "type": {
10116
- "text": "number"
10118
+ "text": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
10117
10119
  },
10118
- "default": "0",
10119
- "description": "The distance in pixels from which to offset the tooltip along the icon button.",
10120
- "fieldName": "tooltipSkidding"
10120
+ "description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
10121
+ "fieldName": "enterkeyhint"
10121
10122
  },
10122
10123
  {
10123
- "name": "disabled",
10124
+ "name": "spellcheck",
10124
10125
  "type": {
10125
10126
  "text": "boolean"
10126
10127
  },
10127
- "default": "false",
10128
- "description": "Disables the button.",
10129
- "fieldName": "disabled"
10128
+ "default": "true",
10129
+ "description": "Enables spell checking on the input.",
10130
+ "fieldName": "spellcheck"
10130
10131
  },
10131
10132
  {
10132
- "name": "confirm",
10133
+ "name": "inputmode",
10133
10134
  "type": {
10134
- "text": "string"
10135
+ "text": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
10135
10136
  },
10136
- "default": "''",
10137
- "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
10138
- "fieldName": "confirm"
10137
+ "description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
10138
+ "fieldName": "inputmode"
10139
10139
  }
10140
10140
  ],
10141
10141
  "superclass": {
10142
- "name": "FlowRdfElement",
10142
+ "name": "FlowRdfFormControl",
10143
10143
  "module": "/src/internal/flow-ui-rdf-element"
10144
10144
  },
10145
- "tagName": "flow-ui-icon-button",
10146
- "summary": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.",
10147
- "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/icon-button",
10145
+ "tagName": "flow-ui-input",
10146
+ "summary": "Inputs collect data from the user.",
10147
+ "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input",
10148
10148
  "status": "stable",
10149
10149
  "since": "2.0",
10150
10150
  "dependencies": [
10151
10151
  "flow-ui-icon",
10152
- "flow-ui-tooltip"
10152
+ "flow-ui-icon-button"
10153
10153
  ],
10154
10154
  "customElement": true
10155
10155
  }
@@ -10159,15 +10159,15 @@
10159
10159
  "kind": "js",
10160
10160
  "name": "default",
10161
10161
  "declaration": {
10162
- "name": "FlowUiIconButton",
10163
- "module": "components/icon-button/icon-button.component.js"
10162
+ "name": "FlowUiInput",
10163
+ "module": "components/input/input.component.js"
10164
10164
  }
10165
10165
  }
10166
10166
  ]
10167
10167
  },
10168
10168
  {
10169
10169
  "kind": "javascript-module",
10170
- "path": "components/icon-button/icon-button.js",
10170
+ "path": "components/input/input.js",
10171
10171
  "declarations": [],
10172
10172
  "exports": [
10173
10173
  {
@@ -10175,15 +10175,15 @@
10175
10175
  "name": "*",
10176
10176
  "declaration": {
10177
10177
  "name": "*",
10178
- "package": "./icon-button.component"
10178
+ "package": "./input.component"
10179
10179
  }
10180
10180
  },
10181
10181
  {
10182
10182
  "kind": "js",
10183
10183
  "name": "default",
10184
10184
  "declaration": {
10185
- "name": "FlowUiIconButton",
10186
- "module": "components/icon-button/icon-button.js"
10185
+ "name": "FlowUiInput",
10186
+ "module": "components/input/input.js"
10187
10187
  }
10188
10188
  }
10189
10189
  ]
@@ -22069,111 +22069,6 @@
22069
22069
  }
22070
22070
  ]
22071
22071
  },
22072
- {
22073
- "kind": "javascript-module",
22074
- "path": "components/query-builder/converters/flow-query-converters.js",
22075
- "declarations": [
22076
- {
22077
- "kind": "function",
22078
- "name": "converter",
22079
- "parameters": [
22080
- {
22081
- "name": "ruleset",
22082
- "type": {
22083
- "text": "FlowQueryBuilderRuleSet"
22084
- }
22085
- },
22086
- {
22087
- "name": "config",
22088
- "type": {
22089
- "text": "FlowQueryBuilderConfig"
22090
- }
22091
- },
22092
- {
22093
- "name": "options",
22094
- "optional": true,
22095
- "type": {
22096
- "text": "FlowQueryBuilderConverterOptions"
22097
- }
22098
- }
22099
- ]
22100
- }
22101
- ],
22102
- "exports": [
22103
- {
22104
- "kind": "js",
22105
- "name": "default",
22106
- "declaration": {
22107
- "name": "converter",
22108
- "module": "components/query-builder/converters/flow-query-converters.js"
22109
- }
22110
- }
22111
- ]
22112
- },
22113
- {
22114
- "kind": "javascript-module",
22115
- "path": "components/query-builder/converters/index.js",
22116
- "declarations": [],
22117
- "exports": [
22118
- {
22119
- "kind": "js",
22120
- "name": "flowQueryConverter",
22121
- "declaration": {
22122
- "name": "flowQueryConverter",
22123
- "module": "components/query-builder/converters/index.js"
22124
- }
22125
- },
22126
- {
22127
- "kind": "js",
22128
- "name": "mapLayerFilterConverter",
22129
- "declaration": {
22130
- "name": "mapLayerFilterConverter",
22131
- "module": "components/query-builder/converters/index.js"
22132
- }
22133
- }
22134
- ]
22135
- },
22136
- {
22137
- "kind": "javascript-module",
22138
- "path": "components/query-builder/converters/map-layer-filter-converter.js",
22139
- "declarations": [
22140
- {
22141
- "kind": "function",
22142
- "name": "converter",
22143
- "parameters": [
22144
- {
22145
- "name": "ruleset",
22146
- "type": {
22147
- "text": "FlowQueryBuilderRuleSet"
22148
- }
22149
- },
22150
- {
22151
- "name": "config",
22152
- "type": {
22153
- "text": "FlowQueryBuilderConfig"
22154
- }
22155
- },
22156
- {
22157
- "name": "options",
22158
- "optional": true,
22159
- "type": {
22160
- "text": "FlowQueryBuilderConverterOptions"
22161
- }
22162
- }
22163
- ]
22164
- }
22165
- ],
22166
- "exports": [
22167
- {
22168
- "kind": "js",
22169
- "name": "default",
22170
- "declaration": {
22171
- "name": "converter",
22172
- "module": "components/query-builder/converters/map-layer-filter-converter.js"
22173
- }
22174
- }
22175
- ]
22176
- },
22177
22072
  {
22178
22073
  "kind": "javascript-module",
22179
22074
  "path": "components/chart/chartjs-plugins/interaction.interpolate.js",
@@ -22399,10 +22294,115 @@
22399
22294
  }
22400
22295
  }
22401
22296
  ]
22297
+ },
22298
+ {
22299
+ "kind": "javascript-module",
22300
+ "path": "components/query-builder/converters/flow-query-converters.js",
22301
+ "declarations": [
22302
+ {
22303
+ "kind": "function",
22304
+ "name": "converter",
22305
+ "parameters": [
22306
+ {
22307
+ "name": "ruleset",
22308
+ "type": {
22309
+ "text": "FlowQueryBuilderRuleSet"
22310
+ }
22311
+ },
22312
+ {
22313
+ "name": "config",
22314
+ "type": {
22315
+ "text": "FlowQueryBuilderConfig"
22316
+ }
22317
+ },
22318
+ {
22319
+ "name": "options",
22320
+ "optional": true,
22321
+ "type": {
22322
+ "text": "FlowQueryBuilderConverterOptions"
22323
+ }
22324
+ }
22325
+ ]
22326
+ }
22327
+ ],
22328
+ "exports": [
22329
+ {
22330
+ "kind": "js",
22331
+ "name": "default",
22332
+ "declaration": {
22333
+ "name": "converter",
22334
+ "module": "components/query-builder/converters/flow-query-converters.js"
22335
+ }
22336
+ }
22337
+ ]
22338
+ },
22339
+ {
22340
+ "kind": "javascript-module",
22341
+ "path": "components/query-builder/converters/index.js",
22342
+ "declarations": [],
22343
+ "exports": [
22344
+ {
22345
+ "kind": "js",
22346
+ "name": "flowQueryConverter",
22347
+ "declaration": {
22348
+ "name": "flowQueryConverter",
22349
+ "module": "components/query-builder/converters/index.js"
22350
+ }
22351
+ },
22352
+ {
22353
+ "kind": "js",
22354
+ "name": "mapLayerFilterConverter",
22355
+ "declaration": {
22356
+ "name": "mapLayerFilterConverter",
22357
+ "module": "components/query-builder/converters/index.js"
22358
+ }
22359
+ }
22360
+ ]
22361
+ },
22362
+ {
22363
+ "kind": "javascript-module",
22364
+ "path": "components/query-builder/converters/map-layer-filter-converter.js",
22365
+ "declarations": [
22366
+ {
22367
+ "kind": "function",
22368
+ "name": "converter",
22369
+ "parameters": [
22370
+ {
22371
+ "name": "ruleset",
22372
+ "type": {
22373
+ "text": "FlowQueryBuilderRuleSet"
22374
+ }
22375
+ },
22376
+ {
22377
+ "name": "config",
22378
+ "type": {
22379
+ "text": "FlowQueryBuilderConfig"
22380
+ }
22381
+ },
22382
+ {
22383
+ "name": "options",
22384
+ "optional": true,
22385
+ "type": {
22386
+ "text": "FlowQueryBuilderConverterOptions"
22387
+ }
22388
+ }
22389
+ ]
22390
+ }
22391
+ ],
22392
+ "exports": [
22393
+ {
22394
+ "kind": "js",
22395
+ "name": "default",
22396
+ "declaration": {
22397
+ "name": "converter",
22398
+ "module": "components/query-builder/converters/map-layer-filter-converter.js"
22399
+ }
22400
+ }
22401
+ ]
22402
22402
  }
22403
22403
  ],
22404
22404
  "package": {
22405
22405
  "name": "@emuanalytics/flow-rdf-ui",
22406
- "version": "4.0.6"
22406
+ "version": "4.0.8"
22407
22407
  }
22408
22408
  }