@emuanalytics/flow-rdf-ui 4.4.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -285,40 +285,22 @@
285
285
  },
286
286
  {
287
287
  "kind": "javascript-module",
288
- "path": "components/avatar/avatar.component.js",
288
+ "path": "components/badge/badge.component.js",
289
289
  "declarations": [
290
290
  {
291
291
  "kind": "class",
292
292
  "description": "",
293
- "name": "FlowUiAvatar",
294
- "cssProperties": [
295
- {
296
- "description": "The size of the avatar.",
297
- "name": "--size"
298
- }
299
- ],
293
+ "name": "FlowUiBadge",
300
294
  "cssParts": [
301
295
  {
302
296
  "description": "The component's base wrapper.",
303
297
  "name": "base"
304
- },
305
- {
306
- "description": "The container that wraps the avatar's icon.",
307
- "name": "icon"
308
- },
309
- {
310
- "description": "The container that wraps the avatar's initials.",
311
- "name": "initials"
312
- },
313
- {
314
- "description": "The avatar image. Only shown when the `image` attribute is set.",
315
- "name": "image"
316
298
  }
317
299
  ],
318
300
  "slots": [
319
301
  {
320
- "description": "The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.",
321
- "name": "icon"
302
+ "description": "The badge's content.",
303
+ "name": ""
322
304
  }
323
305
  ],
324
306
  "members": [
@@ -329,134 +311,97 @@
329
311
  "text": "string"
330
312
  },
331
313
  "static": true,
332
- "default": "'flow-ui-avatar'"
333
- },
334
- {
335
- "kind": "field",
336
- "name": "dependencies",
337
- "type": {
338
- "text": "array"
339
- },
340
- "static": true,
341
- "default": "[FlowUiIcon]"
342
- },
343
- {
344
- "kind": "field",
345
- "name": "hasError",
346
- "type": {
347
- "text": "boolean"
348
- },
349
- "privacy": "private",
350
- "default": "false"
351
- },
352
- {
353
- "kind": "field",
354
- "name": "image",
355
- "type": {
356
- "text": "string"
357
- },
358
- "default": "''",
359
- "description": "The image source to use for the avatar.",
360
- "attribute": "image"
314
+ "default": "'flow-ui-badge'"
361
315
  },
362
316
  {
363
317
  "kind": "field",
364
- "name": "label",
318
+ "name": "variant",
365
319
  "type": {
366
- "text": "string"
320
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
367
321
  },
368
- "default": "''",
369
- "description": "A label to use to describe the avatar to assistive devices.",
370
- "attribute": "label"
322
+ "default": "'primary'",
323
+ "description": "The badge's theme variant.",
324
+ "attribute": "variant",
325
+ "reflects": true
371
326
  },
372
327
  {
373
328
  "kind": "field",
374
- "name": "initials",
329
+ "name": "size",
375
330
  "type": {
376
- "text": "string"
331
+ "text": "'small' | 'medium' | 'large'"
377
332
  },
378
- "default": "''",
379
- "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
380
- "attribute": "initials"
333
+ "default": "'medium'",
334
+ "description": "The badge size.",
335
+ "attribute": "size",
336
+ "reflects": true
381
337
  },
382
338
  {
383
339
  "kind": "field",
384
- "name": "loading",
340
+ "name": "pill",
385
341
  "type": {
386
- "text": "'eager' | 'lazy'"
342
+ "text": "boolean"
387
343
  },
388
- "default": "'eager'",
389
- "description": "Indicates how the browser should load the image.",
390
- "attribute": "loading"
344
+ "default": "false",
345
+ "description": "Draws a pill-style badge with rounded edges.",
346
+ "attribute": "pill",
347
+ "reflects": true
391
348
  },
392
349
  {
393
350
  "kind": "field",
394
- "name": "shape",
351
+ "name": "pulse",
395
352
  "type": {
396
- "text": "'circle' | 'square' | 'rounded'"
353
+ "text": "boolean"
397
354
  },
398
- "default": "'circle'",
399
- "description": "The shape of the avatar.",
400
- "attribute": "shape",
355
+ "default": "false",
356
+ "description": "Makes the badge pulsate to draw attention.",
357
+ "attribute": "pulse",
401
358
  "reflects": true
402
359
  }
403
360
  ],
404
361
  "attributes": [
405
362
  {
406
- "name": "image",
407
- "type": {
408
- "text": "string"
409
- },
410
- "default": "''",
411
- "description": "The image source to use for the avatar.",
412
- "fieldName": "image"
413
- },
414
- {
415
- "name": "label",
363
+ "name": "variant",
416
364
  "type": {
417
- "text": "string"
365
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
418
366
  },
419
- "default": "''",
420
- "description": "A label to use to describe the avatar to assistive devices.",
421
- "fieldName": "label"
367
+ "default": "'primary'",
368
+ "description": "The badge's theme variant.",
369
+ "fieldName": "variant"
422
370
  },
423
371
  {
424
- "name": "initials",
372
+ "name": "size",
425
373
  "type": {
426
- "text": "string"
374
+ "text": "'small' | 'medium' | 'large'"
427
375
  },
428
- "default": "''",
429
- "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
430
- "fieldName": "initials"
376
+ "default": "'medium'",
377
+ "description": "The badge size.",
378
+ "fieldName": "size"
431
379
  },
432
380
  {
433
- "name": "loading",
381
+ "name": "pill",
434
382
  "type": {
435
- "text": "'eager' | 'lazy'"
383
+ "text": "boolean"
436
384
  },
437
- "default": "'eager'",
438
- "description": "Indicates how the browser should load the image.",
439
- "fieldName": "loading"
385
+ "default": "false",
386
+ "description": "Draws a pill-style badge with rounded edges.",
387
+ "fieldName": "pill"
440
388
  },
441
389
  {
442
- "name": "shape",
390
+ "name": "pulse",
443
391
  "type": {
444
- "text": "'circle' | 'square' | 'rounded'"
392
+ "text": "boolean"
445
393
  },
446
- "default": "'circle'",
447
- "description": "The shape of the avatar.",
448
- "fieldName": "shape"
394
+ "default": "false",
395
+ "description": "Makes the badge pulsate to draw attention.",
396
+ "fieldName": "pulse"
449
397
  }
450
398
  ],
451
399
  "superclass": {
452
400
  "name": "FlowRdfElement",
453
401
  "module": "/src/internal/flow-ui-rdf-element"
454
402
  },
455
- "tagName": "flow-ui-avatar",
456
- "summary": "Avatars are used to represent a person or object.",
457
- "dependencies": [
458
- "flow-ui-icon"
459
- ],
403
+ "tagName": "flow-ui-badge",
404
+ "summary": "Badges are used to draw attention and display statuses or counts.",
460
405
  "customElement": true
461
406
  }
462
407
  ],
@@ -465,101 +410,39 @@
465
410
  "kind": "js",
466
411
  "name": "default",
467
412
  "declaration": {
468
- "name": "FlowUiAvatar",
469
- "module": "components/avatar/avatar.component.js"
413
+ "name": "FlowUiBadge",
414
+ "module": "components/badge/badge.component.js"
470
415
  }
471
416
  }
472
417
  ]
473
418
  },
474
419
  {
475
420
  "kind": "javascript-module",
476
- "path": "components/avatar/avatar.js",
421
+ "path": "components/badge/badge.js",
477
422
  "declarations": [],
478
423
  "exports": [
479
424
  {
480
425
  "kind": "js",
481
426
  "name": "default",
482
427
  "declaration": {
483
- "name": "FlowUiAvatar",
484
- "module": "components/avatar/avatar.js"
428
+ "name": "FlowUiBadge",
429
+ "module": "components/badge/badge.js"
485
430
  }
486
431
  }
487
432
  ]
488
433
  },
489
434
  {
490
435
  "kind": "javascript-module",
491
- "path": "components/autocomplete/autocomplete.component.js",
436
+ "path": "components/animation/animation.component.js",
492
437
  "declarations": [
493
438
  {
494
439
  "kind": "class",
495
- "description": "The autocomplete component does not filter its options itself. Listen for the `flow-ui-input` event, read the text\nthat the user has typed with `getInputText()`, and replace the slotted `<flow-ui-option>` elements with the options\nthat match. The autocomplete's value is the option value of the selected option. Use `displayWith` to show a label\nin the input instead of the option value.",
496
- "name": "FlowUiAutocomplete",
497
- "cssParts": [
498
- {
499
- "description": "The form control that wraps the label, input, and help text.",
500
- "name": "form-control"
501
- },
502
- {
503
- "description": "The label's wrapper.",
504
- "name": "label"
505
- },
506
- {
507
- "description": "The help text's wrapper.",
508
- "name": "help-text"
509
- },
510
- {
511
- "description": "The input's wrapper.",
512
- "name": "control"
513
- },
514
- {
515
- "description": "The container that wraps the prefix, suffix, input and clear button.",
516
- "name": "combobox"
517
- },
518
- {
519
- "description": "The container that wraps the prefix.",
520
- "name": "prefix"
521
- },
522
- {
523
- "description": "The container that wraps the suffix.",
524
- "name": "suffix"
525
- },
526
- {
527
- "description": "The text input, an `<input>` element.",
528
- "name": "display-input"
529
- },
530
- {
531
- "description": "The listbox container where options are slotted.",
532
- "name": "listbox"
533
- },
534
- {
535
- "description": "The clear button.",
536
- "name": "clear-button"
537
- }
538
- ],
440
+ "description": "",
441
+ "name": "FlowUiAnimation",
539
442
  "slots": [
540
443
  {
541
- "description": "The listbox options. Must be `<flow-ui-option>` elements. You can use `<flow-ui-divider>` to group items visually.",
444
+ "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.",
542
445
  "name": ""
543
- },
544
- {
545
- "description": "The autocomplete's label. Alternatively, you can use the `label` attribute.",
546
- "name": "label"
547
- },
548
- {
549
- "description": "Used to prepend a presentational icon or similar element to the combobox.",
550
- "name": "prefix"
551
- },
552
- {
553
- "description": "Used to append a presentational icon or similar element to the combobox.",
554
- "name": "suffix"
555
- },
556
- {
557
- "description": "An icon to use in lieu of the default clear icon.",
558
- "name": "clear-icon"
559
- },
560
- {
561
- "description": "Text that describes how to use the autocomplete. Alternatively, you can use the `help-text` attribute.",
562
- "name": "help-text"
563
446
  }
564
447
  ],
565
448
  "members": [
@@ -570,984 +453,1088 @@
570
453
  "text": "string"
571
454
  },
572
455
  "static": true,
573
- "default": "'flow-ui-autocomplete'"
456
+ "default": "'flow-ui-animation'"
574
457
  },
575
458
  {
576
459
  "kind": "field",
577
- "name": "dependencies",
460
+ "name": "animation",
578
461
  "type": {
579
- "text": "array"
462
+ "text": "Animation | undefined"
580
463
  },
581
- "static": true,
582
- "default": "[FlowUiDivider, FlowIcon, FlowPopup]"
464
+ "privacy": "private"
583
465
  },
584
466
  {
585
467
  "kind": "field",
586
- "name": "hasSlotController",
468
+ "name": "hasStarted",
469
+ "type": {
470
+ "text": "boolean"
471
+ },
587
472
  "privacy": "private",
588
- "readonly": true,
589
- "default": "new HasSlotController(this, 'help-text', 'label')"
473
+ "default": "false"
590
474
  },
591
475
  {
592
476
  "kind": "field",
593
- "name": "localize",
594
- "privacy": "private",
595
- "readonly": true,
596
- "default": "new LocalizeController(this)"
597
- },
598
- {
599
- "kind": "field",
600
- "name": "pendingChangeEvent",
477
+ "name": "defaultSlot",
601
478
  "type": {
602
- "text": "boolean"
479
+ "text": "Promise<HTMLSlotElement>"
603
480
  },
604
- "privacy": "private",
605
- "default": "false"
481
+ "privacy": "private"
606
482
  },
607
483
  {
608
484
  "kind": "field",
609
- "name": "pendingInputEvent",
485
+ "name": "name",
610
486
  "type": {
611
- "text": "boolean"
487
+ "text": "string"
612
488
  },
613
- "privacy": "private",
614
- "default": "false"
489
+ "default": "'none'",
490
+ "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.",
491
+ "attribute": "name"
615
492
  },
616
493
  {
617
494
  "kind": "field",
618
- "name": "hasOptions",
495
+ "name": "play",
619
496
  "type": {
620
497
  "text": "boolean"
621
498
  },
622
- "privacy": "private",
623
- "default": "false"
624
- },
625
- {
626
- "kind": "field",
627
- "name": "formControlController",
628
- "privacy": "private",
629
- "readonly": true,
630
- "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })"
499
+ "default": "false",
500
+ "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
501
+ "attribute": "play",
502
+ "reflects": true
631
503
  },
632
504
  {
633
505
  "kind": "field",
634
- "name": "size",
506
+ "name": "delay",
635
507
  "type": {
636
- "text": "'small' | 'medium' | 'large'"
508
+ "text": "number"
637
509
  },
638
- "default": "'medium'",
639
- "description": "The autocomplete's size.",
640
- "attribute": "size",
641
- "reflects": true
510
+ "default": "0",
511
+ "description": "The number of milliseconds to delay the start of the animation.",
512
+ "attribute": "delay"
642
513
  },
643
514
  {
644
515
  "kind": "field",
645
- "name": "filled",
516
+ "name": "direction",
646
517
  "type": {
647
- "text": "boolean"
518
+ "text": "PlaybackDirection"
648
519
  },
649
- "default": "false",
650
- "description": "Draws a filled autocomplete input.",
651
- "attribute": "filled",
652
- "reflects": true
520
+ "default": "'normal'",
521
+ "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)",
522
+ "attribute": "direction"
653
523
  },
654
524
  {
655
525
  "kind": "field",
656
- "name": "pill",
526
+ "name": "duration",
657
527
  "type": {
658
- "text": "boolean"
528
+ "text": "number"
659
529
  },
660
- "default": "false",
661
- "description": "Draws a pill-style autocomplete input with rounded edges.",
662
- "attribute": "pill",
663
- "reflects": true
530
+ "default": "1000",
531
+ "description": "The number of milliseconds each iteration of the animation takes to complete.",
532
+ "attribute": "duration"
664
533
  },
665
534
  {
666
535
  "kind": "field",
667
- "name": "label",
536
+ "name": "easing",
668
537
  "type": {
669
538
  "text": "string"
670
539
  },
671
- "default": "''",
672
- "description": "The autocomplete's label. If you need to display HTML, use the `label` slot instead.",
673
- "attribute": "label"
540
+ "default": "'linear'",
541
+ "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)`.",
542
+ "attribute": "easing"
674
543
  },
675
544
  {
676
545
  "kind": "field",
677
- "name": "helpText",
546
+ "name": "endDelay",
678
547
  "type": {
679
- "text": "string"
548
+ "text": "number"
680
549
  },
681
- "default": "''",
682
- "description": "The autocomplete's help text. If you need to display HTML, use the `help-text` slot instead.",
683
- "attribute": "help-text"
550
+ "default": "0",
551
+ "description": "The number of milliseconds to delay after the active period of an animation sequence.",
552
+ "attribute": "end-delay"
684
553
  },
685
554
  {
686
555
  "kind": "field",
687
- "name": "placeholder",
556
+ "name": "fill",
688
557
  "type": {
689
- "text": "string"
558
+ "text": "FillMode"
690
559
  },
691
- "default": "''",
692
- "description": "The autocomplete's placeholder text.",
693
- "attribute": "placeholder"
560
+ "default": "'auto'",
561
+ "description": "Sets how the animation applies styles to its target before and after its execution.",
562
+ "attribute": "fill"
694
563
  },
695
564
  {
696
565
  "kind": "field",
697
- "name": "disabled",
698
- "type": {
699
- "text": "boolean"
700
- },
701
- "default": "false",
702
- "description": "Disables the autocomplete.",
703
- "attribute": "disabled",
704
- "reflects": true
566
+ "name": "iterations",
567
+ "default": "Infinity",
568
+ "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
569
+ "attribute": "iterations"
705
570
  },
706
571
  {
707
572
  "kind": "field",
708
- "name": "form",
573
+ "name": "iterationStart",
709
574
  "type": {
710
- "text": "string"
575
+ "text": "number"
711
576
  },
712
- "description": "The \"form owner\" to associate the autocomplete with. If omitted, the closest containing form will be used\ninstead. The value of this attribute must be an id of a form in the same document or shadow root as the\nautocomplete.",
713
- "attribute": "form"
577
+ "default": "0",
578
+ "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
579
+ "attribute": "iteration-start"
714
580
  },
715
581
  {
716
582
  "kind": "field",
717
- "name": "required",
583
+ "name": "keyframes",
718
584
  "type": {
719
- "text": "boolean"
585
+ "text": "Keyframe[] | undefined"
720
586
  },
721
- "default": "false",
722
- "description": "Makes the autocomplete a required field.",
723
- "attribute": "required",
724
- "reflects": true
587
+ "description": "The keyframes to use for the animation. If this is set, `name` will be ignored."
725
588
  },
726
589
  {
727
590
  "kind": "field",
728
- "name": "inline",
591
+ "name": "playbackRate",
729
592
  "type": {
730
- "text": "boolean"
593
+ "text": "number"
731
594
  },
732
- "default": "false",
733
- "description": "Set to `true` to display the autocomplete in the inline form control style.",
734
- "attribute": "inline",
735
- "reflects": true
595
+ "default": "1",
596
+ "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.",
597
+ "attribute": "playback-rate"
736
598
  },
737
599
  {
738
600
  "kind": "field",
739
- "name": "divider",
601
+ "name": "currentTime",
740
602
  "type": {
741
- "text": "boolean"
603
+ "text": "CSSNumberish"
742
604
  },
743
- "default": "false",
744
- "description": "Set to `true` to display a divider below the control.",
745
- "attribute": "divider",
746
- "reflects": true
605
+ "description": "Gets and sets the current animation time."
747
606
  },
748
607
  {
749
608
  "kind": "field",
750
- "name": "hoist",
751
- "type": {
752
- "text": "boolean"
753
- },
754
- "default": "false",
755
- "description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
756
- "attribute": "hoist"
609
+ "name": "handleAnimationFinish",
610
+ "privacy": "private"
757
611
  },
758
612
  {
759
613
  "kind": "field",
760
- "name": "placement",
761
- "type": {
762
- "text": "'top' | 'bottom'"
763
- },
764
- "default": "'bottom'",
765
- "description": "The preferred placement of the autocomplete's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
766
- "attribute": "placement",
767
- "reflects": true
614
+ "name": "handleAnimationCancel",
615
+ "privacy": "private"
768
616
  },
769
617
  {
770
- "kind": "field",
771
- "name": "value",
618
+ "kind": "method",
619
+ "name": "handleSlotChange",
620
+ "privacy": "private"
621
+ },
622
+ {
623
+ "kind": "method",
624
+ "name": "createAnimation",
625
+ "privacy": "private"
626
+ },
627
+ {
628
+ "kind": "method",
629
+ "name": "destroyAnimation",
630
+ "privacy": "private"
631
+ },
632
+ {
633
+ "kind": "method",
634
+ "name": "cancel",
635
+ "description": "Clears all keyframe effects caused by this animation and aborts its playback."
636
+ },
637
+ {
638
+ "kind": "method",
639
+ "name": "finish",
640
+ "description": "Sets the playback time to the end of the animation corresponding to the current playback direction."
641
+ }
642
+ ],
643
+ "events": [
644
+ {
645
+ "description": "Emitted when the animation is canceled.",
646
+ "name": "flow-ui-cancel",
647
+ "reactName": "onFlowUiCancel"
648
+ },
649
+ {
650
+ "description": "Emitted when the animation finishes.",
651
+ "name": "flow-ui-finish",
652
+ "reactName": "onFlowUiFinish"
653
+ },
654
+ {
655
+ "description": "Emitted when the animation starts or restarts.",
656
+ "name": "flow-ui-start",
657
+ "reactName": "onFlowUiStart"
658
+ }
659
+ ],
660
+ "attributes": [
661
+ {
662
+ "name": "name",
772
663
  "type": {
773
664
  "text": "string"
774
665
  },
775
- "default": "''",
776
- "description": "The option value of the selected option.",
777
- "attribute": "value"
666
+ "default": "'none'",
667
+ "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.",
668
+ "fieldName": "name"
778
669
  },
779
670
  {
780
- "kind": "field",
781
- "name": "displayWith",
671
+ "name": "play",
782
672
  "type": {
783
- "text": "((value: string) => string) | ((value: string) => Promise<string>)"
673
+ "text": "boolean"
784
674
  },
785
- "description": "The function that returns the text to show in the input for a given `value`. It can return a promise. If not set,\nthe input shows the value itself.",
786
- "attribute": "displayWith"
675
+ "default": "false",
676
+ "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
677
+ "fieldName": "play"
787
678
  },
788
679
  {
789
- "kind": "field",
790
- "name": "debounceDelay",
680
+ "name": "delay",
791
681
  "type": {
792
682
  "text": "number"
793
683
  },
794
684
  "default": "0",
795
- "description": "The delay in milliseconds between the user's last keystroke and the `flow-ui-input` event.",
796
- "attribute": "debounce-delay",
797
- "reflects": true
685
+ "description": "The number of milliseconds to delay the start of the animation.",
686
+ "fieldName": "delay"
798
687
  },
799
688
  {
800
- "kind": "field",
801
- "name": "clearable",
689
+ "name": "direction",
802
690
  "type": {
803
- "text": "boolean"
691
+ "text": "PlaybackDirection"
804
692
  },
805
- "default": "false",
806
- "description": "Set to `true` to show a clear button when the autocomplete has a value.",
807
- "attribute": "clearable",
808
- "reflects": true
693
+ "default": "'normal'",
694
+ "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)",
695
+ "fieldName": "direction"
809
696
  },
810
697
  {
811
- "kind": "field",
812
- "name": "clearOnFocus",
698
+ "name": "duration",
813
699
  "type": {
814
- "text": "boolean"
700
+ "text": "number"
815
701
  },
816
- "default": "false",
817
- "description": "Set to `true` to clear the value when the autocomplete gains focus.",
818
- "attribute": "clear-on-focus",
819
- "reflects": true
702
+ "default": "1000",
703
+ "description": "The number of milliseconds each iteration of the animation takes to complete.",
704
+ "fieldName": "duration"
820
705
  },
821
706
  {
822
- "kind": "field",
823
- "name": "inputText",
707
+ "name": "easing",
824
708
  "type": {
825
709
  "text": "string"
826
710
  },
827
- "privacy": "private",
828
- "default": "''",
829
- "description": "Current value displayed by the control; this can be what the user is typing or the label of the selected option"
711
+ "default": "'linear'",
712
+ "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)`.",
713
+ "fieldName": "easing"
830
714
  },
831
715
  {
832
- "kind": "field",
833
- "name": "selectedOption",
716
+ "name": "end-delay",
834
717
  "type": {
835
- "text": "FlowOption | null"
718
+ "text": "number"
836
719
  },
837
- "privacy": "private",
838
- "default": "null"
720
+ "default": "0",
721
+ "description": "The number of milliseconds to delay after the active period of an animation sequence.",
722
+ "fieldName": "endDelay"
839
723
  },
840
724
  {
841
- "kind": "field",
842
- "name": "currentOption",
725
+ "name": "fill",
843
726
  "type": {
844
- "text": "FlowOption | null"
727
+ "text": "FillMode"
845
728
  },
846
- "privacy": "private",
847
- "default": "null"
729
+ "default": "'auto'",
730
+ "description": "Sets how the animation applies styles to its target before and after its execution.",
731
+ "fieldName": "fill"
848
732
  },
849
733
  {
850
- "kind": "field",
851
- "name": "input",
852
- "type": {
853
- "text": "HTMLInputElement"
734
+ "name": "iterations",
735
+ "default": "Infinity",
736
+ "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
737
+ "resolveInitializer": {
738
+ "module": "src/components/animation/animation.component.ts"
854
739
  },
855
- "privacy": "private"
740
+ "fieldName": "iterations"
856
741
  },
857
742
  {
858
- "kind": "field",
859
- "name": "popup",
743
+ "name": "iteration-start",
860
744
  "type": {
861
- "text": "FlowPopup"
745
+ "text": "number"
862
746
  },
863
- "privacy": "private"
747
+ "default": "0",
748
+ "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
749
+ "fieldName": "iterationStart"
864
750
  },
865
751
  {
866
- "kind": "field",
867
- "name": "listbox",
752
+ "name": "playback-rate",
868
753
  "type": {
869
- "text": "HTMLElement"
754
+ "text": "number"
870
755
  },
871
- "privacy": "private"
756
+ "default": "1",
757
+ "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.",
758
+ "fieldName": "playbackRate"
759
+ }
760
+ ],
761
+ "superclass": {
762
+ "name": "FlowRdfElement",
763
+ "module": "/src/internal/flow-ui-rdf-element"
764
+ },
765
+ "tagName": "flow-ui-animation",
766
+ "summary": "Animate elements declaratively with over 100 animation presets. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).",
767
+ "customElement": true
768
+ }
769
+ ],
770
+ "exports": [
771
+ {
772
+ "kind": "js",
773
+ "name": "default",
774
+ "declaration": {
775
+ "name": "FlowUiAnimation",
776
+ "module": "components/animation/animation.component.js"
777
+ }
778
+ }
779
+ ]
780
+ },
781
+ {
782
+ "kind": "javascript-module",
783
+ "path": "components/animation/animation.js",
784
+ "declarations": [],
785
+ "exports": [
786
+ {
787
+ "kind": "js",
788
+ "name": "*",
789
+ "declaration": {
790
+ "name": "*",
791
+ "package": "./animation.component"
792
+ }
793
+ },
794
+ {
795
+ "kind": "js",
796
+ "name": "default",
797
+ "declaration": {
798
+ "name": "FlowUiAnimation",
799
+ "module": "components/animation/animation.js"
800
+ }
801
+ }
802
+ ]
803
+ },
804
+ {
805
+ "kind": "javascript-module",
806
+ "path": "components/animation/animations.js",
807
+ "declarations": [
808
+ {
809
+ "kind": "function",
810
+ "name": "getAnimationNames",
811
+ "description": "Returns a list of all supported animation names.\n\nSupply the required animation as the `name` property of the\n`<flow-ui-animation>` component."
812
+ },
813
+ {
814
+ "kind": "function",
815
+ "name": "getEasingNames",
816
+ "description": "Returns a list of all supported easing method names.\n\nSupply the required easing method as the `easing` property of the\n`<flow-ui-animation>` component."
817
+ }
818
+ ],
819
+ "exports": [
820
+ {
821
+ "kind": "js",
822
+ "name": "animations",
823
+ "declaration": {
824
+ "name": "animations",
825
+ "module": "components/animation/animations.js"
826
+ }
827
+ },
828
+ {
829
+ "kind": "js",
830
+ "name": "getAnimationNames",
831
+ "declaration": {
832
+ "name": "getAnimationNames",
833
+ "module": "components/animation/animations.js"
834
+ }
835
+ },
836
+ {
837
+ "kind": "js",
838
+ "name": "getEasingNames",
839
+ "declaration": {
840
+ "name": "getEasingNames",
841
+ "module": "components/animation/animations.js"
842
+ }
843
+ }
844
+ ]
845
+ },
846
+ {
847
+ "kind": "javascript-module",
848
+ "path": "components/autocomplete/autocomplete.component.js",
849
+ "declarations": [
850
+ {
851
+ "kind": "class",
852
+ "description": "The autocomplete component does not filter its options itself. Listen for the `flow-ui-input` event, read the text\nthat the user has typed with `getInputText()`, and replace the slotted `<flow-ui-option>` elements with the options\nthat match. The autocomplete's value is the option value of the selected option. Use `displayWith` to show a label\nin the input instead of the option value.",
853
+ "name": "FlowUiAutocomplete",
854
+ "cssParts": [
855
+ {
856
+ "description": "The form control that wraps the label, input, and help text.",
857
+ "name": "form-control"
872
858
  },
873
859
  {
874
- "kind": "method",
875
- "name": "getForm",
876
- "return": {
877
- "type": {
878
- "text": "HTMLFormElement | null"
879
- }
880
- },
881
- "description": "Gets the associated form, if one exists."
860
+ "description": "The label's wrapper.",
861
+ "name": "label"
882
862
  },
883
863
  {
884
- "kind": "field",
885
- "name": "validity",
886
- "description": "Gets the validity state object.",
887
- "readonly": true
864
+ "description": "The help text's wrapper.",
865
+ "name": "help-text"
888
866
  },
889
867
  {
890
- "kind": "field",
891
- "name": "validationMessage",
892
- "description": "Gets the validation message.",
893
- "readonly": true
868
+ "description": "The input's wrapper.",
869
+ "name": "control"
894
870
  },
895
871
  {
896
- "kind": "method",
897
- "name": "checkValidity",
898
- "return": {
899
- "type": {
900
- "text": "boolean"
901
- }
902
- },
903
- "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid."
872
+ "description": "The container that wraps the prefix, suffix, input and clear button.",
873
+ "name": "combobox"
904
874
  },
905
875
  {
906
- "kind": "method",
907
- "name": "reportValidity",
908
- "return": {
909
- "type": {
910
- "text": "boolean"
911
- }
912
- },
913
- "description": "Checks for validity and shows the browser's validation message if the control is invalid."
876
+ "description": "The container that wraps the prefix.",
877
+ "name": "prefix"
914
878
  },
915
879
  {
916
- "kind": "method",
917
- "name": "setCustomValidity",
918
- "parameters": [
919
- {
920
- "name": "_",
921
- "type": {
922
- "text": "string"
923
- }
924
- }
925
- ],
926
- "description": "Sets a custom validation message. Pass an empty string to restore validity."
880
+ "description": "The container that wraps the suffix.",
881
+ "name": "suffix"
927
882
  },
928
883
  {
929
- "kind": "method",
930
- "name": "handleClearClick",
931
- "parameters": [
932
- {
933
- "name": "event",
934
- "type": {
935
- "text": "MouseEvent"
936
- }
937
- }
938
- ]
884
+ "description": "The text input, an `<input>` element.",
885
+ "name": "display-input"
939
886
  },
940
887
  {
941
- "kind": "method",
942
- "name": "focus",
943
- "description": "Focuses on the control"
888
+ "description": "The listbox container where options are slotted.",
889
+ "name": "listbox"
944
890
  },
945
891
  {
946
- "kind": "method",
947
- "name": "blur",
948
- "description": "Blurs from the control."
892
+ "description": "The clear button.",
893
+ "name": "clear-button"
894
+ }
895
+ ],
896
+ "slots": [
897
+ {
898
+ "description": "The listbox options. Must be `<flow-ui-option>` elements. You can use `<flow-ui-divider>` to group items visually.",
899
+ "name": ""
949
900
  },
950
901
  {
951
- "kind": "method",
952
- "name": "show",
953
- "description": "Shows the listbox."
902
+ "description": "The autocomplete's label. Alternatively, you can use the `label` attribute.",
903
+ "name": "label"
954
904
  },
955
905
  {
956
- "kind": "method",
957
- "name": "hide",
958
- "description": "Hides the listbox."
906
+ "description": "Used to prepend a presentational icon or similar element to the combobox.",
907
+ "name": "prefix"
959
908
  },
960
909
  {
961
- "kind": "method",
962
- "name": "getInputText",
963
- "description": "Gets the current value of the text input"
910
+ "description": "Used to append a presentational icon or similar element to the combobox.",
911
+ "name": "suffix"
912
+ },
913
+ {
914
+ "description": "An icon to use in lieu of the default clear icon.",
915
+ "name": "clear-icon"
916
+ },
917
+ {
918
+ "description": "Text that describes how to use the autocomplete. Alternatively, you can use the `help-text` attribute.",
919
+ "name": "help-text"
964
920
  }
965
921
  ],
966
- "events": [
922
+ "members": [
967
923
  {
968
- "description": "Emitted when the input text changes. When the user types, the event is emitted after the `debounce-delay`. Call `getInputText()` to read the text, for example to update the options.",
969
- "name": "flow-ui-input",
970
- "reactName": "onFlowUiInput"
924
+ "kind": "field",
925
+ "name": "tagName",
926
+ "type": {
927
+ "text": "string"
928
+ },
929
+ "static": true,
930
+ "default": "'flow-ui-autocomplete'"
971
931
  },
972
932
  {
973
- "description": "Emitted when the autocomplete's value changes.",
974
- "name": "flow-ui-change",
975
- "reactName": "onFlowUiChange"
933
+ "kind": "field",
934
+ "name": "dependencies",
935
+ "type": {
936
+ "text": "array"
937
+ },
938
+ "static": true,
939
+ "default": "[FlowUiDivider, FlowIcon, FlowPopup]"
976
940
  },
977
941
  {
978
- "description": "Emitted when the autocomplete gains focus.",
979
- "name": "flow-ui-focus",
980
- "reactName": "onFlowUiFocus"
942
+ "kind": "field",
943
+ "name": "hasSlotController",
944
+ "privacy": "private",
945
+ "readonly": true,
946
+ "default": "new HasSlotController(this, 'help-text', 'label')"
981
947
  },
982
948
  {
983
- "description": "Emitted when the autocomplete loses focus.",
984
- "name": "flow-ui-blur",
985
- "reactName": "onFlowUiBlur"
949
+ "kind": "field",
950
+ "name": "localize",
951
+ "privacy": "private",
952
+ "readonly": true,
953
+ "default": "new LocalizeController(this)"
986
954
  },
987
955
  {
988
- "description": "Emitted when the listbox opens.",
989
- "name": "flow-ui-show",
990
- "reactName": "onFlowUiShow"
956
+ "kind": "field",
957
+ "name": "pendingChangeEvent",
958
+ "type": {
959
+ "text": "boolean"
960
+ },
961
+ "privacy": "private",
962
+ "default": "false"
991
963
  },
992
964
  {
993
- "description": "Emitted after the listbox opens and all animations are complete.",
994
- "name": "flow-ui-after-show",
995
- "reactName": "onFlowUiAfterShow"
965
+ "kind": "field",
966
+ "name": "pendingInputEvent",
967
+ "type": {
968
+ "text": "boolean"
969
+ },
970
+ "privacy": "private",
971
+ "default": "false"
996
972
  },
997
973
  {
998
- "description": "Emitted when the listbox closes.",
999
- "name": "flow-ui-hide",
1000
- "reactName": "onFlowUiHide"
974
+ "kind": "field",
975
+ "name": "hasOptions",
976
+ "type": {
977
+ "text": "boolean"
978
+ },
979
+ "privacy": "private",
980
+ "default": "false"
1001
981
  },
1002
982
  {
1003
- "description": "Emitted after the listbox closes and all animations are complete.",
1004
- "name": "flow-ui-after-hide",
1005
- "reactName": "onFlowUiAfterHide"
1006
- }
1007
- ],
1008
- "attributes": [
983
+ "kind": "field",
984
+ "name": "formControlController",
985
+ "privacy": "private",
986
+ "readonly": true,
987
+ "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })"
988
+ },
1009
989
  {
990
+ "kind": "field",
1010
991
  "name": "size",
1011
992
  "type": {
1012
993
  "text": "'small' | 'medium' | 'large'"
1013
994
  },
1014
995
  "default": "'medium'",
1015
996
  "description": "The autocomplete's size.",
1016
- "fieldName": "size"
997
+ "attribute": "size",
998
+ "reflects": true
1017
999
  },
1018
1000
  {
1001
+ "kind": "field",
1019
1002
  "name": "filled",
1020
1003
  "type": {
1021
1004
  "text": "boolean"
1022
1005
  },
1023
1006
  "default": "false",
1024
1007
  "description": "Draws a filled autocomplete input.",
1025
- "fieldName": "filled"
1008
+ "attribute": "filled",
1009
+ "reflects": true
1026
1010
  },
1027
1011
  {
1012
+ "kind": "field",
1028
1013
  "name": "pill",
1029
1014
  "type": {
1030
1015
  "text": "boolean"
1031
1016
  },
1032
1017
  "default": "false",
1033
1018
  "description": "Draws a pill-style autocomplete input with rounded edges.",
1034
- "fieldName": "pill"
1019
+ "attribute": "pill",
1020
+ "reflects": true
1035
1021
  },
1036
1022
  {
1023
+ "kind": "field",
1037
1024
  "name": "label",
1038
1025
  "type": {
1039
1026
  "text": "string"
1040
1027
  },
1041
1028
  "default": "''",
1042
1029
  "description": "The autocomplete's label. If you need to display HTML, use the `label` slot instead.",
1043
- "fieldName": "label"
1030
+ "attribute": "label"
1044
1031
  },
1045
1032
  {
1046
- "name": "help-text",
1033
+ "kind": "field",
1034
+ "name": "helpText",
1047
1035
  "type": {
1048
1036
  "text": "string"
1049
1037
  },
1050
1038
  "default": "''",
1051
1039
  "description": "The autocomplete's help text. If you need to display HTML, use the `help-text` slot instead.",
1052
- "fieldName": "helpText"
1040
+ "attribute": "help-text"
1053
1041
  },
1054
1042
  {
1043
+ "kind": "field",
1055
1044
  "name": "placeholder",
1056
1045
  "type": {
1057
1046
  "text": "string"
1058
1047
  },
1059
1048
  "default": "''",
1060
1049
  "description": "The autocomplete's placeholder text.",
1061
- "fieldName": "placeholder"
1050
+ "attribute": "placeholder"
1062
1051
  },
1063
1052
  {
1053
+ "kind": "field",
1064
1054
  "name": "disabled",
1065
1055
  "type": {
1066
1056
  "text": "boolean"
1067
1057
  },
1068
1058
  "default": "false",
1069
1059
  "description": "Disables the autocomplete.",
1070
- "fieldName": "disabled"
1060
+ "attribute": "disabled",
1061
+ "reflects": true
1071
1062
  },
1072
1063
  {
1064
+ "kind": "field",
1073
1065
  "name": "form",
1074
1066
  "type": {
1075
1067
  "text": "string"
1076
1068
  },
1077
1069
  "description": "The \"form owner\" to associate the autocomplete with. If omitted, the closest containing form will be used\ninstead. The value of this attribute must be an id of a form in the same document or shadow root as the\nautocomplete.",
1078
- "fieldName": "form"
1070
+ "attribute": "form"
1079
1071
  },
1080
1072
  {
1073
+ "kind": "field",
1081
1074
  "name": "required",
1082
1075
  "type": {
1083
1076
  "text": "boolean"
1084
1077
  },
1085
1078
  "default": "false",
1086
1079
  "description": "Makes the autocomplete a required field.",
1087
- "fieldName": "required"
1080
+ "attribute": "required",
1081
+ "reflects": true
1088
1082
  },
1089
1083
  {
1084
+ "kind": "field",
1090
1085
  "name": "inline",
1091
1086
  "type": {
1092
1087
  "text": "boolean"
1093
1088
  },
1094
1089
  "default": "false",
1095
1090
  "description": "Set to `true` to display the autocomplete in the inline form control style.",
1096
- "fieldName": "inline"
1091
+ "attribute": "inline",
1092
+ "reflects": true
1097
1093
  },
1098
1094
  {
1095
+ "kind": "field",
1099
1096
  "name": "divider",
1100
1097
  "type": {
1101
1098
  "text": "boolean"
1102
1099
  },
1103
1100
  "default": "false",
1104
1101
  "description": "Set to `true` to display a divider below the control.",
1105
- "fieldName": "divider"
1102
+ "attribute": "divider",
1103
+ "reflects": true
1106
1104
  },
1107
1105
  {
1106
+ "kind": "field",
1108
1107
  "name": "hoist",
1109
1108
  "type": {
1110
1109
  "text": "boolean"
1111
1110
  },
1112
1111
  "default": "false",
1113
1112
  "description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
1114
- "fieldName": "hoist"
1113
+ "attribute": "hoist"
1115
1114
  },
1116
1115
  {
1116
+ "kind": "field",
1117
1117
  "name": "placement",
1118
1118
  "type": {
1119
1119
  "text": "'top' | 'bottom'"
1120
1120
  },
1121
1121
  "default": "'bottom'",
1122
1122
  "description": "The preferred placement of the autocomplete's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
1123
- "fieldName": "placement"
1123
+ "attribute": "placement",
1124
+ "reflects": true
1124
1125
  },
1125
1126
  {
1127
+ "kind": "field",
1126
1128
  "name": "value",
1127
1129
  "type": {
1128
1130
  "text": "string"
1129
1131
  },
1130
1132
  "default": "''",
1131
1133
  "description": "The option value of the selected option.",
1132
- "fieldName": "value"
1134
+ "attribute": "value"
1133
1135
  },
1134
1136
  {
1137
+ "kind": "field",
1135
1138
  "name": "displayWith",
1136
1139
  "type": {
1137
1140
  "text": "((value: string) => string) | ((value: string) => Promise<string>)"
1138
1141
  },
1139
1142
  "description": "The function that returns the text to show in the input for a given `value`. It can return a promise. If not set,\nthe input shows the value itself.",
1140
- "fieldName": "displayWith"
1143
+ "attribute": "displayWith"
1141
1144
  },
1142
1145
  {
1143
- "name": "debounce-delay",
1146
+ "kind": "field",
1147
+ "name": "debounceDelay",
1144
1148
  "type": {
1145
1149
  "text": "number"
1146
1150
  },
1147
1151
  "default": "0",
1148
1152
  "description": "The delay in milliseconds between the user's last keystroke and the `flow-ui-input` event.",
1149
- "fieldName": "debounceDelay"
1153
+ "attribute": "debounce-delay",
1154
+ "reflects": true
1150
1155
  },
1151
1156
  {
1157
+ "kind": "field",
1152
1158
  "name": "clearable",
1153
1159
  "type": {
1154
1160
  "text": "boolean"
1155
1161
  },
1156
1162
  "default": "false",
1157
1163
  "description": "Set to `true` to show a clear button when the autocomplete has a value.",
1158
- "fieldName": "clearable"
1164
+ "attribute": "clearable",
1165
+ "reflects": true
1159
1166
  },
1160
1167
  {
1161
- "name": "clear-on-focus",
1168
+ "kind": "field",
1169
+ "name": "clearOnFocus",
1162
1170
  "type": {
1163
1171
  "text": "boolean"
1164
1172
  },
1165
1173
  "default": "false",
1166
1174
  "description": "Set to `true` to clear the value when the autocomplete gains focus.",
1167
- "fieldName": "clearOnFocus"
1168
- }
1169
- ],
1170
- "superclass": {
1171
- "name": "FlowRdfFormControl",
1172
- "module": "/src/internal/flow-ui-rdf-element"
1173
- },
1174
- "tagName": "flow-ui-autocomplete",
1175
- "summary": "Autocompletes allow users to type into a text input and choose a value from a list of suggested [options](./flow-ui-option).",
1176
- "dependencies": [
1177
- "flow-ui-divider",
1178
- "flow-ui-icon",
1179
- "flow-ui-popup"
1180
- ],
1181
- "customElement": true
1182
- }
1183
- ],
1184
- "exports": [
1185
- {
1186
- "kind": "js",
1187
- "name": "default",
1188
- "declaration": {
1189
- "name": "FlowUiAutocomplete",
1190
- "module": "components/autocomplete/autocomplete.component.js"
1191
- }
1192
- }
1193
- ]
1194
- },
1195
- {
1196
- "kind": "javascript-module",
1197
- "path": "components/autocomplete/autocomplete.js",
1198
- "declarations": [],
1199
- "exports": [
1200
- {
1201
- "kind": "js",
1202
- "name": "*",
1203
- "declaration": {
1204
- "name": "*",
1205
- "package": "./autocomplete.component"
1206
- }
1207
- },
1208
- {
1209
- "kind": "js",
1210
- "name": "default",
1211
- "declaration": {
1212
- "name": "FlowUiAutocomplete",
1213
- "module": "components/autocomplete/autocomplete.js"
1214
- }
1215
- }
1216
- ]
1217
- },
1218
- {
1219
- "kind": "javascript-module",
1220
- "path": "components/animation/animation.component.js",
1221
- "declarations": [
1222
- {
1223
- "kind": "class",
1224
- "description": "",
1225
- "name": "FlowUiAnimation",
1226
- "slots": [
1227
- {
1228
- "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.",
1229
- "name": ""
1230
- }
1231
- ],
1232
- "members": [
1175
+ "attribute": "clear-on-focus",
1176
+ "reflects": true
1177
+ },
1233
1178
  {
1234
1179
  "kind": "field",
1235
- "name": "tagName",
1180
+ "name": "inputText",
1236
1181
  "type": {
1237
1182
  "text": "string"
1238
1183
  },
1239
- "static": true,
1240
- "default": "'flow-ui-animation'"
1184
+ "privacy": "private",
1185
+ "default": "''",
1186
+ "description": "Current value displayed by the control; this can be what the user is typing or the label of the selected option"
1241
1187
  },
1242
1188
  {
1243
1189
  "kind": "field",
1244
- "name": "animation",
1190
+ "name": "selectedOption",
1245
1191
  "type": {
1246
- "text": "Animation | undefined"
1192
+ "text": "FlowOption | null"
1247
1193
  },
1248
- "privacy": "private"
1194
+ "privacy": "private",
1195
+ "default": "null"
1249
1196
  },
1250
1197
  {
1251
1198
  "kind": "field",
1252
- "name": "hasStarted",
1199
+ "name": "currentOption",
1253
1200
  "type": {
1254
- "text": "boolean"
1201
+ "text": "FlowOption | null"
1255
1202
  },
1256
1203
  "privacy": "private",
1257
- "default": "false"
1204
+ "default": "null"
1258
1205
  },
1259
1206
  {
1260
1207
  "kind": "field",
1261
- "name": "defaultSlot",
1208
+ "name": "input",
1262
1209
  "type": {
1263
- "text": "Promise<HTMLSlotElement>"
1210
+ "text": "HTMLInputElement"
1264
1211
  },
1265
1212
  "privacy": "private"
1266
1213
  },
1267
1214
  {
1268
1215
  "kind": "field",
1269
- "name": "name",
1270
- "type": {
1271
- "text": "string"
1272
- },
1273
- "default": "'none'",
1274
- "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.",
1275
- "attribute": "name"
1276
- },
1277
- {
1278
- "kind": "field",
1279
- "name": "play",
1280
- "type": {
1281
- "text": "boolean"
1282
- },
1283
- "default": "false",
1284
- "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
1285
- "attribute": "play",
1286
- "reflects": true
1287
- },
1288
- {
1289
- "kind": "field",
1290
- "name": "delay",
1291
- "type": {
1292
- "text": "number"
1293
- },
1294
- "default": "0",
1295
- "description": "The number of milliseconds to delay the start of the animation.",
1296
- "attribute": "delay"
1297
- },
1298
- {
1299
- "kind": "field",
1300
- "name": "direction",
1301
- "type": {
1302
- "text": "PlaybackDirection"
1303
- },
1304
- "default": "'normal'",
1305
- "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)",
1306
- "attribute": "direction"
1307
- },
1308
- {
1309
- "kind": "field",
1310
- "name": "duration",
1311
- "type": {
1312
- "text": "number"
1313
- },
1314
- "default": "1000",
1315
- "description": "The number of milliseconds each iteration of the animation takes to complete.",
1316
- "attribute": "duration"
1317
- },
1318
- {
1319
- "kind": "field",
1320
- "name": "easing",
1216
+ "name": "popup",
1321
1217
  "type": {
1322
- "text": "string"
1218
+ "text": "FlowPopup"
1323
1219
  },
1324
- "default": "'linear'",
1325
- "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)`.",
1326
- "attribute": "easing"
1220
+ "privacy": "private"
1327
1221
  },
1328
1222
  {
1329
1223
  "kind": "field",
1330
- "name": "endDelay",
1224
+ "name": "listbox",
1331
1225
  "type": {
1332
- "text": "number"
1226
+ "text": "HTMLElement"
1333
1227
  },
1334
- "default": "0",
1335
- "description": "The number of milliseconds to delay after the active period of an animation sequence.",
1336
- "attribute": "end-delay"
1228
+ "privacy": "private"
1337
1229
  },
1338
1230
  {
1339
- "kind": "field",
1340
- "name": "fill",
1341
- "type": {
1342
- "text": "FillMode"
1231
+ "kind": "method",
1232
+ "name": "getForm",
1233
+ "return": {
1234
+ "type": {
1235
+ "text": "HTMLFormElement | null"
1236
+ }
1343
1237
  },
1344
- "default": "'auto'",
1345
- "description": "Sets how the animation applies styles to its target before and after its execution.",
1346
- "attribute": "fill"
1347
- },
1348
- {
1349
- "kind": "field",
1350
- "name": "iterations",
1351
- "default": "Infinity",
1352
- "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
1353
- "attribute": "iterations"
1238
+ "description": "Gets the associated form, if one exists."
1354
1239
  },
1355
1240
  {
1356
1241
  "kind": "field",
1357
- "name": "iterationStart",
1358
- "type": {
1359
- "text": "number"
1360
- },
1361
- "default": "0",
1362
- "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
1363
- "attribute": "iteration-start"
1242
+ "name": "validity",
1243
+ "description": "Gets the validity state object.",
1244
+ "readonly": true
1364
1245
  },
1365
1246
  {
1366
1247
  "kind": "field",
1367
- "name": "keyframes",
1368
- "type": {
1369
- "text": "Keyframe[] | undefined"
1370
- },
1371
- "description": "The keyframes to use for the animation. If this is set, `name` will be ignored."
1248
+ "name": "validationMessage",
1249
+ "description": "Gets the validation message.",
1250
+ "readonly": true
1372
1251
  },
1373
1252
  {
1374
- "kind": "field",
1375
- "name": "playbackRate",
1376
- "type": {
1377
- "text": "number"
1253
+ "kind": "method",
1254
+ "name": "checkValidity",
1255
+ "return": {
1256
+ "type": {
1257
+ "text": "boolean"
1258
+ }
1378
1259
  },
1379
- "default": "1",
1380
- "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.",
1381
- "attribute": "playback-rate"
1260
+ "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid."
1382
1261
  },
1383
1262
  {
1384
- "kind": "field",
1385
- "name": "currentTime",
1386
- "type": {
1387
- "text": "CSSNumberish"
1263
+ "kind": "method",
1264
+ "name": "reportValidity",
1265
+ "return": {
1266
+ "type": {
1267
+ "text": "boolean"
1268
+ }
1388
1269
  },
1389
- "description": "Gets and sets the current animation time."
1270
+ "description": "Checks for validity and shows the browser's validation message if the control is invalid."
1390
1271
  },
1391
1272
  {
1392
- "kind": "field",
1393
- "name": "handleAnimationFinish",
1394
- "privacy": "private"
1273
+ "kind": "method",
1274
+ "name": "setCustomValidity",
1275
+ "parameters": [
1276
+ {
1277
+ "name": "_",
1278
+ "type": {
1279
+ "text": "string"
1280
+ }
1281
+ }
1282
+ ],
1283
+ "description": "Sets a custom validation message. Pass an empty string to restore validity."
1395
1284
  },
1396
1285
  {
1397
- "kind": "field",
1398
- "name": "handleAnimationCancel",
1399
- "privacy": "private"
1286
+ "kind": "method",
1287
+ "name": "handleClearClick",
1288
+ "parameters": [
1289
+ {
1290
+ "name": "event",
1291
+ "type": {
1292
+ "text": "MouseEvent"
1293
+ }
1294
+ }
1295
+ ]
1400
1296
  },
1401
1297
  {
1402
1298
  "kind": "method",
1403
- "name": "handleSlotChange",
1404
- "privacy": "private"
1299
+ "name": "focus",
1300
+ "description": "Focuses on the control"
1405
1301
  },
1406
1302
  {
1407
1303
  "kind": "method",
1408
- "name": "createAnimation",
1409
- "privacy": "private"
1304
+ "name": "blur",
1305
+ "description": "Blurs from the control."
1410
1306
  },
1411
1307
  {
1412
1308
  "kind": "method",
1413
- "name": "destroyAnimation",
1414
- "privacy": "private"
1309
+ "name": "show",
1310
+ "description": "Shows the listbox."
1415
1311
  },
1416
1312
  {
1417
1313
  "kind": "method",
1418
- "name": "cancel",
1419
- "description": "Clears all keyframe effects caused by this animation and aborts its playback."
1314
+ "name": "hide",
1315
+ "description": "Hides the listbox."
1420
1316
  },
1421
1317
  {
1422
1318
  "kind": "method",
1423
- "name": "finish",
1424
- "description": "Sets the playback time to the end of the animation corresponding to the current playback direction."
1319
+ "name": "getInputText",
1320
+ "description": "Gets the current value of the text input"
1425
1321
  }
1426
1322
  ],
1427
1323
  "events": [
1428
1324
  {
1429
- "description": "Emitted when the animation is canceled.",
1430
- "name": "flow-ui-cancel",
1431
- "reactName": "onFlowUiCancel"
1325
+ "description": "Emitted when the input text changes. When the user types, the event is emitted after the `debounce-delay`. Call `getInputText()` to read the text, for example to update the options.",
1326
+ "name": "flow-ui-input",
1327
+ "reactName": "onFlowUiInput"
1432
1328
  },
1433
1329
  {
1434
- "description": "Emitted when the animation finishes.",
1435
- "name": "flow-ui-finish",
1436
- "reactName": "onFlowUiFinish"
1330
+ "description": "Emitted when the autocomplete's value changes.",
1331
+ "name": "flow-ui-change",
1332
+ "reactName": "onFlowUiChange"
1437
1333
  },
1438
1334
  {
1439
- "description": "Emitted when the animation starts or restarts.",
1440
- "name": "flow-ui-start",
1441
- "reactName": "onFlowUiStart"
1335
+ "description": "Emitted when the autocomplete gains focus.",
1336
+ "name": "flow-ui-focus",
1337
+ "reactName": "onFlowUiFocus"
1338
+ },
1339
+ {
1340
+ "description": "Emitted when the autocomplete loses focus.",
1341
+ "name": "flow-ui-blur",
1342
+ "reactName": "onFlowUiBlur"
1343
+ },
1344
+ {
1345
+ "description": "Emitted when the listbox opens.",
1346
+ "name": "flow-ui-show",
1347
+ "reactName": "onFlowUiShow"
1348
+ },
1349
+ {
1350
+ "description": "Emitted after the listbox opens and all animations are complete.",
1351
+ "name": "flow-ui-after-show",
1352
+ "reactName": "onFlowUiAfterShow"
1353
+ },
1354
+ {
1355
+ "description": "Emitted when the listbox closes.",
1356
+ "name": "flow-ui-hide",
1357
+ "reactName": "onFlowUiHide"
1358
+ },
1359
+ {
1360
+ "description": "Emitted after the listbox closes and all animations are complete.",
1361
+ "name": "flow-ui-after-hide",
1362
+ "reactName": "onFlowUiAfterHide"
1442
1363
  }
1443
1364
  ],
1444
1365
  "attributes": [
1445
1366
  {
1446
- "name": "name",
1367
+ "name": "size",
1447
1368
  "type": {
1448
- "text": "string"
1369
+ "text": "'small' | 'medium' | 'large'"
1449
1370
  },
1450
- "default": "'none'",
1451
- "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.",
1452
- "fieldName": "name"
1371
+ "default": "'medium'",
1372
+ "description": "The autocomplete's size.",
1373
+ "fieldName": "size"
1453
1374
  },
1454
1375
  {
1455
- "name": "play",
1376
+ "name": "filled",
1456
1377
  "type": {
1457
1378
  "text": "boolean"
1458
1379
  },
1459
1380
  "default": "false",
1460
- "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
1461
- "fieldName": "play"
1381
+ "description": "Draws a filled autocomplete input.",
1382
+ "fieldName": "filled"
1462
1383
  },
1463
1384
  {
1464
- "name": "delay",
1385
+ "name": "pill",
1465
1386
  "type": {
1466
- "text": "number"
1387
+ "text": "boolean"
1467
1388
  },
1468
- "default": "0",
1469
- "description": "The number of milliseconds to delay the start of the animation.",
1470
- "fieldName": "delay"
1389
+ "default": "false",
1390
+ "description": "Draws a pill-style autocomplete input with rounded edges.",
1391
+ "fieldName": "pill"
1471
1392
  },
1472
1393
  {
1473
- "name": "direction",
1394
+ "name": "label",
1474
1395
  "type": {
1475
- "text": "PlaybackDirection"
1396
+ "text": "string"
1476
1397
  },
1477
- "default": "'normal'",
1478
- "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)",
1479
- "fieldName": "direction"
1398
+ "default": "''",
1399
+ "description": "The autocomplete's label. If you need to display HTML, use the `label` slot instead.",
1400
+ "fieldName": "label"
1480
1401
  },
1481
1402
  {
1482
- "name": "duration",
1403
+ "name": "help-text",
1483
1404
  "type": {
1484
- "text": "number"
1405
+ "text": "string"
1485
1406
  },
1486
- "default": "1000",
1487
- "description": "The number of milliseconds each iteration of the animation takes to complete.",
1488
- "fieldName": "duration"
1407
+ "default": "''",
1408
+ "description": "The autocomplete's help text. If you need to display HTML, use the `help-text` slot instead.",
1409
+ "fieldName": "helpText"
1489
1410
  },
1490
1411
  {
1491
- "name": "easing",
1412
+ "name": "placeholder",
1492
1413
  "type": {
1493
1414
  "text": "string"
1494
1415
  },
1495
- "default": "'linear'",
1496
- "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)`.",
1497
- "fieldName": "easing"
1416
+ "default": "''",
1417
+ "description": "The autocomplete's placeholder text.",
1418
+ "fieldName": "placeholder"
1498
1419
  },
1499
1420
  {
1500
- "name": "end-delay",
1421
+ "name": "disabled",
1501
1422
  "type": {
1502
- "text": "number"
1423
+ "text": "boolean"
1503
1424
  },
1504
- "default": "0",
1505
- "description": "The number of milliseconds to delay after the active period of an animation sequence.",
1506
- "fieldName": "endDelay"
1425
+ "default": "false",
1426
+ "description": "Disables the autocomplete.",
1427
+ "fieldName": "disabled"
1507
1428
  },
1508
1429
  {
1509
- "name": "fill",
1430
+ "name": "form",
1510
1431
  "type": {
1511
- "text": "FillMode"
1432
+ "text": "string"
1512
1433
  },
1513
- "default": "'auto'",
1514
- "description": "Sets how the animation applies styles to its target before and after its execution.",
1515
- "fieldName": "fill"
1434
+ "description": "The \"form owner\" to associate the autocomplete with. If omitted, the closest containing form will be used\ninstead. The value of this attribute must be an id of a form in the same document or shadow root as the\nautocomplete.",
1435
+ "fieldName": "form"
1516
1436
  },
1517
1437
  {
1518
- "name": "iterations",
1519
- "default": "Infinity",
1520
- "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
1521
- "resolveInitializer": {
1522
- "module": "src/components/animation/animation.component.ts"
1438
+ "name": "required",
1439
+ "type": {
1440
+ "text": "boolean"
1523
1441
  },
1524
- "fieldName": "iterations"
1442
+ "default": "false",
1443
+ "description": "Makes the autocomplete a required field.",
1444
+ "fieldName": "required"
1525
1445
  },
1526
1446
  {
1527
- "name": "iteration-start",
1447
+ "name": "inline",
1448
+ "type": {
1449
+ "text": "boolean"
1450
+ },
1451
+ "default": "false",
1452
+ "description": "Set to `true` to display the autocomplete in the inline form control style.",
1453
+ "fieldName": "inline"
1454
+ },
1455
+ {
1456
+ "name": "divider",
1457
+ "type": {
1458
+ "text": "boolean"
1459
+ },
1460
+ "default": "false",
1461
+ "description": "Set to `true` to display a divider below the control.",
1462
+ "fieldName": "divider"
1463
+ },
1464
+ {
1465
+ "name": "hoist",
1466
+ "type": {
1467
+ "text": "boolean"
1468
+ },
1469
+ "default": "false",
1470
+ "description": "Enable this option to prevent the listbox from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`. Hoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
1471
+ "fieldName": "hoist"
1472
+ },
1473
+ {
1474
+ "name": "placement",
1475
+ "type": {
1476
+ "text": "'top' | 'bottom'"
1477
+ },
1478
+ "default": "'bottom'",
1479
+ "description": "The preferred placement of the autocomplete's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
1480
+ "fieldName": "placement"
1481
+ },
1482
+ {
1483
+ "name": "value",
1484
+ "type": {
1485
+ "text": "string"
1486
+ },
1487
+ "default": "''",
1488
+ "description": "The option value of the selected option.",
1489
+ "fieldName": "value"
1490
+ },
1491
+ {
1492
+ "name": "displayWith",
1493
+ "type": {
1494
+ "text": "((value: string) => string) | ((value: string) => Promise<string>)"
1495
+ },
1496
+ "description": "The function that returns the text to show in the input for a given `value`. It can return a promise. If not set,\nthe input shows the value itself.",
1497
+ "fieldName": "displayWith"
1498
+ },
1499
+ {
1500
+ "name": "debounce-delay",
1528
1501
  "type": {
1529
1502
  "text": "number"
1530
1503
  },
1531
1504
  "default": "0",
1532
- "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
1533
- "fieldName": "iterationStart"
1505
+ "description": "The delay in milliseconds between the user's last keystroke and the `flow-ui-input` event.",
1506
+ "fieldName": "debounceDelay"
1534
1507
  },
1535
1508
  {
1536
- "name": "playback-rate",
1509
+ "name": "clearable",
1537
1510
  "type": {
1538
- "text": "number"
1511
+ "text": "boolean"
1539
1512
  },
1540
- "default": "1",
1541
- "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.",
1542
- "fieldName": "playbackRate"
1513
+ "default": "false",
1514
+ "description": "Set to `true` to show a clear button when the autocomplete has a value.",
1515
+ "fieldName": "clearable"
1516
+ },
1517
+ {
1518
+ "name": "clear-on-focus",
1519
+ "type": {
1520
+ "text": "boolean"
1521
+ },
1522
+ "default": "false",
1523
+ "description": "Set to `true` to clear the value when the autocomplete gains focus.",
1524
+ "fieldName": "clearOnFocus"
1543
1525
  }
1544
1526
  ],
1545
1527
  "superclass": {
1546
- "name": "FlowRdfElement",
1528
+ "name": "FlowRdfFormControl",
1547
1529
  "module": "/src/internal/flow-ui-rdf-element"
1548
1530
  },
1549
- "tagName": "flow-ui-animation",
1550
- "summary": "Animate elements declaratively with over 100 animation presets. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).",
1531
+ "tagName": "flow-ui-autocomplete",
1532
+ "summary": "Autocompletes allow users to type into a text input and choose a value from a list of suggested [options](./flow-ui-option).",
1533
+ "dependencies": [
1534
+ "flow-ui-divider",
1535
+ "flow-ui-icon",
1536
+ "flow-ui-popup"
1537
+ ],
1551
1538
  "customElement": true
1552
1539
  }
1553
1540
  ],
@@ -1556,15 +1543,15 @@
1556
1543
  "kind": "js",
1557
1544
  "name": "default",
1558
1545
  "declaration": {
1559
- "name": "FlowUiAnimation",
1560
- "module": "components/animation/animation.component.js"
1546
+ "name": "FlowUiAutocomplete",
1547
+ "module": "components/autocomplete/autocomplete.component.js"
1561
1548
  }
1562
1549
  }
1563
1550
  ]
1564
1551
  },
1565
1552
  {
1566
1553
  "kind": "javascript-module",
1567
- "path": "components/animation/animation.js",
1554
+ "path": "components/autocomplete/autocomplete.js",
1568
1555
  "declarations": [],
1569
1556
  "exports": [
1570
1557
  {
@@ -1572,57 +1559,15 @@
1572
1559
  "name": "*",
1573
1560
  "declaration": {
1574
1561
  "name": "*",
1575
- "package": "./animation.component"
1562
+ "package": "./autocomplete.component"
1576
1563
  }
1577
1564
  },
1578
1565
  {
1579
1566
  "kind": "js",
1580
1567
  "name": "default",
1581
1568
  "declaration": {
1582
- "name": "FlowUiAnimation",
1583
- "module": "components/animation/animation.js"
1584
- }
1585
- }
1586
- ]
1587
- },
1588
- {
1589
- "kind": "javascript-module",
1590
- "path": "components/animation/animations.js",
1591
- "declarations": [
1592
- {
1593
- "kind": "function",
1594
- "name": "getAnimationNames",
1595
- "description": "Returns a list of all supported animation names.\n\nSupply the required animation as the `name` property of the\n`<flow-ui-animation>` component."
1596
- },
1597
- {
1598
- "kind": "function",
1599
- "name": "getEasingNames",
1600
- "description": "Returns a list of all supported easing method names.\n\nSupply the required easing method as the `easing` property of the\n`<flow-ui-animation>` component."
1601
- }
1602
- ],
1603
- "exports": [
1604
- {
1605
- "kind": "js",
1606
- "name": "animations",
1607
- "declaration": {
1608
- "name": "animations",
1609
- "module": "components/animation/animations.js"
1610
- }
1611
- },
1612
- {
1613
- "kind": "js",
1614
- "name": "getAnimationNames",
1615
- "declaration": {
1616
- "name": "getAnimationNames",
1617
- "module": "components/animation/animations.js"
1618
- }
1619
- },
1620
- {
1621
- "kind": "js",
1622
- "name": "getEasingNames",
1623
- "declaration": {
1624
- "name": "getEasingNames",
1625
- "module": "components/animation/animations.js"
1569
+ "name": "FlowUiAutocomplete",
1570
+ "module": "components/autocomplete/autocomplete.js"
1626
1571
  }
1627
1572
  }
1628
1573
  ]
@@ -1993,80 +1938,291 @@
1993
1938
  "fieldName": "pill"
1994
1939
  },
1995
1940
  {
1996
- "name": "label",
1941
+ "name": "label",
1942
+ "type": {
1943
+ "text": "string"
1944
+ },
1945
+ "default": "''",
1946
+ "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
1947
+ "fieldName": "label"
1948
+ },
1949
+ {
1950
+ "name": "help-text",
1951
+ "type": {
1952
+ "text": "string"
1953
+ },
1954
+ "default": "''",
1955
+ "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
1956
+ "fieldName": "helpText"
1957
+ },
1958
+ {
1959
+ "name": "disabled",
1960
+ "type": {
1961
+ "text": "boolean"
1962
+ },
1963
+ "default": "false",
1964
+ "description": "Disables the input.",
1965
+ "fieldName": "disabled"
1966
+ },
1967
+ {
1968
+ "name": "form",
1969
+ "type": {
1970
+ "text": "string"
1971
+ },
1972
+ "default": "''",
1973
+ "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.",
1974
+ "fieldName": "form"
1975
+ },
1976
+ {
1977
+ "name": "required",
1978
+ "type": {
1979
+ "text": "boolean"
1980
+ },
1981
+ "default": "false",
1982
+ "description": "Makes the input a required field.",
1983
+ "fieldName": "required"
1984
+ },
1985
+ {
1986
+ "name": "inline",
1987
+ "type": {
1988
+ "text": "boolean"
1989
+ },
1990
+ "default": "false",
1991
+ "description": "Display the input in the 'inline' form control style.",
1992
+ "fieldName": "inline"
1993
+ },
1994
+ {
1995
+ "name": "divider",
1996
+ "type": {
1997
+ "text": "boolean"
1998
+ },
1999
+ "default": "false",
2000
+ "description": "Indicates that the control should display a divider",
2001
+ "fieldName": "divider"
2002
+ }
2003
+ ],
2004
+ "superclass": {
2005
+ "name": "FlowRdfFormControl",
2006
+ "module": "/src/internal/flow-ui-rdf-element"
2007
+ },
2008
+ "tagName": "flow-ui-base-control",
2009
+ "summary": "Inputs collect data from the user.",
2010
+ "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input",
2011
+ "status": "stable",
2012
+ "since": "2.0",
2013
+ "dependencies": [
2014
+ "flow-ui-divider"
2015
+ ],
2016
+ "customElement": true
2017
+ }
2018
+ ],
2019
+ "exports": [
2020
+ {
2021
+ "kind": "js",
2022
+ "name": "default",
2023
+ "declaration": {
2024
+ "name": "FlowUiBaseControl",
2025
+ "module": "components/base-control/base-control.component.js"
2026
+ }
2027
+ }
2028
+ ]
2029
+ },
2030
+ {
2031
+ "kind": "javascript-module",
2032
+ "path": "components/base-control/base-control.js",
2033
+ "declarations": [],
2034
+ "exports": [
2035
+ {
2036
+ "kind": "js",
2037
+ "name": "*",
2038
+ "declaration": {
2039
+ "name": "*",
2040
+ "package": "./base-control.component"
2041
+ }
2042
+ },
2043
+ {
2044
+ "kind": "js",
2045
+ "name": "default",
2046
+ "declaration": {
2047
+ "name": "FlowUiBaseControl",
2048
+ "module": "components/base-control/base-control.js"
2049
+ }
2050
+ }
2051
+ ]
2052
+ },
2053
+ {
2054
+ "kind": "javascript-module",
2055
+ "path": "components/avatar/avatar.component.js",
2056
+ "declarations": [
2057
+ {
2058
+ "kind": "class",
2059
+ "description": "",
2060
+ "name": "FlowUiAvatar",
2061
+ "cssProperties": [
2062
+ {
2063
+ "description": "The size of the avatar.",
2064
+ "name": "--size"
2065
+ }
2066
+ ],
2067
+ "cssParts": [
2068
+ {
2069
+ "description": "The component's base wrapper.",
2070
+ "name": "base"
2071
+ },
2072
+ {
2073
+ "description": "The container that wraps the avatar's icon.",
2074
+ "name": "icon"
2075
+ },
2076
+ {
2077
+ "description": "The container that wraps the avatar's initials.",
2078
+ "name": "initials"
2079
+ },
2080
+ {
2081
+ "description": "The avatar image. Only shown when the `image` attribute is set.",
2082
+ "name": "image"
2083
+ }
2084
+ ],
2085
+ "slots": [
2086
+ {
2087
+ "description": "The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.",
2088
+ "name": "icon"
2089
+ }
2090
+ ],
2091
+ "members": [
2092
+ {
2093
+ "kind": "field",
2094
+ "name": "tagName",
2095
+ "type": {
2096
+ "text": "string"
2097
+ },
2098
+ "static": true,
2099
+ "default": "'flow-ui-avatar'"
2100
+ },
2101
+ {
2102
+ "kind": "field",
2103
+ "name": "dependencies",
2104
+ "type": {
2105
+ "text": "array"
2106
+ },
2107
+ "static": true,
2108
+ "default": "[FlowUiIcon]"
2109
+ },
2110
+ {
2111
+ "kind": "field",
2112
+ "name": "hasError",
2113
+ "type": {
2114
+ "text": "boolean"
2115
+ },
2116
+ "privacy": "private",
2117
+ "default": "false"
2118
+ },
2119
+ {
2120
+ "kind": "field",
2121
+ "name": "image",
2122
+ "type": {
2123
+ "text": "string"
2124
+ },
2125
+ "default": "''",
2126
+ "description": "The image source to use for the avatar.",
2127
+ "attribute": "image"
2128
+ },
2129
+ {
2130
+ "kind": "field",
2131
+ "name": "label",
2132
+ "type": {
2133
+ "text": "string"
2134
+ },
2135
+ "default": "''",
2136
+ "description": "A label to use to describe the avatar to assistive devices.",
2137
+ "attribute": "label"
2138
+ },
2139
+ {
2140
+ "kind": "field",
2141
+ "name": "initials",
1997
2142
  "type": {
1998
2143
  "text": "string"
1999
2144
  },
2000
2145
  "default": "''",
2001
- "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
2002
- "fieldName": "label"
2146
+ "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
2147
+ "attribute": "initials"
2003
2148
  },
2004
2149
  {
2005
- "name": "help-text",
2150
+ "kind": "field",
2151
+ "name": "loading",
2006
2152
  "type": {
2007
- "text": "string"
2153
+ "text": "'eager' | 'lazy'"
2008
2154
  },
2009
- "default": "''",
2010
- "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
2011
- "fieldName": "helpText"
2155
+ "default": "'eager'",
2156
+ "description": "Indicates how the browser should load the image.",
2157
+ "attribute": "loading"
2012
2158
  },
2013
2159
  {
2014
- "name": "disabled",
2160
+ "kind": "field",
2161
+ "name": "shape",
2015
2162
  "type": {
2016
- "text": "boolean"
2163
+ "text": "'circle' | 'square' | 'rounded'"
2017
2164
  },
2018
- "default": "false",
2019
- "description": "Disables the input.",
2020
- "fieldName": "disabled"
2165
+ "default": "'circle'",
2166
+ "description": "The shape of the avatar.",
2167
+ "attribute": "shape",
2168
+ "reflects": true
2169
+ }
2170
+ ],
2171
+ "attributes": [
2172
+ {
2173
+ "name": "image",
2174
+ "type": {
2175
+ "text": "string"
2176
+ },
2177
+ "default": "''",
2178
+ "description": "The image source to use for the avatar.",
2179
+ "fieldName": "image"
2021
2180
  },
2022
2181
  {
2023
- "name": "form",
2182
+ "name": "label",
2024
2183
  "type": {
2025
2184
  "text": "string"
2026
2185
  },
2027
2186
  "default": "''",
2028
- "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.",
2029
- "fieldName": "form"
2187
+ "description": "A label to use to describe the avatar to assistive devices.",
2188
+ "fieldName": "label"
2030
2189
  },
2031
2190
  {
2032
- "name": "required",
2191
+ "name": "initials",
2033
2192
  "type": {
2034
- "text": "boolean"
2193
+ "text": "string"
2035
2194
  },
2036
- "default": "false",
2037
- "description": "Makes the input a required field.",
2038
- "fieldName": "required"
2195
+ "default": "''",
2196
+ "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
2197
+ "fieldName": "initials"
2039
2198
  },
2040
2199
  {
2041
- "name": "inline",
2200
+ "name": "loading",
2042
2201
  "type": {
2043
- "text": "boolean"
2202
+ "text": "'eager' | 'lazy'"
2044
2203
  },
2045
- "default": "false",
2046
- "description": "Display the input in the 'inline' form control style.",
2047
- "fieldName": "inline"
2204
+ "default": "'eager'",
2205
+ "description": "Indicates how the browser should load the image.",
2206
+ "fieldName": "loading"
2048
2207
  },
2049
2208
  {
2050
- "name": "divider",
2209
+ "name": "shape",
2051
2210
  "type": {
2052
- "text": "boolean"
2211
+ "text": "'circle' | 'square' | 'rounded'"
2053
2212
  },
2054
- "default": "false",
2055
- "description": "Indicates that the control should display a divider",
2056
- "fieldName": "divider"
2213
+ "default": "'circle'",
2214
+ "description": "The shape of the avatar.",
2215
+ "fieldName": "shape"
2057
2216
  }
2058
2217
  ],
2059
2218
  "superclass": {
2060
- "name": "FlowRdfFormControl",
2219
+ "name": "FlowRdfElement",
2061
2220
  "module": "/src/internal/flow-ui-rdf-element"
2062
2221
  },
2063
- "tagName": "flow-ui-base-control",
2064
- "summary": "Inputs collect data from the user.",
2065
- "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input",
2066
- "status": "stable",
2067
- "since": "2.0",
2222
+ "tagName": "flow-ui-avatar",
2223
+ "summary": "Avatars are used to represent a person or object.",
2068
2224
  "dependencies": [
2069
- "flow-ui-divider"
2225
+ "flow-ui-icon"
2070
2226
  ],
2071
2227
  "customElement": true
2072
2228
  }
@@ -2076,31 +2232,23 @@
2076
2232
  "kind": "js",
2077
2233
  "name": "default",
2078
2234
  "declaration": {
2079
- "name": "FlowUiBaseControl",
2080
- "module": "components/base-control/base-control.component.js"
2235
+ "name": "FlowUiAvatar",
2236
+ "module": "components/avatar/avatar.component.js"
2081
2237
  }
2082
2238
  }
2083
2239
  ]
2084
2240
  },
2085
2241
  {
2086
2242
  "kind": "javascript-module",
2087
- "path": "components/base-control/base-control.js",
2243
+ "path": "components/avatar/avatar.js",
2088
2244
  "declarations": [],
2089
2245
  "exports": [
2090
- {
2091
- "kind": "js",
2092
- "name": "*",
2093
- "declaration": {
2094
- "name": "*",
2095
- "package": "./base-control.component"
2096
- }
2097
- },
2098
2246
  {
2099
2247
  "kind": "js",
2100
2248
  "name": "default",
2101
2249
  "declaration": {
2102
- "name": "FlowUiBaseControl",
2103
- "module": "components/base-control/base-control.js"
2250
+ "name": "FlowUiAvatar",
2251
+ "module": "components/avatar/avatar.js"
2104
2252
  }
2105
2253
  }
2106
2254
  ]
@@ -2373,156 +2521,8 @@
2373
2521
  "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
2374
2522
  "docgroup": "breadcrumb",
2375
2523
  "dependencies": [
2376
- "flow-ui-icon"
2377
- ],
2378
- "customElement": true
2379
- }
2380
- ],
2381
- "exports": [
2382
- {
2383
- "kind": "js",
2384
- "name": "default",
2385
- "declaration": {
2386
- "name": "FlowUiBreadcrumb",
2387
- "module": "components/breadcrumb/breadcrumb.component.js"
2388
- }
2389
- }
2390
- ]
2391
- },
2392
- {
2393
- "kind": "javascript-module",
2394
- "path": "components/breadcrumb/breadcrumb.js",
2395
- "declarations": [],
2396
- "exports": [
2397
- {
2398
- "kind": "js",
2399
- "name": "default",
2400
- "declaration": {
2401
- "name": "FlowUiBreadcrumb",
2402
- "module": "components/breadcrumb/breadcrumb.js"
2403
- }
2404
- }
2405
- ]
2406
- },
2407
- {
2408
- "kind": "javascript-module",
2409
- "path": "components/badge/badge.component.js",
2410
- "declarations": [
2411
- {
2412
- "kind": "class",
2413
- "description": "",
2414
- "name": "FlowUiBadge",
2415
- "cssParts": [
2416
- {
2417
- "description": "The component's base wrapper.",
2418
- "name": "base"
2419
- }
2420
- ],
2421
- "slots": [
2422
- {
2423
- "description": "The badge's content.",
2424
- "name": ""
2425
- }
2426
- ],
2427
- "members": [
2428
- {
2429
- "kind": "field",
2430
- "name": "tagName",
2431
- "type": {
2432
- "text": "string"
2433
- },
2434
- "static": true,
2435
- "default": "'flow-ui-badge'"
2436
- },
2437
- {
2438
- "kind": "field",
2439
- "name": "variant",
2440
- "type": {
2441
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2442
- },
2443
- "default": "'primary'",
2444
- "description": "The badge's theme variant.",
2445
- "attribute": "variant",
2446
- "reflects": true
2447
- },
2448
- {
2449
- "kind": "field",
2450
- "name": "size",
2451
- "type": {
2452
- "text": "'small' | 'medium' | 'large'"
2453
- },
2454
- "default": "'medium'",
2455
- "description": "The badge size.",
2456
- "attribute": "size",
2457
- "reflects": true
2458
- },
2459
- {
2460
- "kind": "field",
2461
- "name": "pill",
2462
- "type": {
2463
- "text": "boolean"
2464
- },
2465
- "default": "false",
2466
- "description": "Draws a pill-style badge with rounded edges.",
2467
- "attribute": "pill",
2468
- "reflects": true
2469
- },
2470
- {
2471
- "kind": "field",
2472
- "name": "pulse",
2473
- "type": {
2474
- "text": "boolean"
2475
- },
2476
- "default": "false",
2477
- "description": "Makes the badge pulsate to draw attention.",
2478
- "attribute": "pulse",
2479
- "reflects": true
2480
- }
2481
- ],
2482
- "attributes": [
2483
- {
2484
- "name": "variant",
2485
- "type": {
2486
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2487
- },
2488
- "default": "'primary'",
2489
- "description": "The badge's theme variant.",
2490
- "fieldName": "variant"
2491
- },
2492
- {
2493
- "name": "size",
2494
- "type": {
2495
- "text": "'small' | 'medium' | 'large'"
2496
- },
2497
- "default": "'medium'",
2498
- "description": "The badge size.",
2499
- "fieldName": "size"
2500
- },
2501
- {
2502
- "name": "pill",
2503
- "type": {
2504
- "text": "boolean"
2505
- },
2506
- "default": "false",
2507
- "description": "Draws a pill-style badge with rounded edges.",
2508
- "fieldName": "pill"
2509
- },
2510
- {
2511
- "name": "pulse",
2512
- "type": {
2513
- "text": "boolean"
2514
- },
2515
- "default": "false",
2516
- "description": "Makes the badge pulsate to draw attention.",
2517
- "fieldName": "pulse"
2518
- }
2519
- ],
2520
- "superclass": {
2521
- "name": "FlowRdfElement",
2522
- "module": "/src/internal/flow-ui-rdf-element"
2523
- },
2524
- "tagName": "flow-ui-badge",
2525
- "summary": "Badges are used to draw attention and display statuses or counts.",
2524
+ "flow-ui-icon"
2525
+ ],
2526
2526
  "customElement": true
2527
2527
  }
2528
2528
  ],
@@ -2531,23 +2531,23 @@
2531
2531
  "kind": "js",
2532
2532
  "name": "default",
2533
2533
  "declaration": {
2534
- "name": "FlowUiBadge",
2535
- "module": "components/badge/badge.component.js"
2534
+ "name": "FlowUiBreadcrumb",
2535
+ "module": "components/breadcrumb/breadcrumb.component.js"
2536
2536
  }
2537
2537
  }
2538
2538
  ]
2539
2539
  },
2540
2540
  {
2541
2541
  "kind": "javascript-module",
2542
- "path": "components/badge/badge.js",
2542
+ "path": "components/breadcrumb/breadcrumb.js",
2543
2543
  "declarations": [],
2544
2544
  "exports": [
2545
2545
  {
2546
2546
  "kind": "js",
2547
2547
  "name": "default",
2548
2548
  "declaration": {
2549
- "name": "FlowUiBadge",
2550
- "module": "components/badge/badge.js"
2549
+ "name": "FlowUiBreadcrumb",
2550
+ "module": "components/breadcrumb/breadcrumb.js"
2551
2551
  }
2552
2552
  }
2553
2553
  ]
@@ -31563,230 +31563,769 @@
31563
31563
  "declarations": [
31564
31564
  {
31565
31565
  "kind": "class",
31566
- "description": "",
31566
+ "description": "The tree component shows a hierarchy of nodes that users can expand, collapse and select. Give it the nodes as data,\nin `nodes`, or write them as [tree item](./flow-ui-tree-item) markup, which the tree reads while `nodes` is not set.\nThe tree renders only the rows in view, so it stays fast with tens of thousands of nodes.\n\nWithout a height, the tree is as tall as its rows, and renders the ones in view of the elements that clip it, such as\na scrollable `flow-ui-panel`. Given a height or a max-height, it scrolls its rows itself.\n\nThe tree's width comes from its container: it fills a block container, and its labels end in an ellipsis when they\ndo not fit. Where the container sizes to its content, such as a flex row, the tree is `--default-width` wide, whatever\nits labels.\n\n`selection-mode` sets how nodes are selected:\n\n- `multiple` (the default): checkboxes. `value` holds the selected leaves, and a parent selects or deselects its\n leaves. A parent's check state is derived from its leaves.\n- `single`: one node, parent or leaf.\n- `leaf`: one leaf. A click on a parent expands or collapses it.\n- `none`: no selection. A click expands or collapses a parent, as in a navigation tree.\n\nBind `value` to application state like any form control: the tree emits `flow-ui-change` when the user changes the\nselection.",
31567
31567
  "name": "FlowUiTree",
31568
31568
  "cssProperties": [
31569
31569
  {
31570
- "description": "The size of the indentation for nested items.",
31571
- "name": "--indent-size",
31572
- "default": "var(--flow-ui-spacing-medium)"
31573
- },
31574
- {
31575
- "description": "The color of the indentation line.",
31576
- "name": "--indent-guide-color",
31577
- "default": "var(--flow-ui-color-neutral-200)"
31570
+ "description": "The tree's width where its container sizes to its content, such as a flex row or an inline block. It does not depend on the tree's nodes.",
31571
+ "name": "--default-width",
31572
+ "default": "15rem"
31578
31573
  },
31579
31574
  {
31580
- "description": "The amount of vertical spacing to leave between the top and bottom of the indentation line's starting position.",
31581
- "name": "--indent-guide-offset",
31582
- "default": "0"
31575
+ "description": "The indentation of each level. Defaults to `--flow-ui-spacing-medium` when `size` is `small`.",
31576
+ "name": "--indent-size",
31577
+ "default": "var(--flow-ui-spacing-large)"
31583
31578
  },
31584
31579
  {
31585
- "description": "The style of the indentation line, e.g. solid, dotted, dashed.",
31586
- "name": "--indent-guide-style",
31587
- "default": "solid"
31580
+ "description": "The background color of the selected row in single and leaf selection.",
31581
+ "name": "--selected-background-color",
31582
+ "default": "var(--flow-ui-color-neutral-100)"
31588
31583
  },
31589
31584
  {
31590
- "description": "The width of the indentation line.",
31591
- "name": "--indent-guide-width",
31592
- "default": "0"
31585
+ "description": "The color of the selected row's marker, at its start, in single and leaf selection.",
31586
+ "name": "--selected-marker-color",
31587
+ "default": "var(--flow-ui-color-primary-500)"
31593
31588
  }
31594
31589
  ],
31595
31590
  "cssParts": [
31596
31591
  {
31597
- "description": "The component's base wrapper.",
31592
+ "description": "The component's base wrapper (`role=\"tree\"`).",
31598
31593
  "name": "base"
31594
+ },
31595
+ {
31596
+ "description": "Each rendered row (`role=\"treeitem\"`).",
31597
+ "name": "row"
31598
+ },
31599
+ {
31600
+ "description": "The row's label.",
31601
+ "name": "label"
31599
31602
  }
31600
31603
  ],
31601
31604
  "slots": [
31602
31605
  {
31603
- "description": "The default slot.",
31606
+ "description": "The tree's [tree items](./flow-ui-tree-item), read as its nodes while `nodes` is not set.",
31604
31607
  "name": ""
31605
31608
  },
31606
31609
  {
31607
- "description": "The icon to show when the tree item is expanded. Works best with `<flow-ui-icon>`.",
31608
- "name": "expand-icon"
31610
+ "description": "With `row-slots`, each rendered row has a slot named after its node ID, for content at the end of the row. The slot exists only while the row is rendered: listen to `flow-ui-visible-change`.",
31611
+ "name": "<node-id>"
31612
+ }
31613
+ ],
31614
+ "members": [
31615
+ {
31616
+ "kind": "field",
31617
+ "name": "tagName",
31618
+ "type": {
31619
+ "text": "string"
31620
+ },
31621
+ "static": true,
31622
+ "default": "'flow-ui-tree'"
31623
+ },
31624
+ {
31625
+ "kind": "field",
31626
+ "name": "dependencies",
31627
+ "type": {
31628
+ "text": "array"
31629
+ },
31630
+ "static": true,
31631
+ "default": "[FlowUiCheckbox, FlowUiIcon, FlowUiProgressRing]"
31632
+ },
31633
+ {
31634
+ "kind": "field",
31635
+ "name": "nodes",
31636
+ "type": {
31637
+ "text": "FlowTreeNode[]"
31638
+ },
31639
+ "description": "The tree's nodes. See [FlowTreeNode](../public-api/interfaces/FlowTreeNode). Replace the array to update the\ntree: the tree does not see changes made inside it. If not set, the tree reads its nodes from its\n`flow-ui-tree-item` elements. Note that once you set it, the tree ignores its tree items."
31640
+ },
31641
+ {
31642
+ "kind": "field",
31643
+ "name": "_nodes",
31644
+ "type": {
31645
+ "text": "FlowTreeNode[]"
31646
+ },
31647
+ "privacy": "private",
31648
+ "default": "[]"
31649
+ },
31650
+ {
31651
+ "kind": "field",
31652
+ "name": "settingItemNodes",
31653
+ "type": {
31654
+ "text": "boolean"
31655
+ },
31656
+ "privacy": "private",
31657
+ "default": "false"
31658
+ },
31659
+ {
31660
+ "kind": "field",
31661
+ "name": "value",
31662
+ "type": {
31663
+ "text": "string[]"
31664
+ },
31665
+ "default": "[]",
31666
+ "description": "The selected node IDs, or tree item values. In multiple selection, these are the selected leaves: a parent ID set\nhere selects the parent's leaves. In single and leaf selection, it holds the one selected node. The attribute is\na space-separated list, so IDs used in it must not contain spaces. Note that tree items without a `value` can be\nselected but never appear here.",
31667
+ "attribute": "value"
31668
+ },
31669
+ {
31670
+ "kind": "field",
31671
+ "name": "expandedIds",
31672
+ "type": {
31673
+ "text": "string[]"
31674
+ },
31675
+ "default": "[]",
31676
+ "description": "The IDs of the expanded nodes. The tree updates it when the user expands or collapses a node."
31677
+ },
31678
+ {
31679
+ "kind": "field",
31680
+ "name": "selectionMode",
31681
+ "type": {
31682
+ "text": "FlowTreeSelectionMode"
31683
+ },
31684
+ "default": "'multiple'",
31685
+ "description": "The selection mode. See [FlowTreeSelectionMode](../public-api/type-aliases/FlowTreeSelectionMode).",
31686
+ "attribute": "selection-mode"
31687
+ },
31688
+ {
31689
+ "kind": "field",
31690
+ "name": "filter",
31691
+ "type": {
31692
+ "text": "string"
31693
+ },
31694
+ "default": "''",
31695
+ "description": "The text to filter by. The tree shows only the leaves whose label contains it (ignoring case), with their\nancestors, expanded. If not set, every node is shown.",
31696
+ "attribute": "filter"
31697
+ },
31698
+ {
31699
+ "kind": "field",
31700
+ "name": "filterFn",
31701
+ "type": {
31702
+ "text": "(node: FlowTreeNode, filter: string) => boolean | undefined"
31703
+ },
31704
+ "description": "The filter function, which replaces the label match of `filter`. Return `true` to show the leaf. Note that it is\ncalled only while `filter` is not empty."
31705
+ },
31706
+ {
31707
+ "kind": "field",
31708
+ "name": "rowHeight",
31709
+ "type": {
31710
+ "text": "number | undefined"
31711
+ },
31712
+ "description": "The height of every row, in pixels. If not set, it is 24, 28 or 36 pixels for the small, medium and large sizes.",
31713
+ "attribute": "row-height"
31714
+ },
31715
+ {
31716
+ "kind": "field",
31717
+ "name": "overscan",
31718
+ "type": {
31719
+ "text": "number"
31720
+ },
31721
+ "default": "10",
31722
+ "description": "The number of rows rendered above and below the rows in view.",
31723
+ "attribute": "overscan"
31724
+ },
31725
+ {
31726
+ "kind": "field",
31727
+ "name": "size",
31728
+ "type": {
31729
+ "text": "'small' | 'medium' | 'large'"
31730
+ },
31731
+ "default": "'medium'",
31732
+ "description": "The tree's size. It sets the font size, the indentation and the default `rowHeight`.",
31733
+ "attribute": "size",
31734
+ "reflects": true
31735
+ },
31736
+ {
31737
+ "kind": "field",
31738
+ "name": "rowSlots",
31739
+ "type": {
31740
+ "text": "boolean"
31741
+ },
31742
+ "default": "false",
31743
+ "description": "Set to `true` to render a `<slot name=\"<node id>\">` at the end of each rendered row, for content you supply. See\n`flow-ui-visible-change`.",
31744
+ "attribute": "row-slots"
31745
+ },
31746
+ {
31747
+ "kind": "field",
31748
+ "name": "renderRowEnd",
31749
+ "type": {
31750
+ "text": "(\n node: FlowTreeNode,\n row: FlowTreeRow\n ) => TemplateResult | typeof nothing | undefined"
31751
+ },
31752
+ "description": "The function that renders content at the end of each rendered row, as a Lit template. Return `nothing` to leave a\nrow's end empty. Note that clicks on the content do not select the row. Alternatively, use `row-slots`."
31753
+ },
31754
+ {
31755
+ "kind": "field",
31756
+ "name": "visibleTop",
31757
+ "type": {
31758
+ "text": "number"
31759
+ },
31760
+ "privacy": "private",
31761
+ "default": "0",
31762
+ "description": "The part of the rows' height in view, in pixels from the top of the first row (see `measure()`)."
31763
+ },
31764
+ {
31765
+ "kind": "field",
31766
+ "name": "visibleBottom",
31767
+ "type": {
31768
+ "text": "number"
31769
+ },
31770
+ "privacy": "private",
31771
+ "default": "600"
31772
+ },
31773
+ {
31774
+ "kind": "field",
31775
+ "name": "activeIndex",
31776
+ "type": {
31777
+ "text": "number"
31778
+ },
31779
+ "privacy": "private",
31780
+ "default": "-1"
31781
+ },
31782
+ {
31783
+ "kind": "field",
31784
+ "name": "base",
31785
+ "type": {
31786
+ "text": "HTMLDivElement"
31787
+ },
31788
+ "privacy": "private"
31789
+ },
31790
+ {
31791
+ "kind": "field",
31792
+ "name": "spacer",
31793
+ "type": {
31794
+ "text": "HTMLDivElement"
31795
+ },
31796
+ "privacy": "private"
31797
+ },
31798
+ {
31799
+ "kind": "field",
31800
+ "name": "localize",
31801
+ "privacy": "private",
31802
+ "readonly": true,
31803
+ "default": "new LocalizeController(this)"
31804
+ },
31805
+ {
31806
+ "kind": "field",
31807
+ "name": "info",
31808
+ "privacy": "private",
31809
+ "default": "new Map<string, NodeInfo>()"
31810
+ },
31811
+ {
31812
+ "kind": "field",
31813
+ "name": "expanded",
31814
+ "privacy": "private",
31815
+ "default": "new Set<string>()"
31816
+ },
31817
+ {
31818
+ "kind": "field",
31819
+ "name": "selected",
31820
+ "privacy": "private",
31821
+ "default": "new Set<string>()",
31822
+ "description": "The selection: leaf ids in multiple selection, plus ids the tree doesn't know (so a reload keeps them)."
31823
+ },
31824
+ {
31825
+ "kind": "field",
31826
+ "name": "selectedCounts",
31827
+ "privacy": "private",
31828
+ "default": "new Map<string, number>()",
31829
+ "description": "Selected-leaf counts per parent, derived from `selected`."
31830
+ },
31831
+ {
31832
+ "kind": "field",
31833
+ "name": "matching",
31834
+ "type": {
31835
+ "text": "Set<string> | null"
31836
+ },
31837
+ "privacy": "private",
31838
+ "default": "null",
31839
+ "description": "Nodes with a match below them while filtering (null when not filtering)."
31840
+ },
31841
+ {
31842
+ "kind": "field",
31843
+ "name": "filterCollapsed",
31844
+ "privacy": "private",
31845
+ "default": "new Set<string>()",
31846
+ "description": "Nodes the user collapsed while filtering (filtering otherwise expands every match)."
31847
+ },
31848
+ {
31849
+ "kind": "field",
31850
+ "name": "rows",
31851
+ "type": {
31852
+ "text": "FlowTreeRow[]"
31853
+ },
31854
+ "privacy": "private",
31855
+ "default": "[]"
31856
+ },
31857
+ {
31858
+ "kind": "field",
31859
+ "name": "lastVisibleKey",
31860
+ "type": {
31861
+ "text": "string"
31862
+ },
31863
+ "privacy": "private",
31864
+ "default": "''"
31865
+ },
31866
+ {
31867
+ "kind": "field",
31868
+ "name": "rowNodeIds",
31869
+ "type": {
31870
+ "text": "string[]"
31871
+ },
31872
+ "privacy": "private",
31873
+ "default": "[]",
31874
+ "description": "The node id each rendered row showed last time. Rows are rendered by position in the window, so scrolling,\nexpanding or collapsing gives a row another node, and its checkbox would fade from the old node's state."
31875
+ },
31876
+ {
31877
+ "kind": "field",
31878
+ "name": "hasReusedRows",
31879
+ "type": {
31880
+ "text": "boolean"
31881
+ },
31882
+ "privacy": "private",
31883
+ "default": "false"
31884
+ },
31885
+ {
31886
+ "kind": "field",
31887
+ "name": "restoringTransitions",
31888
+ "type": {
31889
+ "text": "boolean"
31890
+ },
31891
+ "privacy": "private",
31892
+ "default": "false"
31893
+ },
31894
+ {
31895
+ "kind": "field",
31896
+ "name": "pinnedIndex",
31897
+ "type": {
31898
+ "text": "number"
31899
+ },
31900
+ "privacy": "private",
31901
+ "default": "-1",
31902
+ "description": "A row to render whatever is in view, so that it can be scrolled to."
31903
+ },
31904
+ {
31905
+ "kind": "field",
31906
+ "name": "scrollParents",
31907
+ "type": {
31908
+ "text": "Element[]"
31909
+ },
31910
+ "privacy": "private",
31911
+ "default": "[]"
31609
31912
  },
31610
- {
31611
- "description": "The icon to show when the tree item is collapsed. Works best with `<flow-ui-icon>`.",
31612
- "name": "collapse-icon"
31613
- }
31614
- ],
31615
- "members": [
31616
31913
  {
31617
31914
  "kind": "field",
31618
- "name": "tagName",
31915
+ "name": "resizeObserver",
31619
31916
  "type": {
31620
- "text": "string"
31917
+ "text": "ResizeObserver | undefined"
31621
31918
  },
31622
- "static": true,
31623
- "default": "'flow-ui-tree'"
31919
+ "privacy": "private"
31624
31920
  },
31625
31921
  {
31626
31922
  "kind": "field",
31627
- "name": "expandedIconSlot",
31923
+ "name": "gapObserver",
31628
31924
  "type": {
31629
- "text": "HTMLSlotElement"
31925
+ "text": "IntersectionObserver | undefined"
31630
31926
  },
31631
- "privacy": "private"
31927
+ "privacy": "private",
31928
+ "description": "Watches the space above and below the rendered rows, which comes into view when the tree moves without a scroll or\na resize: a drawer sliding in, an animated transform, or an element scrolling that the walk didn't find."
31632
31929
  },
31633
31930
  {
31634
31931
  "kind": "field",
31635
- "name": "collapsedIconSlot",
31932
+ "name": "followFrame",
31636
31933
  "type": {
31637
- "text": "HTMLSlotElement"
31934
+ "text": "number | undefined"
31638
31935
  },
31639
31936
  "privacy": "private"
31640
31937
  },
31641
31938
  {
31642
31939
  "kind": "field",
31643
- "name": "value",
31940
+ "name": "source",
31644
31941
  "type": {
31645
- "text": "string[]"
31942
+ "text": "'items' | 'data'"
31646
31943
  },
31647
- "default": "[]",
31648
- "description": "The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the\nvalue attribute will be a space-delimited list of values based on the options selected, and the value property will\nbe an array. **For this reason, values must not contain spaces.**",
31649
- "attribute": "value"
31944
+ "privacy": "private",
31945
+ "default": "'items'",
31946
+ "description": "Where the nodes come from: the tree items until the application sets `nodes`."
31650
31947
  },
31651
31948
  {
31652
31949
  "kind": "field",
31653
- "name": "selectionMode",
31950
+ "name": "itemObserver",
31654
31951
  "type": {
31655
- "text": "'single' | 'multiple' | 'leaf'"
31952
+ "text": "MutationObserver | undefined"
31656
31953
  },
31657
- "default": "'multiple'",
31658
- "description": "The selection behavior of the tree. Single selection allows only one node to be selected at a time. Multiple\ndisplays checkboxes and allows more than one node to be selected. Leaf allows only leaf nodes to be selected.",
31659
- "attribute": "selection-mode"
31954
+ "privacy": "private"
31660
31955
  },
31661
31956
  {
31662
31957
  "kind": "field",
31663
- "name": "size",
31958
+ "name": "itemSyncScheduled",
31664
31959
  "type": {
31665
- "text": "'small' | 'medium' | 'large'"
31960
+ "text": "boolean"
31666
31961
  },
31667
- "default": "'medium'",
31668
- "description": "The select's size.",
31669
- "attribute": "size",
31670
- "reflects": true
31962
+ "privacy": "private",
31963
+ "default": "false"
31964
+ },
31965
+ {
31966
+ "kind": "field",
31967
+ "name": "itemIds",
31968
+ "privacy": "private",
31969
+ "default": "new WeakMap<Element, string>()"
31970
+ },
31971
+ {
31972
+ "kind": "field",
31973
+ "name": "generatedIds",
31974
+ "privacy": "private",
31975
+ "default": "new Set<string>()",
31976
+ "description": "Ids the tree made for items without a value. They never appear in `value`."
31977
+ },
31978
+ {
31979
+ "kind": "field",
31980
+ "name": "itemsById",
31981
+ "privacy": "private",
31982
+ "default": "new Map<string, Element>()"
31983
+ },
31984
+ {
31985
+ "kind": "field",
31986
+ "name": "itemsSeen",
31987
+ "privacy": "private",
31988
+ "default": "new WeakMap<Element, ItemSeen>()",
31989
+ "description": "Each item's node, and its `expanded` and `selected` as the tree last read or wrote them."
31671
31990
  },
31672
31991
  {
31673
31992
  "kind": "field",
31674
- "name": "lastFocusedItem",
31993
+ "name": "itemReads",
31675
31994
  "type": {
31676
- "text": "FlowTreeItem"
31995
+ "text": "number"
31677
31996
  },
31678
- "privacy": "private"
31997
+ "privacy": "private",
31998
+ "default": "0"
31679
31999
  },
31680
32000
  {
31681
32001
  "kind": "field",
31682
- "name": "localize",
32002
+ "name": "pendingItemSelections",
31683
32003
  "privacy": "private",
31684
- "readonly": true,
31685
- "default": "new LocalizeController(this)"
32004
+ "default": "new Map<Element, boolean>()",
32005
+ "description": "Selections the application made on items (`selected`), applied once the nodes are indexed."
31686
32006
  },
31687
32007
  {
31688
32008
  "kind": "field",
31689
- "name": "mutationObserver",
32009
+ "name": "writtenValue",
31690
32010
  "type": {
31691
- "text": "MutationObserver"
32011
+ "text": "string[] | undefined"
31692
32012
  },
31693
- "privacy": "private"
32013
+ "privacy": "private",
32014
+ "description": "The `value` the tree last wrote itself: any other `value` comes from the application."
31694
32015
  },
31695
32016
  {
31696
32017
  "kind": "field",
31697
- "name": "clickTarget",
32018
+ "name": "itemStatesDirty",
31698
32019
  "type": {
31699
- "text": "FlowTreeItem | null"
32020
+ "text": "boolean"
31700
32021
  },
31701
32022
  "privacy": "private",
31702
- "default": "null"
32023
+ "default": "false",
32024
+ "description": "The selection or expansion changed since the items were last updated."
32025
+ },
32026
+ {
32027
+ "kind": "method",
32028
+ "name": "indexNodes",
32029
+ "privacy": "private"
31703
32030
  },
31704
32031
  {
31705
32032
  "kind": "method",
31706
- "name": "getExpandButtonIcon",
32033
+ "name": "normalizeSelection",
31707
32034
  "privacy": "private",
31708
32035
  "parameters": [
31709
32036
  {
31710
- "name": "status",
32037
+ "name": "ids",
31711
32038
  "type": {
31712
- "text": "'expand' | 'collapse'"
32039
+ "text": "string[]"
31713
32040
  }
31714
32041
  }
31715
- ]
32042
+ ],
32043
+ "description": "Leaf ids only: a selected parent (for example a lazy node that has loaded) stands for its leaves."
31716
32044
  },
31717
32045
  {
31718
- "kind": "field",
31719
- "name": "initTreeItem",
32046
+ "kind": "method",
32047
+ "name": "publishValue",
32048
+ "privacy": "private",
32049
+ "description": "Publishes the selection as `value`, without the ids the tree made for items without a value."
32050
+ },
32051
+ {
32052
+ "kind": "method",
32053
+ "name": "countSelected",
31720
32054
  "privacy": "private"
31721
32055
  },
31722
32056
  {
31723
32057
  "kind": "method",
31724
- "name": "handleTreeChanged",
32058
+ "name": "forEachLeaf",
31725
32059
  "privacy": "private",
31726
32060
  "parameters": [
31727
32061
  {
31728
- "name": "mutations",
32062
+ "name": "node",
31729
32063
  "type": {
31730
- "text": "MutationRecord[]"
32064
+ "text": "FlowTreeNode"
32065
+ }
32066
+ },
32067
+ {
32068
+ "name": "callback",
32069
+ "type": {
32070
+ "text": "(leaf: FlowTreeNode) => void"
31731
32071
  }
32072
+ },
32073
+ {
32074
+ "name": "onlyMatching",
32075
+ "default": "false"
31732
32076
  }
31733
32077
  ]
31734
32078
  },
31735
32079
  {
31736
32080
  "kind": "method",
31737
- "name": "syncTreeItems",
32081
+ "name": "computeMatches",
32082
+ "privacy": "private"
32083
+ },
32084
+ {
32085
+ "kind": "method",
32086
+ "name": "isExpanded",
31738
32087
  "privacy": "private",
31739
32088
  "parameters": [
31740
32089
  {
31741
- "name": "selectedItem",
31742
- "optional": true,
32090
+ "name": "node",
31743
32091
  "type": {
31744
- "text": "FlowTreeItem"
32092
+ "text": "FlowTreeNode"
31745
32093
  }
31746
32094
  }
31747
32095
  ]
31748
32096
  },
31749
32097
  {
31750
32098
  "kind": "method",
31751
- "name": "selectItem",
32099
+ "name": "flatten",
32100
+ "privacy": "private"
32101
+ },
32102
+ {
32103
+ "kind": "method",
32104
+ "name": "checkState",
32105
+ "return": {
32106
+ "type": {
32107
+ "text": "FlowTreeCheckState"
32108
+ }
32109
+ },
32110
+ "parameters": [
32111
+ {
32112
+ "name": "id",
32113
+ "type": {
32114
+ "text": "string"
32115
+ }
32116
+ }
32117
+ ],
32118
+ "description": "Returns the check state of a node. In multiple selection, a parent's state is derived from its selected leaves;\nan unknown ID is `unchecked`."
32119
+ },
32120
+ {
32121
+ "kind": "field",
32122
+ "name": "handleItemMutations",
32123
+ "privacy": "private"
32124
+ },
32125
+ {
32126
+ "kind": "method",
32127
+ "name": "itemAttributeChanged",
31752
32128
  "privacy": "private",
31753
32129
  "parameters": [
31754
32130
  {
31755
- "name": "selectedItem",
32131
+ "name": "item",
32132
+ "type": {
32133
+ "text": "Element"
32134
+ }
32135
+ },
32136
+ {
32137
+ "name": "name",
31756
32138
  "type": {
31757
- "text": "FlowTreeItem"
32139
+ "text": "string"
31758
32140
  }
31759
32141
  }
31760
- ]
32142
+ ],
32143
+ "description": "Whether an item's attribute differs from what the tree last read from the item or wrote to it. Items reflect\ntheir properties to attributes in their own updates, which can come after the tree has read them (every item's\n`value`, when the items first render): reading every item again for those would double the work of a change."
31761
32144
  },
31762
32145
  {
31763
32146
  "kind": "method",
31764
- "name": "getAllTreeItems",
32147
+ "name": "scheduleItemSync",
31765
32148
  "privacy": "private"
31766
32149
  },
31767
32150
  {
31768
32151
  "kind": "method",
31769
- "name": "focusItem",
32152
+ "name": "syncFromItems",
32153
+ "privacy": "private",
32154
+ "description": "Reads the tree items into `nodes` and `expandedIds`."
32155
+ },
32156
+ {
32157
+ "kind": "method",
32158
+ "name": "itemId",
31770
32159
  "privacy": "private",
31771
32160
  "parameters": [
31772
32161
  {
31773
32162
  "name": "item",
32163
+ "type": {
32164
+ "text": "Element"
32165
+ }
32166
+ }
32167
+ ],
32168
+ "description": "The item's value, or an id the tree makes for it."
32169
+ },
32170
+ {
32171
+ "kind": "method",
32172
+ "name": "applyItemSelections",
32173
+ "privacy": "private",
32174
+ "description": "Applies the selections the application made on items, now that the nodes are indexed."
32175
+ },
32176
+ {
32177
+ "kind": "method",
32178
+ "name": "writeItemStates",
32179
+ "privacy": "private",
32180
+ "description": "Mirrors the selection and expansion onto the items, so their `selected` and `expanded` stay current."
32181
+ },
32182
+ {
32183
+ "kind": "field",
32184
+ "name": "stopItemEvent",
32185
+ "privacy": "private"
32186
+ },
32187
+ {
32188
+ "kind": "method",
32189
+ "name": "expandAll",
32190
+ "description": "Expands every parent node."
32191
+ },
32192
+ {
32193
+ "kind": "method",
32194
+ "name": "collapseAll",
32195
+ "description": "Collapses every parent node."
32196
+ },
32197
+ {
32198
+ "kind": "method",
32199
+ "name": "selectAll",
32200
+ "parameters": [
32201
+ {
32202
+ "name": "select",
32203
+ "default": "true"
32204
+ }
32205
+ ],
32206
+ "description": "Selects every enabled leaf, or, with `select` set to `false`, deselects every leaf. While filtering, only the\nleaves the filter shows are selected or deselected."
32207
+ },
32208
+ {
32209
+ "kind": "method",
32210
+ "name": "scrollToNode",
32211
+ "parameters": [
32212
+ {
32213
+ "name": "id",
32214
+ "type": {
32215
+ "text": "string"
32216
+ }
32217
+ },
32218
+ {
32219
+ "name": "{ block = 'center' }",
32220
+ "default": "{}",
32221
+ "type": {
32222
+ "text": "{ block?: 'center' | 'nearest' }"
32223
+ }
32224
+ }
32225
+ ],
32226
+ "description": "Expands the node's ancestors, scrolls its row into view (in the tree, or in the elements that scroll the tree) and\nmakes it the active row. Returns a promise that resolves to `true` when the row is in view, or to `false`, without\nscrolling, if the node is not in the tree or the filter hides it."
32227
+ },
32228
+ {
32229
+ "kind": "field",
32230
+ "name": "visibleRows",
32231
+ "type": {
32232
+ "text": "readonly FlowTreeRow[]"
32233
+ },
32234
+ "description": "The visible rows: every row that is not collapsed or filtered out, rendered or not. See\n[FlowTreeRow](../public-api/interfaces/FlowTreeRow).",
32235
+ "readonly": true
32236
+ },
32237
+ {
32238
+ "kind": "method",
32239
+ "name": "focus",
32240
+ "parameters": [
32241
+ {
32242
+ "name": "options",
31774
32243
  "optional": true,
31775
32244
  "type": {
31776
- "text": "FlowTreeItem | null"
32245
+ "text": "FocusOptions"
32246
+ }
32247
+ }
32248
+ ],
32249
+ "description": "Sets focus on the tree."
32250
+ },
32251
+ {
32252
+ "kind": "method",
32253
+ "name": "dispatch",
32254
+ "privacy": "private",
32255
+ "parameters": [
32256
+ {
32257
+ "name": "name",
32258
+ "type": {
32259
+ "text": "string"
32260
+ }
32261
+ },
32262
+ {
32263
+ "name": "detail",
32264
+ "type": {
32265
+ "text": "unknown"
32266
+ }
32267
+ },
32268
+ {
32269
+ "name": "target",
32270
+ "default": "this",
32271
+ "type": {
32272
+ "text": "EventTarget"
32273
+ }
32274
+ }
32275
+ ]
32276
+ },
32277
+ {
32278
+ "kind": "method",
32279
+ "name": "setSelection",
32280
+ "privacy": "private",
32281
+ "parameters": [
32282
+ {
32283
+ "name": "ids",
32284
+ "type": {
32285
+ "text": "Set<string>"
32286
+ }
32287
+ }
32288
+ ]
32289
+ },
32290
+ {
32291
+ "kind": "method",
32292
+ "name": "toggleExpanded",
32293
+ "privacy": "private",
32294
+ "parameters": [
32295
+ {
32296
+ "name": "row",
32297
+ "type": {
32298
+ "text": "FlowTreeRow"
32299
+ }
32300
+ },
32301
+ {
32302
+ "name": "expanded",
32303
+ "default": "!this.isExpanded(row.node)"
32304
+ }
32305
+ ]
32306
+ },
32307
+ {
32308
+ "kind": "method",
32309
+ "name": "toggleSelected",
32310
+ "privacy": "private",
32311
+ "parameters": [
32312
+ {
32313
+ "name": "row",
32314
+ "type": {
32315
+ "text": "FlowTreeRow"
31777
32316
  }
31778
32317
  }
31779
32318
  ]
31780
32319
  },
31781
32320
  {
31782
32321
  "kind": "method",
31783
- "name": "handleKeyDown",
32322
+ "name": "rowFromEvent",
31784
32323
  "privacy": "private",
31785
32324
  "parameters": [
31786
32325
  {
31787
32326
  "name": "event",
31788
32327
  "type": {
31789
- "text": "KeyboardEvent"
32328
+ "text": "Event"
31790
32329
  }
31791
32330
  }
31792
32331
  ]
@@ -31799,79 +32338,164 @@
31799
32338
  {
31800
32339
  "name": "event",
31801
32340
  "type": {
31802
- "text": "Event"
32341
+ "text": "MouseEvent"
31803
32342
  }
31804
32343
  }
31805
32344
  ]
31806
32345
  },
31807
32346
  {
31808
32347
  "kind": "method",
31809
- "name": "handleMouseDown",
32348
+ "name": "handleKeyDown",
31810
32349
  "privacy": "private",
31811
32350
  "parameters": [
31812
32351
  {
31813
32352
  "name": "event",
31814
32353
  "type": {
31815
- "text": "MouseEvent"
32354
+ "text": "KeyboardEvent"
31816
32355
  }
31817
32356
  }
31818
32357
  ]
31819
32358
  },
31820
32359
  {
31821
32360
  "kind": "method",
31822
- "name": "handleFocusOut",
32361
+ "name": "handleFocus",
32362
+ "privacy": "private"
32363
+ },
32364
+ {
32365
+ "kind": "field",
32366
+ "name": "effectiveRowHeight",
32367
+ "privacy": "private",
32368
+ "readonly": true
32369
+ },
32370
+ {
32371
+ "kind": "method",
32372
+ "name": "watchLayout",
32373
+ "privacy": "private",
32374
+ "description": "Watches the tree and every element that clips it (the tree itself scrolls when it has a height)."
32375
+ },
32376
+ {
32377
+ "kind": "method",
32378
+ "name": "unwatchLayout",
32379
+ "privacy": "private"
32380
+ },
32381
+ {
32382
+ "kind": "field",
32383
+ "name": "measure",
32384
+ "privacy": "private",
32385
+ "description": "Finds the part of the rows in view: inside the viewport and every element that clips the tree."
32386
+ },
32387
+ {
32388
+ "kind": "field",
32389
+ "name": "handleGapIntersection",
32390
+ "privacy": "private"
32391
+ },
32392
+ {
32393
+ "kind": "method",
32394
+ "name": "followMotion",
32395
+ "privacy": "private"
32396
+ },
32397
+ {
32398
+ "kind": "method",
32399
+ "name": "scrollIndexIntoView",
31823
32400
  "privacy": "private",
31824
32401
  "parameters": [
31825
32402
  {
31826
- "name": "event",
32403
+ "name": "index",
31827
32404
  "type": {
31828
- "text": "FocusEvent"
32405
+ "text": "number"
32406
+ }
32407
+ },
32408
+ {
32409
+ "name": "block",
32410
+ "type": {
32411
+ "text": "'center' | 'nearest'"
31829
32412
  }
31830
32413
  }
31831
32414
  ]
31832
32415
  },
31833
32416
  {
31834
32417
  "kind": "method",
31835
- "name": "handleFocusIn",
32418
+ "name": "windowRange",
32419
+ "privacy": "private",
32420
+ "return": {
32421
+ "type": {
32422
+ "text": "[number, number]"
32423
+ }
32424
+ }
32425
+ },
32426
+ {
32427
+ "kind": "method",
32428
+ "name": "rowId",
31836
32429
  "privacy": "private",
31837
32430
  "parameters": [
31838
32431
  {
31839
- "name": "event",
32432
+ "name": "index",
31840
32433
  "type": {
31841
- "text": "FocusEvent"
32434
+ "text": "number"
31842
32435
  }
31843
32436
  }
31844
32437
  ]
31845
32438
  },
31846
32439
  {
31847
32440
  "kind": "method",
31848
- "name": "handleHostExpandCollapse",
32441
+ "name": "renderRow",
31849
32442
  "privacy": "private",
31850
32443
  "parameters": [
31851
32444
  {
31852
- "name": "event",
32445
+ "name": "row",
31853
32446
  "type": {
31854
- "text": "Event"
32447
+ "text": "FlowTreeRow"
32448
+ }
32449
+ },
32450
+ {
32451
+ "name": "index",
32452
+ "type": {
32453
+ "text": "number"
32454
+ }
32455
+ },
32456
+ {
32457
+ "name": "reused",
32458
+ "type": {
32459
+ "text": "boolean"
31855
32460
  }
31856
32461
  }
31857
32462
  ]
31858
- },
31859
- {
31860
- "kind": "method",
31861
- "name": "handleSlotChange",
31862
- "privacy": "private"
31863
32463
  }
31864
32464
  ],
31865
32465
  "events": [
31866
32466
  {
31867
- "description": "Emitted when a tree item is selected or deselected.",
32467
+ "description": "Emitted when the selection changes by UI interaction or `selectAll()`.",
31868
32468
  "name": "flow-ui-input",
31869
32469
  "reactName": "onFlowUiInput"
31870
32470
  },
31871
32471
  {
31872
- "description": "Emitted when a tree item is selected or deselected.",
32472
+ "description": "Emitted when the selection changes by UI interaction or `selectAll()`.",
31873
32473
  "name": "flow-ui-change",
31874
32474
  "reactName": "onFlowUiChange"
32475
+ },
32476
+ {
32477
+ "type": {
32478
+ "text": "CustomEvent<{ id: string; expanded: boolean }>"
32479
+ },
32480
+ "description": "Emitted when the user expands or collapses a node. The node ID and its new state can be retrieved from the event `detail` property.",
32481
+ "name": "flow-ui-node-toggle",
32482
+ "reactName": "onFlowUiNodeToggle"
32483
+ },
32484
+ {
32485
+ "type": {
32486
+ "text": "CustomEvent<{ id: string }>"
32487
+ },
32488
+ "description": "Emitted when the user expands a lazy node. Replace the node in `nodes` with one that has its children and is not `lazy`: its row shows a spinner until then. With tree items, the item emits `flow-ui-lazy-load` too.",
32489
+ "name": "flow-ui-node-lazy-load",
32490
+ "reactName": "onFlowUiNodeLazyLoad"
32491
+ },
32492
+ {
32493
+ "type": {
32494
+ "text": "CustomEvent<{ ids: string[] }>"
32495
+ },
32496
+ "description": "Emitted when the rendered rows change. The IDs of their nodes can be retrieved from the event `detail` property: use them to supply the row slots' content with `row-slots`.",
32497
+ "name": "flow-ui-visible-change",
32498
+ "reactName": "onFlowUiVisibleChange"
31875
32499
  }
31876
32500
  ],
31877
32501
  "attributes": [
@@ -31881,26 +32505,61 @@
31881
32505
  "text": "string[]"
31882
32506
  },
31883
32507
  "default": "[]",
31884
- "description": "The current value of the select, submitted as a name/value pair with form data. When `multiple` is enabled, the\nvalue attribute will be a space-delimited list of values based on the options selected, and the value property will\nbe an array. **For this reason, values must not contain spaces.**",
32508
+ "description": "The selected node IDs, or tree item values. In multiple selection, these are the selected leaves: a parent ID set\nhere selects the parent's leaves. In single and leaf selection, it holds the one selected node. The attribute is\na space-separated list, so IDs used in it must not contain spaces. Note that tree items without a `value` can be\nselected but never appear here.",
31885
32509
  "fieldName": "value"
31886
32510
  },
31887
32511
  {
31888
32512
  "name": "selection-mode",
31889
32513
  "type": {
31890
- "text": "'single' | 'multiple' | 'leaf'"
32514
+ "text": "FlowTreeSelectionMode"
31891
32515
  },
31892
32516
  "default": "'multiple'",
31893
- "description": "The selection behavior of the tree. Single selection allows only one node to be selected at a time. Multiple\ndisplays checkboxes and allows more than one node to be selected. Leaf allows only leaf nodes to be selected.",
32517
+ "description": "The selection mode. See [FlowTreeSelectionMode](../public-api/type-aliases/FlowTreeSelectionMode).",
31894
32518
  "fieldName": "selectionMode"
31895
32519
  },
32520
+ {
32521
+ "name": "filter",
32522
+ "type": {
32523
+ "text": "string"
32524
+ },
32525
+ "default": "''",
32526
+ "description": "The text to filter by. The tree shows only the leaves whose label contains it (ignoring case), with their\nancestors, expanded. If not set, every node is shown.",
32527
+ "fieldName": "filter"
32528
+ },
32529
+ {
32530
+ "name": "row-height",
32531
+ "type": {
32532
+ "text": "number | undefined"
32533
+ },
32534
+ "description": "The height of every row, in pixels. If not set, it is 24, 28 or 36 pixels for the small, medium and large sizes.",
32535
+ "fieldName": "rowHeight"
32536
+ },
32537
+ {
32538
+ "name": "overscan",
32539
+ "type": {
32540
+ "text": "number"
32541
+ },
32542
+ "default": "10",
32543
+ "description": "The number of rows rendered above and below the rows in view.",
32544
+ "fieldName": "overscan"
32545
+ },
31896
32546
  {
31897
32547
  "name": "size",
31898
32548
  "type": {
31899
32549
  "text": "'small' | 'medium' | 'large'"
31900
32550
  },
31901
32551
  "default": "'medium'",
31902
- "description": "The select's size.",
32552
+ "description": "The tree's size. It sets the font size, the indentation and the default `rowHeight`.",
31903
32553
  "fieldName": "size"
32554
+ },
32555
+ {
32556
+ "name": "row-slots",
32557
+ "type": {
32558
+ "text": "boolean"
32559
+ },
32560
+ "default": "false",
32561
+ "description": "Set to `true` to render a `<slot name=\"<node id>\">` at the end of each rendered row, for content you supply. See\n`flow-ui-visible-change`.",
32562
+ "fieldName": "rowSlots"
31904
32563
  }
31905
32564
  ],
31906
32565
  "superclass": {
@@ -31908,8 +32567,13 @@
31908
32567
  "module": "/src/internal/flow-ui-rdf-element"
31909
32568
  },
31910
32569
  "tagName": "flow-ui-tree",
31911
- "summary": "Trees allow you to display a hierarchical list of selectable [tree items](./flow-ui-tree-item). Items with children can be expanded and collapsed as desired by the user.",
32570
+ "summary": "Trees allow users to expand, collapse and select a hierarchy of nodes, given as data or as\n[tree items](./flow-ui-tree-item).",
31912
32571
  "docgroup": "tree",
32572
+ "dependencies": [
32573
+ "flow-ui-checkbox",
32574
+ "flow-ui-icon",
32575
+ "flow-ui-progress-ring"
32576
+ ],
31913
32577
  "customElement": true
31914
32578
  }
31915
32579
  ],
@@ -31953,94 +32617,12 @@
31953
32617
  "declarations": [
31954
32618
  {
31955
32619
  "kind": "class",
31956
- "description": "",
32620
+ "description": "The tree item component writes a node of a [tree](./flow-ui-tree) as markup. Nest tree items for child nodes. The\ntree reads its items into its nodes and draws their rows, so a tree item draws nothing itself. The tree reads them\nagain when items are added, removed or relabeled, or their attributes change.\n\nAn item's label is its text, without its child items: markup inside an item is reduced to its text. An item with\nthe `hidden` attribute is left out of the tree. The tree reads the attributes of items that are not registered yet,\nso the tree items can be registered after the tree.",
31957
32621
  "name": "FlowUiTreeItem",
31958
- "cssParts": [
31959
- {
31960
- "description": "The component's base wrapper.",
31961
- "name": "base"
31962
- },
31963
- {
31964
- "description": "The tree item's container. This element wraps everything except slotted tree item children.",
31965
- "name": "item"
31966
- },
31967
- {
31968
- "description": "Applied when the tree item is disabled.",
31969
- "name": "item--disabled"
31970
- },
31971
- {
31972
- "description": "Applied when the tree item is expanded.",
31973
- "name": "item--expanded"
31974
- },
31975
- {
31976
- "description": "Applied when the selection is indeterminate.",
31977
- "name": "item--indeterminate"
31978
- },
31979
- {
31980
- "description": "Applied when the tree item is selected.",
31981
- "name": "item--selected"
31982
- },
31983
- {
31984
- "description": "The tree item's indentation container.",
31985
- "name": "indentation"
31986
- },
31987
- {
31988
- "description": "The container that wraps the tree item's expand button and spinner.",
31989
- "name": "expand-button"
31990
- },
31991
- {
31992
- "description": "The tree item's label.",
31993
- "name": "label"
31994
- },
31995
- {
31996
- "description": "The container that wraps the tree item's nested children.",
31997
- "name": "children"
31998
- },
31999
- {
32000
- "description": "The checkbox that shows when using multiselect.",
32001
- "name": "checkbox"
32002
- },
32003
- {
32004
- "description": "The checkbox's exported `base` part.",
32005
- "name": "checkbox__base"
32006
- },
32007
- {
32008
- "description": "The checkbox's exported `control` part.",
32009
- "name": "checkbox__control"
32010
- },
32011
- {
32012
- "description": "The checkbox's exported `control--checked` part.",
32013
- "name": "checkbox__control--checked"
32014
- },
32015
- {
32016
- "description": "The checkbox's exported `control--indeterminate` part.",
32017
- "name": "checkbox__control--indeterminate"
32018
- },
32019
- {
32020
- "description": "The checkbox's exported `checked-icon` part.",
32021
- "name": "checkbox__checked-icon"
32022
- },
32023
- {
32024
- "description": "The checkbox's exported `indeterminate-icon` part.",
32025
- "name": "checkbox__indeterminate-icon"
32026
- },
32027
- {
32028
- "description": "The checkbox's exported `label` part.",
32029
- "name": "checkbox__label"
32030
- }
32031
- ],
32032
32622
  "slots": [
32033
32623
  {
32034
- "description": "The default slot.",
32624
+ "description": "The tree item's label and its child items.",
32035
32625
  "name": ""
32036
- },
32037
- {
32038
- "description": "The icon to show when the tree item is expanded.",
32039
- "name": "expand-icon"
32040
- },
32041
- {
32042
- "description": "The icon to show when the tree item is collapsed.",
32043
- "name": "collapse-icon"
32044
32626
  }
32045
32627
  ],
32046
32628
  "members": [
@@ -32053,22 +32635,6 @@
32053
32635
  "static": true,
32054
32636
  "default": "'flow-ui-tree-item'"
32055
32637
  },
32056
- {
32057
- "kind": "field",
32058
- "name": "dependencies",
32059
- "type": {
32060
- "text": "array"
32061
- },
32062
- "static": true,
32063
- "default": "[FlowUiCheckbox, FlowUiIcon, FlowUiProgressRing]"
32064
- },
32065
- {
32066
- "kind": "field",
32067
- "name": "localize",
32068
- "privacy": "private",
32069
- "readonly": true,
32070
- "default": "new LocalizeController(this)"
32071
- },
32072
32638
  {
32073
32639
  "kind": "field",
32074
32640
  "name": "value",
@@ -32076,7 +32642,7 @@
32076
32642
  "text": "string"
32077
32643
  },
32078
32644
  "default": "''",
32079
- "description": "The tree-items's value. When selected, the containing tree control will receive this value. The value must be unique\nfrom other tree-items in the same tree. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
32645
+ "description": "The item's value, which is its node ID. The tree's `value` holds it while the item is selected. It must be unique\nin the tree and must not contain spaces, which separate the values in the tree's `value` attribute. If not set,\nthe item can still be selected, but does not appear in the tree's `value`.",
32080
32646
  "attribute": "value",
32081
32647
  "reflects": true
32082
32648
  },
@@ -32087,7 +32653,7 @@
32087
32653
  "text": "boolean"
32088
32654
  },
32089
32655
  "default": "false",
32090
- "description": "Expands the tree item.",
32656
+ "description": "Indicates whether the item is expanded. Toggle this attribute to expand or collapse the item. The tree updates it\nwhen the user expands or collapses the item.",
32091
32657
  "attribute": "expanded",
32092
32658
  "reflects": true
32093
32659
  },
@@ -32098,7 +32664,7 @@
32098
32664
  "text": "boolean"
32099
32665
  },
32100
32666
  "default": "false",
32101
- "description": "Draws the tree item in a selected state.",
32667
+ "description": "Indicates whether the item is selected. Toggle this attribute to select or deselect the item, or, in multiple\nselection, a parent's leaves. The tree updates it when the selection changes: in multiple selection, a parent is\nselected when all its enabled leaves are.",
32102
32668
  "attribute": "selected",
32103
32669
  "reflects": true
32104
32670
  },
@@ -32109,7 +32675,7 @@
32109
32675
  "text": "boolean"
32110
32676
  },
32111
32677
  "default": "false",
32112
- "description": "Disables the tree item.",
32678
+ "description": "Disables the item, so that it cannot be selected.",
32113
32679
  "attribute": "disabled",
32114
32680
  "reflects": true
32115
32681
  },
@@ -32120,105 +32686,54 @@
32120
32686
  "text": "boolean"
32121
32687
  },
32122
32688
  "default": "false",
32123
- "description": "Enables lazy loading behavior.",
32689
+ "description": "Set to `true` to mark the item as having child items that are not loaded yet. See `flow-ui-lazy-load`.",
32124
32690
  "attribute": "lazy",
32125
32691
  "reflects": true
32126
32692
  },
32127
32693
  {
32128
32694
  "kind": "field",
32129
- "name": "size",
32695
+ "name": "icon",
32130
32696
  "type": {
32131
- "text": "'small' | 'medium' | 'large'"
32697
+ "text": "string | undefined"
32132
32698
  },
32133
- "default": "'medium'",
32134
- "description": "The select's size.",
32135
- "attribute": "size",
32699
+ "description": "The name of a `flow-ui-icon` to show before the label.",
32700
+ "attribute": "icon",
32136
32701
  "reflects": true
32137
32702
  },
32138
32703
  {
32139
32704
  "kind": "field",
32140
- "name": "hidden",
32705
+ "name": "iconLibrary",
32141
32706
  "type": {
32142
- "text": "boolean"
32707
+ "text": "string | undefined"
32143
32708
  },
32144
- "default": "false",
32145
- "description": "Set to `true` to visually hide the tree item.",
32146
- "attribute": "hidden",
32709
+ "description": "The icon library of `icon`. If not set, the default library is used.",
32710
+ "attribute": "icon-library",
32147
32711
  "reflects": true
32148
- },
32149
- {
32150
- "kind": "method",
32151
- "name": "animateCollapse",
32152
- "privacy": "private"
32153
- },
32154
- {
32155
- "kind": "method",
32156
- "name": "isNestedItem",
32157
- "privacy": "private",
32158
- "return": {
32159
- "type": {
32160
- "text": "boolean"
32161
- }
32162
- }
32163
- },
32164
- {
32165
- "kind": "method",
32166
- "name": "handleChildrenSlotChange",
32167
- "privacy": "private"
32168
- },
32169
- {
32170
- "kind": "method",
32171
- "name": "animateExpand",
32172
- "privacy": "private"
32173
- },
32174
- {
32175
- "kind": "method",
32176
- "name": "getChildrenItems",
32177
- "return": {
32178
- "type": {
32179
- "text": "FlowUiTreeItem[]"
32180
- }
32181
- },
32182
- "parameters": [
32183
- {
32184
- "name": "{ includeDisabled = true }",
32185
- "default": "{}",
32186
- "type": {
32187
- "text": "{ includeDisabled?: boolean }"
32188
- }
32189
- }
32190
- ],
32191
- "description": "Gets all the nested tree items in this node."
32192
32712
  }
32193
32713
  ],
32194
32714
  "events": [
32195
32715
  {
32196
- "description": "Emitted when the tree item expands.",
32716
+ "description": "Emitted when the user expands the item.",
32197
32717
  "name": "flow-ui-expand",
32198
32718
  "reactName": "onFlowUiExpand"
32199
32719
  },
32200
32720
  {
32201
- "description": "Emitted after the tree item expands and all animations are complete.",
32721
+ "description": "Emitted after the item expands and the tree has drawn its child rows.",
32202
32722
  "name": "flow-ui-after-expand",
32203
32723
  "reactName": "onFlowUiAfterExpand"
32204
32724
  },
32205
32725
  {
32206
- "description": "Emitted when the tree item collapses.",
32726
+ "description": "Emitted when the user collapses the item.",
32207
32727
  "name": "flow-ui-collapse",
32208
32728
  "reactName": "onFlowUiCollapse"
32209
32729
  },
32210
32730
  {
32211
- "description": "Emitted after the tree item collapses and all animations are complete.",
32731
+ "description": "Emitted after the item collapses and the tree has removed its child rows.",
32212
32732
  "name": "flow-ui-after-collapse",
32213
32733
  "reactName": "onFlowUiAfterCollapse"
32214
32734
  },
32215
32735
  {
32216
- "description": "Emitted when the tree item's lazy state changes.",
32217
- "name": "flow-ui-lazy-change",
32218
- "reactName": "onFlowUiLazyChange"
32219
- },
32220
- {
32221
- "description": "Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree.",
32736
+ "description": "Emitted when the user expands a lazy item. Use this event to load the item's children: append its child items, then remove the `lazy` attribute. The tree shows a spinner until then.",
32222
32737
  "name": "flow-ui-lazy-load",
32223
32738
  "reactName": "onFlowUiLazyLoad"
32224
32739
  }
@@ -32230,7 +32745,7 @@
32230
32745
  "text": "string"
32231
32746
  },
32232
32747
  "default": "''",
32233
- "description": "The tree-items's value. When selected, the containing tree control will receive this value. The value must be unique\nfrom other tree-items in the same tree. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
32748
+ "description": "The item's value, which is its node ID. The tree's `value` holds it while the item is selected. It must be unique\nin the tree and must not contain spaces, which separate the values in the tree's `value` attribute. If not set,\nthe item can still be selected, but does not appear in the tree's `value`.",
32234
32749
  "fieldName": "value"
32235
32750
  },
32236
32751
  {
@@ -32239,7 +32754,7 @@
32239
32754
  "text": "boolean"
32240
32755
  },
32241
32756
  "default": "false",
32242
- "description": "Expands the tree item.",
32757
+ "description": "Indicates whether the item is expanded. Toggle this attribute to expand or collapse the item. The tree updates it\nwhen the user expands or collapses the item.",
32243
32758
  "fieldName": "expanded"
32244
32759
  },
32245
32760
  {
@@ -32248,7 +32763,7 @@
32248
32763
  "text": "boolean"
32249
32764
  },
32250
32765
  "default": "false",
32251
- "description": "Draws the tree item in a selected state.",
32766
+ "description": "Indicates whether the item is selected. Toggle this attribute to select or deselect the item, or, in multiple\nselection, a parent's leaves. The tree updates it when the selection changes: in multiple selection, a parent is\nselected when all its enabled leaves are.",
32252
32767
  "fieldName": "selected"
32253
32768
  },
32254
32769
  {
@@ -32257,7 +32772,7 @@
32257
32772
  "text": "boolean"
32258
32773
  },
32259
32774
  "default": "false",
32260
- "description": "Disables the tree item.",
32775
+ "description": "Disables the item, so that it cannot be selected.",
32261
32776
  "fieldName": "disabled"
32262
32777
  },
32263
32778
  {
@@ -32266,26 +32781,24 @@
32266
32781
  "text": "boolean"
32267
32782
  },
32268
32783
  "default": "false",
32269
- "description": "Enables lazy loading behavior.",
32784
+ "description": "Set to `true` to mark the item as having child items that are not loaded yet. See `flow-ui-lazy-load`.",
32270
32785
  "fieldName": "lazy"
32271
32786
  },
32272
32787
  {
32273
- "name": "size",
32788
+ "name": "icon",
32274
32789
  "type": {
32275
- "text": "'small' | 'medium' | 'large'"
32790
+ "text": "string | undefined"
32276
32791
  },
32277
- "default": "'medium'",
32278
- "description": "The select's size.",
32279
- "fieldName": "size"
32792
+ "description": "The name of a `flow-ui-icon` to show before the label.",
32793
+ "fieldName": "icon"
32280
32794
  },
32281
32795
  {
32282
- "name": "hidden",
32796
+ "name": "icon-library",
32283
32797
  "type": {
32284
- "text": "boolean"
32798
+ "text": "string | undefined"
32285
32799
  },
32286
- "default": "false",
32287
- "description": "Set to `true` to visually hide the tree item.",
32288
- "fieldName": "hidden"
32800
+ "description": "The icon library of `icon`. If not set, the default library is used.",
32801
+ "fieldName": "iconLibrary"
32289
32802
  }
32290
32803
  ],
32291
32804
  "superclass": {
@@ -32293,13 +32806,8 @@
32293
32806
  "module": "/src/internal/flow-ui-rdf-element"
32294
32807
  },
32295
32808
  "tagName": "flow-ui-tree-item",
32296
- "summary": "A tree item serves as a hierarchical node that lives inside a [tree](./flow-ui-tree).",
32809
+ "summary": "Tree items are used with [trees](./flow-ui-tree) to write the tree's nodes as markup.",
32297
32810
  "docgroup": "tree",
32298
- "dependencies": [
32299
- "flow-ui-checkbox",
32300
- "flow-ui-icon",
32301
- "flow-ui-progress-ring"
32302
- ],
32303
32811
  "customElement": true
32304
32812
  }
32305
32813
  ],
@@ -32845,6 +33353,6 @@
32845
33353
  ],
32846
33354
  "package": {
32847
33355
  "name": "@emuanalytics/flow-rdf-ui",
32848
- "version": "4.4.0"
33356
+ "version": "5.0.0"
32849
33357
  }
32850
33358
  }