@emuanalytics/flow-rdf-ui 4.1.18 → 4.1.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -267,30 +267,46 @@
267
267
  },
268
268
  {
269
269
  "kind": "javascript-module",
270
- "path": "components/animation/animation.component.js",
270
+ "path": "components/avatar/avatar.component.js",
271
271
  "declarations": [
272
272
  {
273
273
  "kind": "class",
274
274
  "description": "",
275
- "name": "FlowUiAnimation",
276
- "slots": [
275
+ "name": "FlowUiAvatar",
276
+ "cssProperties": [
277
277
  {
278
- "description": "The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `<flow-ui-animation>` elements.",
279
- "name": ""
278
+ "description": "The size of the avatar.",
279
+ "name": "--size"
280
280
  }
281
281
  ],
282
- "members": [
282
+ "cssParts": [
283
283
  {
284
- "kind": "field",
285
- "name": "animation",
286
- "type": {
287
- "text": "Animation | undefined"
288
- },
289
- "privacy": "private"
284
+ "description": "The component's base wrapper.",
285
+ "name": "base"
286
+ },
287
+ {
288
+ "description": "The container that wraps the avatar's icon.",
289
+ "name": "icon"
290
290
  },
291
+ {
292
+ "description": "The container that wraps the avatar's initials.",
293
+ "name": "initials"
294
+ },
295
+ {
296
+ "description": "The avatar image. Only shown when the `image` attribute is set.",
297
+ "name": "image"
298
+ }
299
+ ],
300
+ "slots": [
301
+ {
302
+ "description": "The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.",
303
+ "name": "icon"
304
+ }
305
+ ],
306
+ "members": [
291
307
  {
292
308
  "kind": "field",
293
- "name": "hasStarted",
309
+ "name": "hasError",
294
310
  "type": {
295
311
  "text": "boolean"
296
312
  },
@@ -299,415 +315,181 @@
299
315
  },
300
316
  {
301
317
  "kind": "field",
302
- "name": "defaultSlot",
318
+ "name": "image",
303
319
  "type": {
304
- "text": "Promise<HTMLSlotElement>"
320
+ "text": "string"
305
321
  },
306
- "privacy": "private"
322
+ "default": "''",
323
+ "description": "The image source to use for the avatar.",
324
+ "attribute": "image"
307
325
  },
308
326
  {
309
327
  "kind": "field",
310
- "name": "name",
328
+ "name": "label",
311
329
  "type": {
312
330
  "text": "string"
313
331
  },
314
- "default": "'none'",
315
- "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.\nUse `getAnimationNames()` to retrieve a list of available animations.",
316
- "attribute": "name"
332
+ "default": "''",
333
+ "description": "A label to use to describe the avatar to assistive devices.",
334
+ "attribute": "label"
317
335
  },
318
336
  {
319
337
  "kind": "field",
320
- "name": "play",
338
+ "name": "initials",
321
339
  "type": {
322
- "text": "boolean"
340
+ "text": "string"
323
341
  },
324
- "default": "false",
325
- "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
326
- "attribute": "play",
327
- "reflects": true
342
+ "default": "''",
343
+ "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
344
+ "attribute": "initials"
328
345
  },
329
346
  {
330
347
  "kind": "field",
331
- "name": "delay",
348
+ "name": "loading",
332
349
  "type": {
333
- "text": "number"
350
+ "text": "'eager' | 'lazy'"
334
351
  },
335
- "default": "0",
336
- "description": "The number of milliseconds to delay the start of the animation.",
337
- "attribute": "delay"
352
+ "default": "'eager'",
353
+ "description": "Indicates how the browser should load the image.",
354
+ "attribute": "loading"
338
355
  },
339
356
  {
340
357
  "kind": "field",
341
- "name": "direction",
358
+ "name": "shape",
342
359
  "type": {
343
- "text": "PlaybackDirection"
360
+ "text": "'circle' | 'square' | 'rounded'"
344
361
  },
345
- "default": "'normal'",
346
- "description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)",
347
- "attribute": "direction"
348
- },
362
+ "default": "'circle'",
363
+ "description": "The shape of the avatar.",
364
+ "attribute": "shape",
365
+ "reflects": true
366
+ }
367
+ ],
368
+ "attributes": [
349
369
  {
350
- "kind": "field",
351
- "name": "duration",
370
+ "name": "image",
352
371
  "type": {
353
- "text": "number"
372
+ "text": "string"
354
373
  },
355
- "default": "1000",
356
- "description": "The number of milliseconds each iteration of the animation takes to complete.",
357
- "attribute": "duration"
374
+ "default": "''",
375
+ "description": "The image source to use for the avatar.",
376
+ "fieldName": "image"
358
377
  },
359
378
  {
360
- "kind": "field",
361
- "name": "easing",
379
+ "name": "label",
362
380
  "type": {
363
381
  "text": "string"
364
382
  },
365
- "default": "'linear'",
366
- "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
367
- "attribute": "easing"
383
+ "default": "''",
384
+ "description": "A label to use to describe the avatar to assistive devices.",
385
+ "fieldName": "label"
368
386
  },
369
387
  {
370
- "kind": "field",
371
- "name": "endDelay",
388
+ "name": "initials",
372
389
  "type": {
373
- "text": "number"
390
+ "text": "string"
374
391
  },
375
- "default": "0",
376
- "description": "The number of milliseconds to delay after the active period of an animation sequence.",
377
- "attribute": "end-delay"
392
+ "default": "''",
393
+ "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
394
+ "fieldName": "initials"
378
395
  },
379
396
  {
380
- "kind": "field",
381
- "name": "fill",
397
+ "name": "loading",
382
398
  "type": {
383
- "text": "FillMode"
399
+ "text": "'eager' | 'lazy'"
384
400
  },
385
- "default": "'auto'",
386
- "description": "Sets how the animation applies styles to its target before and after its execution.",
387
- "attribute": "fill"
388
- },
389
- {
390
- "kind": "field",
391
- "name": "iterations",
392
- "default": "Infinity",
393
- "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
394
- "attribute": "iterations"
401
+ "default": "'eager'",
402
+ "description": "Indicates how the browser should load the image.",
403
+ "fieldName": "loading"
395
404
  },
396
405
  {
397
- "kind": "field",
398
- "name": "iterationStart",
406
+ "name": "shape",
399
407
  "type": {
400
- "text": "number"
408
+ "text": "'circle' | 'square' | 'rounded'"
401
409
  },
402
- "default": "0",
403
- "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
404
- "attribute": "iteration-start"
405
- },
410
+ "default": "'circle'",
411
+ "description": "The shape of the avatar.",
412
+ "fieldName": "shape"
413
+ }
414
+ ],
415
+ "superclass": {
416
+ "name": "FlowRdfElement",
417
+ "module": "/src/internal/flow-ui-rdf-element"
418
+ },
419
+ "tagName": "flow-ui-avatar",
420
+ "summary": "Avatars are used to represent a person or object.",
421
+ "dependencies": [
422
+ "flow-ui-icon"
423
+ ],
424
+ "customElement": true
425
+ }
426
+ ],
427
+ "exports": [
428
+ {
429
+ "kind": "js",
430
+ "name": "default",
431
+ "declaration": {
432
+ "name": "FlowUiAvatar",
433
+ "module": "components/avatar/avatar.component.js"
434
+ }
435
+ }
436
+ ]
437
+ },
438
+ {
439
+ "kind": "javascript-module",
440
+ "path": "components/avatar/avatar.js",
441
+ "declarations": [],
442
+ "exports": [
443
+ {
444
+ "kind": "js",
445
+ "name": "default",
446
+ "declaration": {
447
+ "name": "FlowUiAvatar",
448
+ "module": "components/avatar/avatar.js"
449
+ }
450
+ }
451
+ ]
452
+ },
453
+ {
454
+ "kind": "javascript-module",
455
+ "path": "components/autocomplete/autocomplete.component.js",
456
+ "declarations": [
457
+ {
458
+ "kind": "class",
459
+ "description": "",
460
+ "name": "FlowUiAutocomplete",
461
+ "cssParts": [
406
462
  {
407
- "kind": "field",
408
- "name": "keyframes",
409
- "type": {
410
- "text": "Keyframe[] | undefined"
411
- },
412
- "description": "The keyframes to use for the animation. If this is set, `name` will be ignored."
463
+ "description": "The form control that wraps the label, input, and help text.",
464
+ "name": "form-control"
413
465
  },
414
466
  {
415
- "kind": "field",
416
- "name": "playbackRate",
417
- "type": {
418
- "text": "number"
419
- },
420
- "default": "1",
421
- "description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.",
422
- "attribute": "playback-rate"
467
+ "description": "The label's wrapper.",
468
+ "name": "form-control-label"
423
469
  },
424
470
  {
425
- "kind": "field",
426
- "name": "currentTime",
427
- "type": {
428
- "text": "CSSNumberish"
429
- },
430
- "description": "Gets and sets the current animation time."
471
+ "description": "The select's wrapper.",
472
+ "name": "form-control-input"
431
473
  },
432
474
  {
433
- "kind": "field",
434
- "name": "handleAnimationFinish",
435
- "privacy": "private"
475
+ "description": "The help text's wrapper.",
476
+ "name": "form-control-help-text"
436
477
  },
437
478
  {
438
- "kind": "field",
439
- "name": "handleAnimationCancel",
440
- "privacy": "private"
479
+ "description": "The container the wraps the prefix, suffix, combobox, clear icon, and expand button.",
480
+ "name": "combobox"
441
481
  },
442
482
  {
443
- "kind": "method",
444
- "name": "handleSlotChange",
445
- "privacy": "private"
483
+ "description": "The container that wraps the prefix slot.",
484
+ "name": "prefix"
446
485
  },
447
486
  {
448
- "kind": "method",
449
- "name": "createAnimation",
450
- "privacy": "private"
487
+ "description": "The container that wraps the suffix slot.",
488
+ "name": "suffix"
451
489
  },
452
490
  {
453
- "kind": "method",
454
- "name": "destroyAnimation",
455
- "privacy": "private"
456
- },
457
- {
458
- "kind": "method",
459
- "name": "cancel",
460
- "description": "Clears all keyframe effects caused by this animation and aborts its playback."
461
- },
462
- {
463
- "kind": "method",
464
- "name": "finish",
465
- "description": "Sets the playback time to the end of the animation corresponding to the current playback direction."
466
- }
467
- ],
468
- "events": [
469
- {
470
- "description": "Emitted when the animation is canceled.",
471
- "name": "flow-ui-cancel",
472
- "reactName": "onFlowUiCancel"
473
- },
474
- {
475
- "description": "Emitted when the animation finishes.",
476
- "name": "flow-ui-finish",
477
- "reactName": "onFlowUiFinish"
478
- },
479
- {
480
- "description": "Emitted when the animation starts or restarts.",
481
- "name": "flow-ui-start",
482
- "reactName": "onFlowUiStart"
483
- }
484
- ],
485
- "attributes": [
486
- {
487
- "name": "name",
488
- "type": {
489
- "text": "string"
490
- },
491
- "default": "'none'",
492
- "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.",
493
- "fieldName": "name"
494
- },
495
- {
496
- "name": "play",
497
- "type": {
498
- "text": "boolean"
499
- },
500
- "default": "false",
501
- "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
502
- "fieldName": "play"
503
- },
504
- {
505
- "name": "delay",
506
- "type": {
507
- "text": "number"
508
- },
509
- "default": "0",
510
- "description": "The number of milliseconds to delay the start of the animation.",
511
- "fieldName": "delay"
512
- },
513
- {
514
- "name": "direction",
515
- "type": {
516
- "text": "PlaybackDirection"
517
- },
518
- "default": "'normal'",
519
- "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)",
520
- "fieldName": "direction"
521
- },
522
- {
523
- "name": "duration",
524
- "type": {
525
- "text": "number"
526
- },
527
- "default": "1000",
528
- "description": "The number of milliseconds each iteration of the animation takes to complete.",
529
- "fieldName": "duration"
530
- },
531
- {
532
- "name": "easing",
533
- "type": {
534
- "text": "string"
535
- },
536
- "default": "'linear'",
537
- "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)`.",
538
- "fieldName": "easing"
539
- },
540
- {
541
- "name": "end-delay",
542
- "type": {
543
- "text": "number"
544
- },
545
- "default": "0",
546
- "description": "The number of milliseconds to delay after the active period of an animation sequence.",
547
- "fieldName": "endDelay"
548
- },
549
- {
550
- "name": "fill",
551
- "type": {
552
- "text": "FillMode"
553
- },
554
- "default": "'auto'",
555
- "description": "Sets how the animation applies styles to its target before and after its execution.",
556
- "fieldName": "fill"
557
- },
558
- {
559
- "name": "iterations",
560
- "default": "Infinity",
561
- "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
562
- "resolveInitializer": {
563
- "module": "src/components/animation/animation.component.ts"
564
- },
565
- "fieldName": "iterations"
566
- },
567
- {
568
- "name": "iteration-start",
569
- "type": {
570
- "text": "number"
571
- },
572
- "default": "0",
573
- "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
574
- "fieldName": "iterationStart"
575
- },
576
- {
577
- "name": "playback-rate",
578
- "type": {
579
- "text": "number"
580
- },
581
- "default": "1",
582
- "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.",
583
- "fieldName": "playbackRate"
584
- }
585
- ],
586
- "superclass": {
587
- "name": "FlowRdfElement",
588
- "module": "/src/internal/flow-ui-rdf-element"
589
- },
590
- "tagName": "flow-ui-animation",
591
- "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).",
592
- "customElement": true
593
- }
594
- ],
595
- "exports": [
596
- {
597
- "kind": "js",
598
- "name": "default",
599
- "declaration": {
600
- "name": "FlowUiAnimation",
601
- "module": "components/animation/animation.component.js"
602
- }
603
- }
604
- ]
605
- },
606
- {
607
- "kind": "javascript-module",
608
- "path": "components/animation/animation.js",
609
- "declarations": [],
610
- "exports": [
611
- {
612
- "kind": "js",
613
- "name": "*",
614
- "declaration": {
615
- "name": "*",
616
- "package": "./animation.component"
617
- }
618
- },
619
- {
620
- "kind": "js",
621
- "name": "default",
622
- "declaration": {
623
- "name": "FlowUiAnimation",
624
- "module": "components/animation/animation.js"
625
- }
626
- }
627
- ]
628
- },
629
- {
630
- "kind": "javascript-module",
631
- "path": "components/animation/animations.js",
632
- "declarations": [
633
- {
634
- "kind": "function",
635
- "name": "getAnimationNames",
636
- "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."
637
- },
638
- {
639
- "kind": "function",
640
- "name": "getEasingNames",
641
- "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."
642
- }
643
- ],
644
- "exports": [
645
- {
646
- "kind": "js",
647
- "name": "animations",
648
- "declaration": {
649
- "name": "animations",
650
- "module": "components/animation/animations.js"
651
- }
652
- },
653
- {
654
- "kind": "js",
655
- "name": "getAnimationNames",
656
- "declaration": {
657
- "name": "getAnimationNames",
658
- "module": "components/animation/animations.js"
659
- }
660
- },
661
- {
662
- "kind": "js",
663
- "name": "getEasingNames",
664
- "declaration": {
665
- "name": "getEasingNames",
666
- "module": "components/animation/animations.js"
667
- }
668
- }
669
- ]
670
- },
671
- {
672
- "kind": "javascript-module",
673
- "path": "components/autocomplete/autocomplete.component.js",
674
- "declarations": [
675
- {
676
- "kind": "class",
677
- "description": "",
678
- "name": "FlowUiAutocomplete",
679
- "cssParts": [
680
- {
681
- "description": "The form control that wraps the label, input, and help text.",
682
- "name": "form-control"
683
- },
684
- {
685
- "description": "The label's wrapper.",
686
- "name": "form-control-label"
687
- },
688
- {
689
- "description": "The select's wrapper.",
690
- "name": "form-control-input"
691
- },
692
- {
693
- "description": "The help text's wrapper.",
694
- "name": "form-control-help-text"
695
- },
696
- {
697
- "description": "The container the wraps the prefix, suffix, combobox, clear icon, and expand button.",
698
- "name": "combobox"
699
- },
700
- {
701
- "description": "The container that wraps the prefix slot.",
702
- "name": "prefix"
703
- },
704
- {
705
- "description": "The container that wraps the suffix slot.",
706
- "name": "suffix"
707
- },
708
- {
709
- "description": "The element that displays the selected option's label, an `<input>` element.",
710
- "name": "display-input"
491
+ "description": "The element that displays the selected option's label, an `<input>` element.",
492
+ "name": "display-input"
711
493
  },
712
494
  {
713
495
  "description": "The listbox container where options are slotted.",
@@ -1419,160 +1201,114 @@
1419
1201
  },
1420
1202
  {
1421
1203
  "kind": "javascript-module",
1422
- "path": "components/avatar/avatar.component.js",
1204
+ "path": "components/badge/badge.component.js",
1423
1205
  "declarations": [
1424
1206
  {
1425
1207
  "kind": "class",
1426
1208
  "description": "",
1427
- "name": "FlowUiAvatar",
1428
- "cssProperties": [
1429
- {
1430
- "description": "The size of the avatar.",
1431
- "name": "--size"
1432
- }
1433
- ],
1209
+ "name": "FlowUiBadge",
1434
1210
  "cssParts": [
1435
1211
  {
1436
1212
  "description": "The component's base wrapper.",
1437
1213
  "name": "base"
1438
- },
1439
- {
1440
- "description": "The container that wraps the avatar's icon.",
1441
- "name": "icon"
1442
- },
1443
- {
1444
- "description": "The container that wraps the avatar's initials.",
1445
- "name": "initials"
1446
- },
1447
- {
1448
- "description": "The avatar image. Only shown when the `image` attribute is set.",
1449
- "name": "image"
1450
1214
  }
1451
1215
  ],
1452
1216
  "slots": [
1453
1217
  {
1454
- "description": "The default icon to use when no image or initials are present. Works best with `<flow-ui-icon>`.",
1455
- "name": "icon"
1218
+ "description": "The badge's content.",
1219
+ "name": ""
1456
1220
  }
1457
1221
  ],
1458
1222
  "members": [
1459
1223
  {
1460
1224
  "kind": "field",
1461
- "name": "hasError",
1462
- "type": {
1463
- "text": "boolean"
1464
- },
1465
- "privacy": "private",
1466
- "default": "false"
1467
- },
1468
- {
1469
- "kind": "field",
1470
- "name": "image",
1471
- "type": {
1472
- "text": "string"
1473
- },
1474
- "default": "''",
1475
- "description": "The image source to use for the avatar.",
1476
- "attribute": "image"
1477
- },
1478
- {
1479
- "kind": "field",
1480
- "name": "label",
1225
+ "name": "variant",
1481
1226
  "type": {
1482
- "text": "string"
1227
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
1483
1228
  },
1484
- "default": "''",
1485
- "description": "A label to use to describe the avatar to assistive devices.",
1486
- "attribute": "label"
1229
+ "default": "'primary'",
1230
+ "description": "The badge's theme variant.",
1231
+ "attribute": "variant",
1232
+ "reflects": true
1487
1233
  },
1488
1234
  {
1489
1235
  "kind": "field",
1490
- "name": "initials",
1236
+ "name": "size",
1491
1237
  "type": {
1492
- "text": "string"
1238
+ "text": "'small' | 'medium' | 'large'"
1493
1239
  },
1494
- "default": "''",
1495
- "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
1496
- "attribute": "initials"
1240
+ "default": "'medium'",
1241
+ "description": "The badge size.",
1242
+ "attribute": "size",
1243
+ "reflects": true
1497
1244
  },
1498
1245
  {
1499
1246
  "kind": "field",
1500
- "name": "loading",
1247
+ "name": "pill",
1501
1248
  "type": {
1502
- "text": "'eager' | 'lazy'"
1249
+ "text": "boolean"
1503
1250
  },
1504
- "default": "'eager'",
1505
- "description": "Indicates how the browser should load the image.",
1506
- "attribute": "loading"
1251
+ "default": "false",
1252
+ "description": "Draws a pill-style badge with rounded edges.",
1253
+ "attribute": "pill",
1254
+ "reflects": true
1507
1255
  },
1508
1256
  {
1509
1257
  "kind": "field",
1510
- "name": "shape",
1258
+ "name": "pulse",
1511
1259
  "type": {
1512
- "text": "'circle' | 'square' | 'rounded'"
1260
+ "text": "boolean"
1513
1261
  },
1514
- "default": "'circle'",
1515
- "description": "The shape of the avatar.",
1516
- "attribute": "shape",
1262
+ "default": "false",
1263
+ "description": "Makes the badge pulsate to draw attention.",
1264
+ "attribute": "pulse",
1517
1265
  "reflects": true
1518
1266
  }
1519
1267
  ],
1520
1268
  "attributes": [
1521
1269
  {
1522
- "name": "image",
1523
- "type": {
1524
- "text": "string"
1525
- },
1526
- "default": "''",
1527
- "description": "The image source to use for the avatar.",
1528
- "fieldName": "image"
1529
- },
1530
- {
1531
- "name": "label",
1270
+ "name": "variant",
1532
1271
  "type": {
1533
- "text": "string"
1272
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
1534
1273
  },
1535
- "default": "''",
1536
- "description": "A label to use to describe the avatar to assistive devices.",
1537
- "fieldName": "label"
1274
+ "default": "'primary'",
1275
+ "description": "The badge's theme variant.",
1276
+ "fieldName": "variant"
1538
1277
  },
1539
1278
  {
1540
- "name": "initials",
1279
+ "name": "size",
1541
1280
  "type": {
1542
- "text": "string"
1281
+ "text": "'small' | 'medium' | 'large'"
1543
1282
  },
1544
- "default": "''",
1545
- "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
1546
- "fieldName": "initials"
1283
+ "default": "'medium'",
1284
+ "description": "The badge size.",
1285
+ "fieldName": "size"
1547
1286
  },
1548
1287
  {
1549
- "name": "loading",
1288
+ "name": "pill",
1550
1289
  "type": {
1551
- "text": "'eager' | 'lazy'"
1290
+ "text": "boolean"
1552
1291
  },
1553
- "default": "'eager'",
1554
- "description": "Indicates how the browser should load the image.",
1555
- "fieldName": "loading"
1292
+ "default": "false",
1293
+ "description": "Draws a pill-style badge with rounded edges.",
1294
+ "fieldName": "pill"
1556
1295
  },
1557
1296
  {
1558
- "name": "shape",
1297
+ "name": "pulse",
1559
1298
  "type": {
1560
- "text": "'circle' | 'square' | 'rounded'"
1299
+ "text": "boolean"
1561
1300
  },
1562
- "default": "'circle'",
1563
- "description": "The shape of the avatar.",
1564
- "fieldName": "shape"
1301
+ "default": "false",
1302
+ "description": "Makes the badge pulsate to draw attention.",
1303
+ "fieldName": "pulse"
1565
1304
  }
1566
1305
  ],
1567
1306
  "superclass": {
1568
1307
  "name": "FlowRdfElement",
1569
1308
  "module": "/src/internal/flow-ui-rdf-element"
1570
1309
  },
1571
- "tagName": "flow-ui-avatar",
1572
- "summary": "Avatars are used to represent a person or object.",
1573
- "dependencies": [
1574
- "flow-ui-icon"
1575
- ],
1310
+ "tagName": "flow-ui-badge",
1311
+ "summary": "Badges are used to draw attention and display statuses or counts.",
1576
1312
  "customElement": true
1577
1313
  }
1578
1314
  ],
@@ -1581,573 +1317,523 @@
1581
1317
  "kind": "js",
1582
1318
  "name": "default",
1583
1319
  "declaration": {
1584
- "name": "FlowUiAvatar",
1585
- "module": "components/avatar/avatar.component.js"
1320
+ "name": "FlowUiBadge",
1321
+ "module": "components/badge/badge.component.js"
1586
1322
  }
1587
1323
  }
1588
1324
  ]
1589
1325
  },
1590
1326
  {
1591
1327
  "kind": "javascript-module",
1592
- "path": "components/avatar/avatar.js",
1328
+ "path": "components/badge/badge.js",
1593
1329
  "declarations": [],
1594
1330
  "exports": [
1595
1331
  {
1596
1332
  "kind": "js",
1597
1333
  "name": "default",
1598
1334
  "declaration": {
1599
- "name": "FlowUiAvatar",
1600
- "module": "components/avatar/avatar.js"
1335
+ "name": "FlowUiBadge",
1336
+ "module": "components/badge/badge.js"
1601
1337
  }
1602
1338
  }
1603
1339
  ]
1604
1340
  },
1605
1341
  {
1606
1342
  "kind": "javascript-module",
1607
- "path": "components/breadcrumb/breadcrumb.component.js",
1343
+ "path": "components/animation/animation.component.js",
1608
1344
  "declarations": [
1609
1345
  {
1610
1346
  "kind": "class",
1611
1347
  "description": "",
1612
- "name": "FlowUiBreadcrumb",
1613
- "cssParts": [
1614
- {
1615
- "description": "The component's base wrapper.",
1616
- "name": "base"
1617
- }
1618
- ],
1348
+ "name": "FlowUiAnimation",
1619
1349
  "slots": [
1620
1350
  {
1621
- "description": "One or more breadcrumb items to display.",
1351
+ "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.",
1622
1352
  "name": ""
1623
- },
1624
- {
1625
- "description": "The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.",
1626
- "name": "separator"
1627
1353
  }
1628
1354
  ],
1629
1355
  "members": [
1630
1356
  {
1631
1357
  "kind": "field",
1632
- "name": "localize",
1633
- "privacy": "private",
1634
- "readonly": true,
1635
- "default": "new LocalizeController(this)"
1358
+ "name": "animation",
1359
+ "type": {
1360
+ "text": "Animation | undefined"
1361
+ },
1362
+ "privacy": "private"
1636
1363
  },
1637
1364
  {
1638
1365
  "kind": "field",
1639
- "name": "separatorDir",
1640
- "privacy": "private"
1366
+ "name": "hasStarted",
1367
+ "type": {
1368
+ "text": "boolean"
1369
+ },
1370
+ "privacy": "private",
1371
+ "default": "false"
1641
1372
  },
1642
1373
  {
1643
1374
  "kind": "field",
1644
1375
  "name": "defaultSlot",
1645
1376
  "type": {
1646
- "text": "HTMLSlotElement"
1377
+ "text": "Promise<HTMLSlotElement>"
1647
1378
  },
1648
1379
  "privacy": "private"
1649
1380
  },
1650
1381
  {
1651
1382
  "kind": "field",
1652
- "name": "separatorSlot",
1383
+ "name": "name",
1653
1384
  "type": {
1654
- "text": "HTMLSlotElement"
1385
+ "text": "string"
1655
1386
  },
1656
- "privacy": "private"
1387
+ "default": "'none'",
1388
+ "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.",
1389
+ "attribute": "name"
1657
1390
  },
1658
1391
  {
1659
1392
  "kind": "field",
1660
- "name": "label",
1393
+ "name": "play",
1661
1394
  "type": {
1662
- "text": "string"
1395
+ "text": "boolean"
1663
1396
  },
1664
- "default": "''",
1665
- "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
1666
- "attribute": "label"
1397
+ "default": "false",
1398
+ "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
1399
+ "attribute": "play",
1400
+ "reflects": true
1667
1401
  },
1668
1402
  {
1669
- "kind": "method",
1670
- "name": "getSeparator",
1671
- "privacy": "private"
1403
+ "kind": "field",
1404
+ "name": "delay",
1405
+ "type": {
1406
+ "text": "number"
1407
+ },
1408
+ "default": "0",
1409
+ "description": "The number of milliseconds to delay the start of the animation.",
1410
+ "attribute": "delay"
1672
1411
  },
1673
1412
  {
1674
- "kind": "method",
1675
- "name": "handleSlotChange",
1676
- "privacy": "private"
1677
- }
1678
- ],
1679
- "attributes": [
1413
+ "kind": "field",
1414
+ "name": "direction",
1415
+ "type": {
1416
+ "text": "PlaybackDirection"
1417
+ },
1418
+ "default": "'normal'",
1419
+ "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)",
1420
+ "attribute": "direction"
1421
+ },
1680
1422
  {
1681
- "name": "label",
1423
+ "kind": "field",
1424
+ "name": "duration",
1425
+ "type": {
1426
+ "text": "number"
1427
+ },
1428
+ "default": "1000",
1429
+ "description": "The number of milliseconds each iteration of the animation takes to complete.",
1430
+ "attribute": "duration"
1431
+ },
1432
+ {
1433
+ "kind": "field",
1434
+ "name": "easing",
1682
1435
  "type": {
1683
1436
  "text": "string"
1684
1437
  },
1685
- "default": "''",
1686
- "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
1687
- "fieldName": "label"
1688
- }
1689
- ],
1690
- "superclass": {
1691
- "name": "FlowRdfElement",
1692
- "module": "/src/internal/flow-ui-rdf-element"
1693
- },
1694
- "tagName": "flow-ui-breadcrumb",
1695
- "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
1696
- "dependencies": [
1697
- "flow-ui-icon"
1698
- ],
1699
- "customElement": true
1700
- }
1701
- ],
1702
- "exports": [
1703
- {
1704
- "kind": "js",
1705
- "name": "default",
1706
- "declaration": {
1707
- "name": "FlowUiBreadcrumb",
1708
- "module": "components/breadcrumb/breadcrumb.component.js"
1709
- }
1710
- }
1711
- ]
1712
- },
1713
- {
1714
- "kind": "javascript-module",
1715
- "path": "components/breadcrumb/breadcrumb.js",
1716
- "declarations": [],
1717
- "exports": [
1718
- {
1719
- "kind": "js",
1720
- "name": "default",
1721
- "declaration": {
1722
- "name": "FlowUiBreadcrumb",
1723
- "module": "components/breadcrumb/breadcrumb.js"
1724
- }
1725
- }
1726
- ]
1727
- },
1728
- {
1729
- "kind": "javascript-module",
1730
- "path": "components/base-control/base-control.component.js",
1731
- "declarations": [
1732
- {
1733
- "kind": "class",
1734
- "description": "",
1735
- "name": "FlowUiBaseControl",
1736
- "cssParts": [
1737
- {
1738
- "description": "The form control that wraps the label, input, and help text.",
1739
- "name": "form-control"
1438
+ "default": "'linear'",
1439
+ "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)`.",
1440
+ "attribute": "easing"
1740
1441
  },
1741
1442
  {
1742
- "description": "The label's wrapper.",
1743
- "name": "form-control-label"
1443
+ "kind": "field",
1444
+ "name": "endDelay",
1445
+ "type": {
1446
+ "text": "number"
1447
+ },
1448
+ "default": "0",
1449
+ "description": "The number of milliseconds to delay after the active period of an animation sequence.",
1450
+ "attribute": "end-delay"
1744
1451
  },
1745
1452
  {
1746
- "description": "The input's wrapper.",
1747
- "name": "form-control-input"
1453
+ "kind": "field",
1454
+ "name": "fill",
1455
+ "type": {
1456
+ "text": "FillMode"
1457
+ },
1458
+ "default": "'auto'",
1459
+ "description": "Sets how the animation applies styles to its target before and after its execution.",
1460
+ "attribute": "fill"
1748
1461
  },
1749
1462
  {
1750
- "description": "The help text's wrapper.",
1751
- "name": "form-control-help-text"
1463
+ "kind": "field",
1464
+ "name": "iterations",
1465
+ "default": "Infinity",
1466
+ "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
1467
+ "attribute": "iterations"
1752
1468
  },
1753
1469
  {
1754
- "description": "The component's base wrapper.",
1755
- "name": "base"
1470
+ "kind": "field",
1471
+ "name": "iterationStart",
1472
+ "type": {
1473
+ "text": "number"
1474
+ },
1475
+ "default": "0",
1476
+ "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
1477
+ "attribute": "iteration-start"
1756
1478
  },
1757
1479
  {
1758
- "description": "The internal `<input>` control.",
1759
- "name": "input"
1480
+ "kind": "field",
1481
+ "name": "keyframes",
1482
+ "type": {
1483
+ "text": "Keyframe[] | undefined"
1484
+ },
1485
+ "description": "The keyframes to use for the animation. If this is set, `name` will be ignored."
1760
1486
  },
1761
1487
  {
1762
- "description": "The container that wraps the prefix.",
1763
- "name": "prefix"
1488
+ "kind": "field",
1489
+ "name": "playbackRate",
1490
+ "type": {
1491
+ "text": "number"
1492
+ },
1493
+ "default": "1",
1494
+ "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.",
1495
+ "attribute": "playback-rate"
1764
1496
  },
1765
1497
  {
1766
- "description": "The clear button.",
1767
- "name": "clear-button"
1498
+ "kind": "field",
1499
+ "name": "currentTime",
1500
+ "type": {
1501
+ "text": "CSSNumberish"
1502
+ },
1503
+ "description": "Gets and sets the current animation time."
1768
1504
  },
1769
1505
  {
1770
- "description": "The password toggle button.",
1771
- "name": "password-toggle-button"
1506
+ "kind": "field",
1507
+ "name": "handleAnimationFinish",
1508
+ "privacy": "private"
1772
1509
  },
1773
1510
  {
1774
- "description": "The container that wraps the suffix.",
1775
- "name": "suffix"
1776
- }
1777
- ],
1778
- "slots": [
1511
+ "kind": "field",
1512
+ "name": "handleAnimationCancel",
1513
+ "privacy": "private"
1514
+ },
1779
1515
  {
1780
- "description": "The input's label. Alternatively, you can use the `label` attribute.",
1781
- "name": "label"
1516
+ "kind": "method",
1517
+ "name": "handleSlotChange",
1518
+ "privacy": "private"
1782
1519
  },
1783
1520
  {
1784
- "description": "Used to prepend a presentational icon or similar element to the input.",
1785
- "name": "prefix"
1521
+ "kind": "method",
1522
+ "name": "createAnimation",
1523
+ "privacy": "private"
1786
1524
  },
1787
1525
  {
1788
- "description": "Used to append a presentational icon or similar element to the input.",
1789
- "name": "suffix"
1526
+ "kind": "method",
1527
+ "name": "destroyAnimation",
1528
+ "privacy": "private"
1790
1529
  },
1791
1530
  {
1792
- "description": "An icon to use in lieu of the default clear icon.",
1793
- "name": "clear-icon"
1531
+ "kind": "method",
1532
+ "name": "cancel",
1533
+ "description": "Clears all keyframe effects caused by this animation and aborts its playback."
1794
1534
  },
1795
1535
  {
1796
- "description": "An icon to use in lieu of the default show password icon.",
1797
- "name": "show-password-icon"
1536
+ "kind": "method",
1537
+ "name": "finish",
1538
+ "description": "Sets the playback time to the end of the animation corresponding to the current playback direction."
1539
+ }
1540
+ ],
1541
+ "events": [
1542
+ {
1543
+ "description": "Emitted when the animation is canceled.",
1544
+ "name": "flow-ui-cancel",
1545
+ "reactName": "onFlowUiCancel"
1798
1546
  },
1799
1547
  {
1800
- "description": "An icon to use in lieu of the default hide password icon.",
1801
- "name": "hide-password-icon"
1548
+ "description": "Emitted when the animation finishes.",
1549
+ "name": "flow-ui-finish",
1550
+ "reactName": "onFlowUiFinish"
1802
1551
  },
1803
1552
  {
1804
- "description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.",
1805
- "name": "help-text"
1553
+ "description": "Emitted when the animation starts or restarts.",
1554
+ "name": "flow-ui-start",
1555
+ "reactName": "onFlowUiStart"
1806
1556
  }
1807
1557
  ],
1808
- "members": [
1809
- {
1810
- "kind": "field",
1811
- "name": "formControlController",
1812
- "privacy": "private",
1813
- "readonly": true,
1814
- "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })"
1815
- },
1558
+ "attributes": [
1816
1559
  {
1817
- "kind": "field",
1818
- "name": "hasSlotController",
1819
- "privacy": "private",
1820
- "readonly": true,
1821
- "default": "new HasSlotController(this, 'help-text', 'label')"
1560
+ "name": "name",
1561
+ "type": {
1562
+ "text": "string"
1563
+ },
1564
+ "default": "'none'",
1565
+ "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.",
1566
+ "fieldName": "name"
1822
1567
  },
1823
1568
  {
1824
- "kind": "field",
1825
- "name": "hasFocus",
1569
+ "name": "play",
1826
1570
  "type": {
1827
1571
  "text": "boolean"
1828
1572
  },
1829
- "privacy": "private",
1830
- "default": "false"
1573
+ "default": "false",
1574
+ "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.",
1575
+ "fieldName": "play"
1831
1576
  },
1832
1577
  {
1833
- "kind": "field",
1834
- "name": "size",
1578
+ "name": "delay",
1835
1579
  "type": {
1836
- "text": "'small' | 'medium' | 'large'"
1580
+ "text": "number"
1837
1581
  },
1838
- "default": "'medium'",
1839
- "description": "The input's size.",
1840
- "attribute": "size",
1841
- "reflects": true
1582
+ "default": "0",
1583
+ "description": "The number of milliseconds to delay the start of the animation.",
1584
+ "fieldName": "delay"
1842
1585
  },
1843
1586
  {
1844
- "kind": "field",
1845
- "name": "filled",
1587
+ "name": "direction",
1846
1588
  "type": {
1847
- "text": "boolean"
1589
+ "text": "PlaybackDirection"
1848
1590
  },
1849
- "default": "false",
1850
- "description": "Draws a filled input.",
1851
- "attribute": "filled",
1852
- "reflects": true
1591
+ "default": "'normal'",
1592
+ "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)",
1593
+ "fieldName": "direction"
1853
1594
  },
1854
1595
  {
1855
- "kind": "field",
1856
- "name": "pill",
1596
+ "name": "duration",
1857
1597
  "type": {
1858
- "text": "boolean"
1598
+ "text": "number"
1859
1599
  },
1860
- "default": "false",
1861
- "description": "Draws a pill-style input with rounded edges.",
1862
- "attribute": "pill",
1863
- "reflects": true
1600
+ "default": "1000",
1601
+ "description": "The number of milliseconds each iteration of the animation takes to complete.",
1602
+ "fieldName": "duration"
1864
1603
  },
1865
1604
  {
1866
- "kind": "field",
1867
- "name": "label",
1605
+ "name": "easing",
1868
1606
  "type": {
1869
1607
  "text": "string"
1870
1608
  },
1871
- "default": "''",
1872
- "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
1873
- "attribute": "label"
1609
+ "default": "'linear'",
1610
+ "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)`.",
1611
+ "fieldName": "easing"
1874
1612
  },
1875
1613
  {
1876
- "kind": "field",
1877
- "name": "helpText",
1614
+ "name": "end-delay",
1878
1615
  "type": {
1879
- "text": "string"
1616
+ "text": "number"
1880
1617
  },
1881
- "default": "''",
1882
- "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
1883
- "attribute": "help-text"
1618
+ "default": "0",
1619
+ "description": "The number of milliseconds to delay after the active period of an animation sequence.",
1620
+ "fieldName": "endDelay"
1884
1621
  },
1885
1622
  {
1886
- "kind": "field",
1887
- "name": "disabled",
1623
+ "name": "fill",
1888
1624
  "type": {
1889
- "text": "boolean"
1625
+ "text": "FillMode"
1890
1626
  },
1891
- "default": "false",
1892
- "description": "Disables the input.",
1893
- "attribute": "disabled",
1894
- "reflects": true
1627
+ "default": "'auto'",
1628
+ "description": "Sets how the animation applies styles to its target before and after its execution.",
1629
+ "fieldName": "fill"
1895
1630
  },
1896
1631
  {
1897
- "kind": "field",
1898
- "name": "form",
1899
- "type": {
1900
- "text": "string"
1632
+ "name": "iterations",
1633
+ "default": "Infinity",
1634
+ "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
1635
+ "resolveInitializer": {
1636
+ "module": "src/components/animation/animation.component.ts"
1901
1637
  },
1902
- "default": "''",
1903
- "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.",
1904
- "attribute": "form",
1905
- "reflects": true
1638
+ "fieldName": "iterations"
1906
1639
  },
1907
1640
  {
1908
- "kind": "field",
1909
- "name": "required",
1641
+ "name": "iteration-start",
1910
1642
  "type": {
1911
- "text": "boolean"
1643
+ "text": "number"
1912
1644
  },
1913
- "default": "false",
1914
- "description": "Makes the input a required field.",
1915
- "attribute": "required",
1916
- "reflects": true
1645
+ "default": "0",
1646
+ "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
1647
+ "fieldName": "iterationStart"
1917
1648
  },
1918
1649
  {
1919
- "kind": "field",
1920
- "name": "inline",
1650
+ "name": "playback-rate",
1921
1651
  "type": {
1922
- "text": "boolean"
1652
+ "text": "number"
1923
1653
  },
1924
- "default": "false",
1925
- "description": "Display the input in the 'inline' form control style.",
1926
- "attribute": "inline",
1927
- "reflects": true
1928
- },
1654
+ "default": "1",
1655
+ "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.",
1656
+ "fieldName": "playbackRate"
1657
+ }
1658
+ ],
1659
+ "superclass": {
1660
+ "name": "FlowRdfElement",
1661
+ "module": "/src/internal/flow-ui-rdf-element"
1662
+ },
1663
+ "tagName": "flow-ui-animation",
1664
+ "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).",
1665
+ "customElement": true
1666
+ }
1667
+ ],
1668
+ "exports": [
1669
+ {
1670
+ "kind": "js",
1671
+ "name": "default",
1672
+ "declaration": {
1673
+ "name": "FlowUiAnimation",
1674
+ "module": "components/animation/animation.component.js"
1675
+ }
1676
+ }
1677
+ ]
1678
+ },
1679
+ {
1680
+ "kind": "javascript-module",
1681
+ "path": "components/animation/animation.js",
1682
+ "declarations": [],
1683
+ "exports": [
1684
+ {
1685
+ "kind": "js",
1686
+ "name": "*",
1687
+ "declaration": {
1688
+ "name": "*",
1689
+ "package": "./animation.component"
1690
+ }
1691
+ },
1692
+ {
1693
+ "kind": "js",
1694
+ "name": "default",
1695
+ "declaration": {
1696
+ "name": "FlowUiAnimation",
1697
+ "module": "components/animation/animation.js"
1698
+ }
1699
+ }
1700
+ ]
1701
+ },
1702
+ {
1703
+ "kind": "javascript-module",
1704
+ "path": "components/animation/animations.js",
1705
+ "declarations": [
1706
+ {
1707
+ "kind": "function",
1708
+ "name": "getAnimationNames",
1709
+ "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."
1710
+ },
1711
+ {
1712
+ "kind": "function",
1713
+ "name": "getEasingNames",
1714
+ "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."
1715
+ }
1716
+ ],
1717
+ "exports": [
1718
+ {
1719
+ "kind": "js",
1720
+ "name": "animations",
1721
+ "declaration": {
1722
+ "name": "animations",
1723
+ "module": "components/animation/animations.js"
1724
+ }
1725
+ },
1726
+ {
1727
+ "kind": "js",
1728
+ "name": "getAnimationNames",
1729
+ "declaration": {
1730
+ "name": "getAnimationNames",
1731
+ "module": "components/animation/animations.js"
1732
+ }
1733
+ },
1734
+ {
1735
+ "kind": "js",
1736
+ "name": "getEasingNames",
1737
+ "declaration": {
1738
+ "name": "getEasingNames",
1739
+ "module": "components/animation/animations.js"
1740
+ }
1741
+ }
1742
+ ]
1743
+ },
1744
+ {
1745
+ "kind": "javascript-module",
1746
+ "path": "components/breadcrumb/breadcrumb.component.js",
1747
+ "declarations": [
1748
+ {
1749
+ "kind": "class",
1750
+ "description": "",
1751
+ "name": "FlowUiBreadcrumb",
1752
+ "cssParts": [
1929
1753
  {
1930
- "kind": "field",
1931
- "name": "divider",
1932
- "type": {
1933
- "text": "boolean"
1934
- },
1935
- "default": "false",
1936
- "description": "Indicates that the control should display a divider",
1937
- "attribute": "divider",
1938
- "reflects": true
1939
- },
1754
+ "description": "The component's base wrapper.",
1755
+ "name": "base"
1756
+ }
1757
+ ],
1758
+ "slots": [
1940
1759
  {
1941
- "kind": "field",
1942
- "name": "validity",
1943
- "description": "Gets the validity state object",
1944
- "readonly": true
1760
+ "description": "One or more breadcrumb items to display.",
1761
+ "name": ""
1945
1762
  },
1763
+ {
1764
+ "description": "The separator to use between breadcrumb items. Works best with `<flow-ui-icon>`.",
1765
+ "name": "separator"
1766
+ }
1767
+ ],
1768
+ "members": [
1946
1769
  {
1947
1770
  "kind": "field",
1948
- "name": "validationMessage",
1949
- "description": "Gets the validation message",
1950
- "readonly": true
1771
+ "name": "localize",
1772
+ "privacy": "private",
1773
+ "readonly": true,
1774
+ "default": "new LocalizeController(this)"
1951
1775
  },
1952
1776
  {
1953
- "kind": "method",
1954
- "name": "handleBlur",
1777
+ "kind": "field",
1778
+ "name": "separatorDir",
1955
1779
  "privacy": "private"
1956
1780
  },
1957
1781
  {
1958
- "kind": "method",
1959
- "name": "handleFocus",
1782
+ "kind": "field",
1783
+ "name": "defaultSlot",
1784
+ "type": {
1785
+ "text": "HTMLSlotElement"
1786
+ },
1960
1787
  "privacy": "private"
1961
1788
  },
1962
1789
  {
1963
- "kind": "method",
1964
- "name": "focus",
1965
- "parameters": [
1966
- {
1967
- "name": "options",
1968
- "optional": true,
1969
- "type": {
1970
- "text": "FocusOptions"
1971
- }
1972
- }
1973
- ],
1974
- "description": "Sets focus on the input."
1975
- },
1976
- {
1977
- "kind": "method",
1978
- "name": "blur",
1979
- "description": "Removes focus from the input."
1980
- },
1981
- {
1982
- "kind": "method",
1983
- "name": "checkValidity",
1984
- "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid."
1790
+ "kind": "field",
1791
+ "name": "separatorSlot",
1792
+ "type": {
1793
+ "text": "HTMLSlotElement"
1794
+ },
1795
+ "privacy": "private"
1985
1796
  },
1986
1797
  {
1987
- "kind": "method",
1988
- "name": "getForm",
1989
- "return": {
1990
- "type": {
1991
- "text": "HTMLFormElement | null"
1992
- }
1798
+ "kind": "field",
1799
+ "name": "label",
1800
+ "type": {
1801
+ "text": "string"
1993
1802
  },
1994
- "description": "Gets the associated form, if one exists."
1803
+ "default": "''",
1804
+ "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
1805
+ "attribute": "label"
1995
1806
  },
1996
1807
  {
1997
1808
  "kind": "method",
1998
- "name": "reportValidity",
1999
- "description": "Checks for validity and shows the browser's validation message if the control is invalid."
1809
+ "name": "getSeparator",
1810
+ "privacy": "private"
2000
1811
  },
2001
1812
  {
2002
1813
  "kind": "method",
2003
- "name": "setCustomValidity",
2004
- "parameters": [
2005
- {
2006
- "name": "message",
2007
- "type": {
2008
- "text": "string"
2009
- }
2010
- }
2011
- ],
2012
- "description": "Sets a custom validation message. Pass an empty string to restore validity."
1814
+ "name": "handleSlotChange",
1815
+ "privacy": "private"
2013
1816
  }
2014
1817
  ],
2015
- "events": [
2016
- {
2017
- "description": "Emitted when the control loses focus.",
2018
- "name": "flow-ui-blur",
2019
- "reactName": "onFlowUiBlur"
2020
- },
2021
- {
2022
- "description": "Emitted when an alteration to the control's value is committed by the user.",
2023
- "name": "flow-ui-change",
2024
- "reactName": "onFlowUiChange"
2025
- },
2026
- {
2027
- "description": "Emitted when the clear button is activated.",
2028
- "name": "flow-ui-clear",
2029
- "reactName": "onFlowUiClear"
2030
- },
2031
- {
2032
- "description": "Emitted when the control gains focus.",
2033
- "name": "flow-ui-focus",
2034
- "reactName": "onFlowUiFocus"
2035
- },
2036
- {
2037
- "description": "Emitted when the control receives input.",
2038
- "name": "flow-ui-input",
2039
- "reactName": "onFlowUiInput"
2040
- },
2041
- {
2042
- "description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied.",
2043
- "name": "flow-ui-invalid",
2044
- "reactName": "onFlowUiInvalid"
2045
- }
2046
- ],
2047
- "attributes": [
2048
- {
2049
- "name": "size",
2050
- "type": {
2051
- "text": "'small' | 'medium' | 'large'"
2052
- },
2053
- "default": "'medium'",
2054
- "description": "The input's size.",
2055
- "fieldName": "size"
2056
- },
2057
- {
2058
- "name": "filled",
2059
- "type": {
2060
- "text": "boolean"
2061
- },
2062
- "default": "false",
2063
- "description": "Draws a filled input.",
2064
- "fieldName": "filled"
2065
- },
2066
- {
2067
- "name": "pill",
2068
- "type": {
2069
- "text": "boolean"
2070
- },
2071
- "default": "false",
2072
- "description": "Draws a pill-style input with rounded edges.",
2073
- "fieldName": "pill"
2074
- },
1818
+ "attributes": [
2075
1819
  {
2076
1820
  "name": "label",
2077
1821
  "type": {
2078
1822
  "text": "string"
2079
1823
  },
2080
1824
  "default": "''",
2081
- "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
1825
+ "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.",
2082
1826
  "fieldName": "label"
2083
- },
2084
- {
2085
- "name": "help-text",
2086
- "type": {
2087
- "text": "string"
2088
- },
2089
- "default": "''",
2090
- "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
2091
- "fieldName": "helpText"
2092
- },
2093
- {
2094
- "name": "disabled",
2095
- "type": {
2096
- "text": "boolean"
2097
- },
2098
- "default": "false",
2099
- "description": "Disables the input.",
2100
- "fieldName": "disabled"
2101
- },
2102
- {
2103
- "name": "form",
2104
- "type": {
2105
- "text": "string"
2106
- },
2107
- "default": "''",
2108
- "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.",
2109
- "fieldName": "form"
2110
- },
2111
- {
2112
- "name": "required",
2113
- "type": {
2114
- "text": "boolean"
2115
- },
2116
- "default": "false",
2117
- "description": "Makes the input a required field.",
2118
- "fieldName": "required"
2119
- },
2120
- {
2121
- "name": "inline",
2122
- "type": {
2123
- "text": "boolean"
2124
- },
2125
- "default": "false",
2126
- "description": "Display the input in the 'inline' form control style.",
2127
- "fieldName": "inline"
2128
- },
2129
- {
2130
- "name": "divider",
2131
- "type": {
2132
- "text": "boolean"
2133
- },
2134
- "default": "false",
2135
- "description": "Indicates that the control should display a divider",
2136
- "fieldName": "divider"
2137
1827
  }
2138
1828
  ],
2139
1829
  "superclass": {
2140
- "name": "FlowRdfFormControl",
1830
+ "name": "FlowRdfElement",
2141
1831
  "module": "/src/internal/flow-ui-rdf-element"
2142
1832
  },
2143
- "tagName": "flow-ui-base-control",
2144
- "summary": "Inputs collect data from the user.",
2145
- "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input",
2146
- "status": "stable",
2147
- "since": "2.0",
1833
+ "tagName": "flow-ui-breadcrumb",
1834
+ "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.",
2148
1835
  "dependencies": [
2149
- "flow-ui-icon",
2150
- "flow-ui-icon-button"
1836
+ "flow-ui-icon"
2151
1837
  ],
2152
1838
  "customElement": true
2153
1839
  }
@@ -2157,455 +1843,450 @@
2157
1843
  "kind": "js",
2158
1844
  "name": "default",
2159
1845
  "declaration": {
2160
- "name": "FlowUiBaseControl",
2161
- "module": "components/base-control/base-control.component.js"
1846
+ "name": "FlowUiBreadcrumb",
1847
+ "module": "components/breadcrumb/breadcrumb.component.js"
2162
1848
  }
2163
1849
  }
2164
1850
  ]
2165
1851
  },
2166
1852
  {
2167
1853
  "kind": "javascript-module",
2168
- "path": "components/base-control/base-control.js",
1854
+ "path": "components/breadcrumb/breadcrumb.js",
2169
1855
  "declarations": [],
2170
1856
  "exports": [
2171
- {
2172
- "kind": "js",
2173
- "name": "*",
2174
- "declaration": {
2175
- "name": "*",
2176
- "package": "./base-control.component"
2177
- }
2178
- },
2179
1857
  {
2180
1858
  "kind": "js",
2181
1859
  "name": "default",
2182
1860
  "declaration": {
2183
- "name": "FlowUiBaseControl",
2184
- "module": "components/base-control/base-control.js"
1861
+ "name": "FlowUiBreadcrumb",
1862
+ "module": "components/breadcrumb/breadcrumb.js"
2185
1863
  }
2186
1864
  }
2187
1865
  ]
2188
1866
  },
2189
1867
  {
2190
1868
  "kind": "javascript-module",
2191
- "path": "components/breadcrumb-item/breadcrumb-item.component.js",
1869
+ "path": "components/base-control/base-control.component.js",
2192
1870
  "declarations": [
2193
1871
  {
2194
1872
  "kind": "class",
2195
1873
  "description": "",
2196
- "name": "FlowUiBreadcrumbItem",
1874
+ "name": "FlowUiBaseControl",
2197
1875
  "cssParts": [
1876
+ {
1877
+ "description": "The form control that wraps the label, input, and help text.",
1878
+ "name": "form-control"
1879
+ },
1880
+ {
1881
+ "description": "The label's wrapper.",
1882
+ "name": "form-control-label"
1883
+ },
1884
+ {
1885
+ "description": "The input's wrapper.",
1886
+ "name": "form-control-input"
1887
+ },
1888
+ {
1889
+ "description": "The help text's wrapper.",
1890
+ "name": "form-control-help-text"
1891
+ },
2198
1892
  {
2199
1893
  "description": "The component's base wrapper.",
2200
1894
  "name": "base"
2201
1895
  },
2202
1896
  {
2203
- "description": "The breadcrumb item's label.",
2204
- "name": "label"
1897
+ "description": "The internal `<input>` control.",
1898
+ "name": "input"
2205
1899
  },
2206
1900
  {
2207
1901
  "description": "The container that wraps the prefix.",
2208
1902
  "name": "prefix"
2209
1903
  },
2210
1904
  {
2211
- "description": "The container that wraps the suffix.",
2212
- "name": "suffix"
1905
+ "description": "The clear button.",
1906
+ "name": "clear-button"
2213
1907
  },
2214
1908
  {
2215
- "description": "The container that wraps the separator.",
2216
- "name": "separator"
1909
+ "description": "The password toggle button.",
1910
+ "name": "password-toggle-button"
1911
+ },
1912
+ {
1913
+ "description": "The container that wraps the suffix.",
1914
+ "name": "suffix"
2217
1915
  }
2218
1916
  ],
2219
1917
  "slots": [
2220
1918
  {
2221
- "description": "The breadcrumb item's label.",
2222
- "name": ""
1919
+ "description": "The input's label. Alternatively, you can use the `label` attribute.",
1920
+ "name": "label"
2223
1921
  },
2224
1922
  {
2225
- "description": "An optional prefix, usually an icon or icon button.",
1923
+ "description": "Used to prepend a presentational icon or similar element to the input.",
2226
1924
  "name": "prefix"
2227
1925
  },
2228
1926
  {
2229
- "description": "An optional suffix, usually an icon or icon button.",
1927
+ "description": "Used to append a presentational icon or similar element to the input.",
2230
1928
  "name": "suffix"
2231
1929
  },
2232
1930
  {
2233
- "description": "The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.",
2234
- "name": "separator"
1931
+ "description": "An icon to use in lieu of the default clear icon.",
1932
+ "name": "clear-icon"
1933
+ },
1934
+ {
1935
+ "description": "An icon to use in lieu of the default show password icon.",
1936
+ "name": "show-password-icon"
1937
+ },
1938
+ {
1939
+ "description": "An icon to use in lieu of the default hide password icon.",
1940
+ "name": "hide-password-icon"
1941
+ },
1942
+ {
1943
+ "description": "Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.",
1944
+ "name": "help-text"
2235
1945
  }
2236
1946
  ],
2237
1947
  "members": [
1948
+ {
1949
+ "kind": "field",
1950
+ "name": "formControlController",
1951
+ "privacy": "private",
1952
+ "readonly": true,
1953
+ "default": "new FormControlController(this, {\n assumeInteractionOn: ['flow-ui-blur', 'flow-ui-input']\n })"
1954
+ },
2238
1955
  {
2239
1956
  "kind": "field",
2240
1957
  "name": "hasSlotController",
2241
1958
  "privacy": "private",
2242
1959
  "readonly": true,
2243
- "default": "new HasSlotController(this, 'prefix', 'suffix')"
1960
+ "default": "new HasSlotController(this, 'help-text', 'label')"
2244
1961
  },
2245
1962
  {
2246
1963
  "kind": "field",
2247
- "name": "href",
1964
+ "name": "hasFocus",
2248
1965
  "type": {
2249
- "text": "string | undefined"
1966
+ "text": "boolean"
2250
1967
  },
2251
- "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
2252
- "attribute": "href"
1968
+ "privacy": "private",
1969
+ "default": "false"
2253
1970
  },
2254
1971
  {
2255
1972
  "kind": "field",
2256
- "name": "target",
1973
+ "name": "size",
2257
1974
  "type": {
2258
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
1975
+ "text": "'small' | 'medium' | 'large'"
2259
1976
  },
2260
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
2261
- "attribute": "target"
1977
+ "default": "'medium'",
1978
+ "description": "The input's size.",
1979
+ "attribute": "size",
1980
+ "reflects": true
2262
1981
  },
2263
1982
  {
2264
1983
  "kind": "field",
2265
- "name": "rel",
1984
+ "name": "filled",
2266
1985
  "type": {
2267
- "text": "string"
1986
+ "text": "boolean"
2268
1987
  },
2269
- "default": "'noreferrer noopener'",
2270
- "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
2271
- "attribute": "rel"
2272
- }
2273
- ],
2274
- "attributes": [
1988
+ "default": "false",
1989
+ "description": "Draws a filled input.",
1990
+ "attribute": "filled",
1991
+ "reflects": true
1992
+ },
2275
1993
  {
2276
- "name": "href",
1994
+ "kind": "field",
1995
+ "name": "pill",
2277
1996
  "type": {
2278
- "text": "string | undefined"
1997
+ "text": "boolean"
2279
1998
  },
2280
- "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
2281
- "fieldName": "href"
1999
+ "default": "false",
2000
+ "description": "Draws a pill-style input with rounded edges.",
2001
+ "attribute": "pill",
2002
+ "reflects": true
2282
2003
  },
2283
2004
  {
2284
- "name": "target",
2005
+ "kind": "field",
2006
+ "name": "label",
2285
2007
  "type": {
2286
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
2008
+ "text": "string"
2287
2009
  },
2288
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
2289
- "fieldName": "target"
2010
+ "default": "''",
2011
+ "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
2012
+ "attribute": "label"
2290
2013
  },
2291
2014
  {
2292
- "name": "rel",
2015
+ "kind": "field",
2016
+ "name": "helpText",
2293
2017
  "type": {
2294
2018
  "text": "string"
2295
2019
  },
2296
- "default": "'noreferrer noopener'",
2297
- "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
2298
- "fieldName": "rel"
2299
- }
2300
- ],
2301
- "superclass": {
2302
- "name": "FlowRdfElement",
2303
- "module": "/src/internal/flow-ui-rdf-element"
2304
- },
2305
- "tagName": "flow-ui-breadcrumb-item",
2306
- "summary": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.",
2307
- "customElement": true
2308
- }
2309
- ],
2310
- "exports": [
2311
- {
2312
- "kind": "js",
2313
- "name": "default",
2314
- "declaration": {
2315
- "name": "FlowUiBreadcrumbItem",
2316
- "module": "components/breadcrumb-item/breadcrumb-item.component.js"
2317
- }
2318
- }
2319
- ]
2320
- },
2321
- {
2322
- "kind": "javascript-module",
2323
- "path": "components/breadcrumb-item/breadcrumb-item.js",
2324
- "declarations": [],
2325
- "exports": [
2326
- {
2327
- "kind": "js",
2328
- "name": "default",
2329
- "declaration": {
2330
- "name": "FlowUiBreadcrumbItem",
2331
- "module": "components/breadcrumb-item/breadcrumb-item.js"
2332
- }
2333
- }
2334
- ]
2335
- },
2336
- {
2337
- "kind": "javascript-module",
2338
- "path": "components/badge/badge.component.js",
2339
- "declarations": [
2340
- {
2341
- "kind": "class",
2342
- "description": "",
2343
- "name": "FlowUiBadge",
2344
- "cssParts": [
2345
- {
2346
- "description": "The component's base wrapper.",
2347
- "name": "base"
2348
- }
2349
- ],
2350
- "slots": [
2351
- {
2352
- "description": "The badge's content.",
2353
- "name": ""
2354
- }
2355
- ],
2356
- "members": [
2020
+ "default": "''",
2021
+ "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
2022
+ "attribute": "help-text"
2023
+ },
2357
2024
  {
2358
2025
  "kind": "field",
2359
- "name": "variant",
2026
+ "name": "disabled",
2360
2027
  "type": {
2361
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2028
+ "text": "boolean"
2362
2029
  },
2363
- "default": "'primary'",
2364
- "description": "The badge's theme variant.",
2365
- "attribute": "variant",
2030
+ "default": "false",
2031
+ "description": "Disables the input.",
2032
+ "attribute": "disabled",
2366
2033
  "reflects": true
2367
2034
  },
2368
2035
  {
2369
2036
  "kind": "field",
2370
- "name": "size",
2037
+ "name": "form",
2371
2038
  "type": {
2372
- "text": "'small' | 'medium' | 'large'"
2039
+ "text": "string"
2373
2040
  },
2374
- "default": "'medium'",
2375
- "description": "The badge size.",
2376
- "attribute": "size",
2041
+ "default": "''",
2042
+ "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.",
2043
+ "attribute": "form",
2377
2044
  "reflects": true
2378
2045
  },
2379
2046
  {
2380
2047
  "kind": "field",
2381
- "name": "pill",
2048
+ "name": "required",
2382
2049
  "type": {
2383
2050
  "text": "boolean"
2384
2051
  },
2385
2052
  "default": "false",
2386
- "description": "Draws a pill-style badge with rounded edges.",
2387
- "attribute": "pill",
2053
+ "description": "Makes the input a required field.",
2054
+ "attribute": "required",
2388
2055
  "reflects": true
2389
2056
  },
2390
2057
  {
2391
2058
  "kind": "field",
2392
- "name": "pulse",
2059
+ "name": "inline",
2393
2060
  "type": {
2394
2061
  "text": "boolean"
2395
2062
  },
2396
2063
  "default": "false",
2397
- "description": "Makes the badge pulsate to draw attention.",
2398
- "attribute": "pulse",
2064
+ "description": "Display the input in the 'inline' form control style.",
2065
+ "attribute": "inline",
2399
2066
  "reflects": true
2400
- }
2401
- ],
2402
- "attributes": [
2403
- {
2404
- "name": "variant",
2405
- "type": {
2406
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2407
- },
2408
- "default": "'primary'",
2409
- "description": "The badge's theme variant.",
2410
- "fieldName": "variant"
2411
- },
2412
- {
2413
- "name": "size",
2414
- "type": {
2415
- "text": "'small' | 'medium' | 'large'"
2416
- },
2417
- "default": "'medium'",
2418
- "description": "The badge size.",
2419
- "fieldName": "size"
2420
2067
  },
2421
2068
  {
2422
- "name": "pill",
2069
+ "kind": "field",
2070
+ "name": "divider",
2423
2071
  "type": {
2424
2072
  "text": "boolean"
2425
2073
  },
2426
2074
  "default": "false",
2427
- "description": "Draws a pill-style badge with rounded edges.",
2428
- "fieldName": "pill"
2075
+ "description": "Indicates that the control should display a divider",
2076
+ "attribute": "divider",
2077
+ "reflects": true
2429
2078
  },
2430
2079
  {
2431
- "name": "pulse",
2432
- "type": {
2433
- "text": "boolean"
2434
- },
2435
- "default": "false",
2436
- "description": "Makes the badge pulsate to draw attention.",
2437
- "fieldName": "pulse"
2438
- }
2439
- ],
2440
- "superclass": {
2441
- "name": "FlowRdfElement",
2442
- "module": "/src/internal/flow-ui-rdf-element"
2443
- },
2444
- "tagName": "flow-ui-badge",
2445
- "summary": "Badges are used to draw attention and display statuses or counts.",
2446
- "customElement": true
2447
- }
2448
- ],
2449
- "exports": [
2450
- {
2451
- "kind": "js",
2452
- "name": "default",
2453
- "declaration": {
2454
- "name": "FlowUiBadge",
2455
- "module": "components/badge/badge.component.js"
2456
- }
2457
- }
2458
- ]
2459
- },
2460
- {
2461
- "kind": "javascript-module",
2462
- "path": "components/badge/badge.js",
2463
- "declarations": [],
2464
- "exports": [
2465
- {
2466
- "kind": "js",
2467
- "name": "default",
2468
- "declaration": {
2469
- "name": "FlowUiBadge",
2470
- "module": "components/badge/badge.js"
2471
- }
2472
- }
2473
- ]
2474
- },
2475
- {
2476
- "kind": "javascript-module",
2477
- "path": "components/busy-overlay/busy-overlay.component.js",
2478
- "declarations": [
2479
- {
2480
- "kind": "class",
2481
- "description": "",
2482
- "name": "FlowUiBusyOverlay",
2483
- "cssProperties": [
2484
- {
2485
- "description": "The delay after which the overlay is shown.",
2486
- "name": "--transition-delay"
2080
+ "kind": "field",
2081
+ "name": "validity",
2082
+ "description": "Gets the validity state object",
2083
+ "readonly": true
2487
2084
  },
2488
2085
  {
2489
- "description": "The duration of the overlay's fade-in/out transition.",
2490
- "name": "--transition-duration"
2086
+ "kind": "field",
2087
+ "name": "validationMessage",
2088
+ "description": "Gets the validation message",
2089
+ "readonly": true
2491
2090
  },
2492
2091
  {
2493
- "description": "The size of the default progress ring loading animation.",
2494
- "name": "--progress-ring-size"
2092
+ "kind": "method",
2093
+ "name": "handleBlur",
2094
+ "privacy": "private"
2495
2095
  },
2496
2096
  {
2497
- "description": "The width of the default progress ring's track.",
2498
- "name": "--progress-ring-track-width"
2097
+ "kind": "method",
2098
+ "name": "handleFocus",
2099
+ "privacy": "private"
2499
2100
  },
2500
2101
  {
2501
- "description": "The color of the default progress ring's track.",
2502
- "name": "--progress-ring-track-color"
2102
+ "kind": "method",
2103
+ "name": "focus",
2104
+ "parameters": [
2105
+ {
2106
+ "name": "options",
2107
+ "optional": true,
2108
+ "type": {
2109
+ "text": "FocusOptions"
2110
+ }
2111
+ }
2112
+ ],
2113
+ "description": "Sets focus on the input."
2503
2114
  },
2504
2115
  {
2505
- "description": "The background color of the overlay.",
2506
- "name": "--overlay-background-color"
2507
- }
2508
- ],
2509
- "slots": [
2510
- {
2511
- "description": "The component to overlay with when busy.",
2512
- "name": ""
2116
+ "kind": "method",
2117
+ "name": "blur",
2118
+ "description": "Removes focus from the input."
2513
2119
  },
2514
2120
  {
2515
- "description": "The indeterminate custom loading animation to display when busy.",
2516
- "name": "busy-animation"
2517
- }
2518
- ],
2519
- "members": [
2121
+ "kind": "method",
2122
+ "name": "checkValidity",
2123
+ "description": "Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid."
2124
+ },
2520
2125
  {
2521
- "kind": "field",
2522
- "name": "busy",
2523
- "type": {
2524
- "text": "boolean"
2126
+ "kind": "method",
2127
+ "name": "getForm",
2128
+ "return": {
2129
+ "type": {
2130
+ "text": "HTMLFormElement | null"
2131
+ }
2525
2132
  },
2526
- "default": "false",
2527
- "attribute": "busy",
2528
- "reflects": true
2133
+ "description": "Gets the associated form, if one exists."
2529
2134
  },
2530
2135
  {
2531
- "kind": "field",
2532
- "name": "variant",
2533
- "type": {
2534
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2535
- },
2536
- "default": "'neutral'",
2537
- "description": "The default loading animation's theme variant.",
2538
- "attribute": "variant",
2539
- "reflects": true
2136
+ "kind": "method",
2137
+ "name": "reportValidity",
2138
+ "description": "Checks for validity and shows the browser's validation message if the control is invalid."
2540
2139
  },
2541
2140
  {
2542
- "kind": "field",
2141
+ "kind": "method",
2142
+ "name": "setCustomValidity",
2143
+ "parameters": [
2144
+ {
2145
+ "name": "message",
2146
+ "type": {
2147
+ "text": "string"
2148
+ }
2149
+ }
2150
+ ],
2151
+ "description": "Sets a custom validation message. Pass an empty string to restore validity."
2152
+ }
2153
+ ],
2154
+ "events": [
2155
+ {
2156
+ "description": "Emitted when the control loses focus.",
2157
+ "name": "flow-ui-blur",
2158
+ "reactName": "onFlowUiBlur"
2159
+ },
2160
+ {
2161
+ "description": "Emitted when an alteration to the control's value is committed by the user.",
2162
+ "name": "flow-ui-change",
2163
+ "reactName": "onFlowUiChange"
2164
+ },
2165
+ {
2166
+ "description": "Emitted when the clear button is activated.",
2167
+ "name": "flow-ui-clear",
2168
+ "reactName": "onFlowUiClear"
2169
+ },
2170
+ {
2171
+ "description": "Emitted when the control gains focus.",
2172
+ "name": "flow-ui-focus",
2173
+ "reactName": "onFlowUiFocus"
2174
+ },
2175
+ {
2176
+ "description": "Emitted when the control receives input.",
2177
+ "name": "flow-ui-input",
2178
+ "reactName": "onFlowUiInput"
2179
+ },
2180
+ {
2181
+ "description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied.",
2182
+ "name": "flow-ui-invalid",
2183
+ "reactName": "onFlowUiInvalid"
2184
+ }
2185
+ ],
2186
+ "attributes": [
2187
+ {
2543
2188
  "name": "size",
2544
2189
  "type": {
2545
2190
  "text": "'small' | 'medium' | 'large'"
2546
2191
  },
2547
2192
  "default": "'medium'",
2548
- "description": "Size of the loading animation",
2549
- "attribute": "size",
2550
- "reflects": true
2193
+ "description": "The input's size.",
2194
+ "fieldName": "size"
2551
2195
  },
2552
2196
  {
2553
- "kind": "field",
2554
- "name": "overlayParent",
2197
+ "name": "filled",
2555
2198
  "type": {
2556
2199
  "text": "boolean"
2557
2200
  },
2558
2201
  "default": "false",
2559
- "description": "To overlay the parent element",
2560
- "attribute": "overlay-parent",
2561
- "reflects": true
2562
- }
2563
- ],
2564
- "attributes": [
2202
+ "description": "Draws a filled input.",
2203
+ "fieldName": "filled"
2204
+ },
2565
2205
  {
2566
- "name": "busy",
2206
+ "name": "pill",
2567
2207
  "type": {
2568
2208
  "text": "boolean"
2569
2209
  },
2570
2210
  "default": "false",
2571
- "fieldName": "busy"
2211
+ "description": "Draws a pill-style input with rounded edges.",
2212
+ "fieldName": "pill"
2572
2213
  },
2573
2214
  {
2574
- "name": "variant",
2215
+ "name": "label",
2575
2216
  "type": {
2576
- "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2217
+ "text": "string"
2577
2218
  },
2578
- "default": "'neutral'",
2579
- "description": "The default loading animation's theme variant.",
2580
- "fieldName": "variant"
2219
+ "default": "''",
2220
+ "description": "The input's label. If you need to display HTML, use the `label` slot instead.",
2221
+ "fieldName": "label"
2581
2222
  },
2582
2223
  {
2583
- "name": "size",
2224
+ "name": "help-text",
2584
2225
  "type": {
2585
- "text": "'small' | 'medium' | 'large'"
2226
+ "text": "string"
2586
2227
  },
2587
- "default": "'medium'",
2588
- "description": "Size of the loading animation",
2589
- "fieldName": "size"
2228
+ "default": "''",
2229
+ "description": "The input's help text. If you need to display HTML, use the `help-text` slot instead.",
2230
+ "fieldName": "helpText"
2590
2231
  },
2591
2232
  {
2592
- "name": "overlay-parent",
2233
+ "name": "disabled",
2593
2234
  "type": {
2594
2235
  "text": "boolean"
2595
2236
  },
2596
2237
  "default": "false",
2597
- "description": "To overlay the parent element",
2598
- "fieldName": "overlayParent"
2238
+ "description": "Disables the input.",
2239
+ "fieldName": "disabled"
2240
+ },
2241
+ {
2242
+ "name": "form",
2243
+ "type": {
2244
+ "text": "string"
2245
+ },
2246
+ "default": "''",
2247
+ "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.",
2248
+ "fieldName": "form"
2249
+ },
2250
+ {
2251
+ "name": "required",
2252
+ "type": {
2253
+ "text": "boolean"
2254
+ },
2255
+ "default": "false",
2256
+ "description": "Makes the input a required field.",
2257
+ "fieldName": "required"
2258
+ },
2259
+ {
2260
+ "name": "inline",
2261
+ "type": {
2262
+ "text": "boolean"
2263
+ },
2264
+ "default": "false",
2265
+ "description": "Display the input in the 'inline' form control style.",
2266
+ "fieldName": "inline"
2267
+ },
2268
+ {
2269
+ "name": "divider",
2270
+ "type": {
2271
+ "text": "boolean"
2272
+ },
2273
+ "default": "false",
2274
+ "description": "Indicates that the control should display a divider",
2275
+ "fieldName": "divider"
2599
2276
  }
2600
2277
  ],
2601
2278
  "superclass": {
2602
- "name": "FlowRdfElement",
2279
+ "name": "FlowRdfFormControl",
2603
2280
  "module": "/src/internal/flow-ui-rdf-element"
2604
2281
  },
2605
- "tagName": "flow-ui-busy-overlay",
2606
- "summary": "Busy overlay is used to indicate that a component which displays data is being currently updated.",
2282
+ "tagName": "flow-ui-base-control",
2283
+ "summary": "Inputs collect data from the user.",
2284
+ "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/input",
2285
+ "status": "stable",
2286
+ "since": "2.0",
2607
2287
  "dependencies": [
2608
- "flow-ui-progress-ring"
2288
+ "flow-ui-icon",
2289
+ "flow-ui-icon-button"
2609
2290
  ],
2610
2291
  "customElement": true
2611
2292
  }
@@ -2615,267 +2296,586 @@
2615
2296
  "kind": "js",
2616
2297
  "name": "default",
2617
2298
  "declaration": {
2618
- "name": "FlowUiBusyOverlay",
2619
- "module": "components/busy-overlay/busy-overlay.component.js"
2299
+ "name": "FlowUiBaseControl",
2300
+ "module": "components/base-control/base-control.component.js"
2620
2301
  }
2621
2302
  }
2622
2303
  ]
2623
2304
  },
2624
2305
  {
2625
2306
  "kind": "javascript-module",
2626
- "path": "components/busy-overlay/busy-overlay.js",
2307
+ "path": "components/base-control/base-control.js",
2627
2308
  "declarations": [],
2628
2309
  "exports": [
2310
+ {
2311
+ "kind": "js",
2312
+ "name": "*",
2313
+ "declaration": {
2314
+ "name": "*",
2315
+ "package": "./base-control.component"
2316
+ }
2317
+ },
2629
2318
  {
2630
2319
  "kind": "js",
2631
2320
  "name": "default",
2632
2321
  "declaration": {
2633
- "name": "FlowUiBusyOverlay",
2634
- "module": "components/busy-overlay/busy-overlay.js"
2322
+ "name": "FlowUiBaseControl",
2323
+ "module": "components/base-control/base-control.js"
2635
2324
  }
2636
2325
  }
2637
2326
  ]
2638
2327
  },
2639
2328
  {
2640
2329
  "kind": "javascript-module",
2641
- "path": "components/button/button.component.js",
2330
+ "path": "components/breadcrumb-item/breadcrumb-item.component.js",
2642
2331
  "declarations": [
2643
2332
  {
2644
2333
  "kind": "class",
2645
2334
  "description": "",
2646
- "name": "FlowUiButton",
2335
+ "name": "FlowUiBreadcrumbItem",
2647
2336
  "cssParts": [
2648
2337
  {
2649
2338
  "description": "The component's base wrapper.",
2650
2339
  "name": "base"
2651
2340
  },
2652
2341
  {
2653
- "description": "The container that wraps the prefix.",
2654
- "name": "prefix"
2342
+ "description": "The breadcrumb item's label.",
2343
+ "name": "label"
2655
2344
  },
2656
2345
  {
2657
- "description": "The button's label.",
2658
- "name": "label"
2346
+ "description": "The container that wraps the prefix.",
2347
+ "name": "prefix"
2659
2348
  },
2660
2349
  {
2661
2350
  "description": "The container that wraps the suffix.",
2662
2351
  "name": "suffix"
2663
2352
  },
2664
2353
  {
2665
- "description": "The button's caret icon, an `<flow-ui-icon>` element.",
2666
- "name": "caret"
2354
+ "description": "The container that wraps the separator.",
2355
+ "name": "separator"
2667
2356
  }
2668
2357
  ],
2669
2358
  "slots": [
2670
2359
  {
2671
- "description": "The button's label.",
2360
+ "description": "The breadcrumb item's label.",
2672
2361
  "name": ""
2673
2362
  },
2674
2363
  {
2675
- "description": "A presentational prefix icon or similar element.",
2364
+ "description": "An optional prefix, usually an icon or icon button.",
2676
2365
  "name": "prefix"
2677
2366
  },
2678
2367
  {
2679
- "description": "A presentational suffix icon or similar element.",
2368
+ "description": "An optional suffix, usually an icon or icon button.",
2680
2369
  "name": "suffix"
2370
+ },
2371
+ {
2372
+ "description": "The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `<flow-ui-breadcrumb>` instead.",
2373
+ "name": "separator"
2681
2374
  }
2682
2375
  ],
2683
2376
  "members": [
2684
- {
2685
- "kind": "field",
2686
- "name": "formControlController",
2687
- "privacy": "private",
2688
- "readonly": true,
2689
- "default": "new FormControlController(this, {\n form: (input) => {\n // Buttons support a form attribute that points to an arbitrary form, so if this attribute is set we need to query\n // the form from the same root using its id\n if (input.hasAttribute('form')) {\n const doc = input.getRootNode() as Document | ShadowRoot;\n const formId = input.getAttribute('form')!;\n return doc.getElementById(formId) as HTMLFormElement;\n }\n\n // Fall back to the closest containing form\n return input.closest('form');\n },\n assumeInteractionOn: ['click']\n })"
2690
- },
2691
2377
  {
2692
2378
  "kind": "field",
2693
2379
  "name": "hasSlotController",
2694
2380
  "privacy": "private",
2695
2381
  "readonly": true,
2696
- "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')"
2382
+ "default": "new HasSlotController(this, 'prefix', 'suffix')"
2697
2383
  },
2698
2384
  {
2699
2385
  "kind": "field",
2700
- "name": "localize",
2701
- "privacy": "private",
2702
- "readonly": true,
2703
- "default": "new LocalizeController(this)"
2386
+ "name": "href",
2387
+ "type": {
2388
+ "text": "string | undefined"
2389
+ },
2390
+ "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
2391
+ "attribute": "href"
2704
2392
  },
2705
2393
  {
2706
2394
  "kind": "field",
2707
- "name": "hasFocus",
2395
+ "name": "target",
2708
2396
  "type": {
2709
- "text": "boolean"
2397
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
2710
2398
  },
2711
- "privacy": "private",
2712
- "default": "false"
2399
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
2400
+ "attribute": "target"
2713
2401
  },
2714
2402
  {
2715
2403
  "kind": "field",
2716
- "name": "label",
2404
+ "name": "rel",
2717
2405
  "type": {
2718
2406
  "text": "string"
2719
2407
  },
2720
- "default": "''",
2721
- "attribute": "label"
2722
- },
2408
+ "default": "'noreferrer noopener'",
2409
+ "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
2410
+ "attribute": "rel"
2411
+ }
2412
+ ],
2413
+ "attributes": [
2723
2414
  {
2724
- "kind": "field",
2725
- "name": "variant",
2415
+ "name": "href",
2726
2416
  "type": {
2727
- "text": "| 'default'\n | 'primary'\n | 'secondary'\n | 'success'\n | 'neutral'\n | 'warning'\n | 'danger'\n | 'text'"
2417
+ "text": "string | undefined"
2728
2418
  },
2729
- "default": "'default'",
2730
- "description": "The button's theme variant.",
2731
- "attribute": "variant",
2732
- "reflects": true
2419
+ "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.",
2420
+ "fieldName": "href"
2733
2421
  },
2734
2422
  {
2735
- "kind": "field",
2736
- "name": "size",
2423
+ "name": "target",
2737
2424
  "type": {
2738
- "text": "'small' | 'medium' | 'large'"
2425
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
2739
2426
  },
2740
- "default": "'medium'",
2741
- "description": "The button's size.",
2742
- "attribute": "size",
2743
- "reflects": true
2427
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
2428
+ "fieldName": "target"
2744
2429
  },
2745
2430
  {
2746
- "kind": "field",
2747
- "name": "caret",
2431
+ "name": "rel",
2748
2432
  "type": {
2749
- "text": "boolean"
2433
+ "text": "string"
2750
2434
  },
2751
- "default": "false",
2752
- "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
2753
- "attribute": "caret",
2754
- "reflects": true
2435
+ "default": "'noreferrer noopener'",
2436
+ "description": "The `rel` attribute to use on the link. Only used when `href` is set.",
2437
+ "fieldName": "rel"
2438
+ }
2439
+ ],
2440
+ "superclass": {
2441
+ "name": "FlowRdfElement",
2442
+ "module": "/src/internal/flow-ui-rdf-element"
2443
+ },
2444
+ "tagName": "flow-ui-breadcrumb-item",
2445
+ "summary": "Breadcrumb Items are used inside [breadcrumbs](./flow-ui-breadcrumb) to represent different links.",
2446
+ "customElement": true
2447
+ }
2448
+ ],
2449
+ "exports": [
2450
+ {
2451
+ "kind": "js",
2452
+ "name": "default",
2453
+ "declaration": {
2454
+ "name": "FlowUiBreadcrumbItem",
2455
+ "module": "components/breadcrumb-item/breadcrumb-item.component.js"
2456
+ }
2457
+ }
2458
+ ]
2459
+ },
2460
+ {
2461
+ "kind": "javascript-module",
2462
+ "path": "components/breadcrumb-item/breadcrumb-item.js",
2463
+ "declarations": [],
2464
+ "exports": [
2465
+ {
2466
+ "kind": "js",
2467
+ "name": "default",
2468
+ "declaration": {
2469
+ "name": "FlowUiBreadcrumbItem",
2470
+ "module": "components/breadcrumb-item/breadcrumb-item.js"
2471
+ }
2472
+ }
2473
+ ]
2474
+ },
2475
+ {
2476
+ "kind": "javascript-module",
2477
+ "path": "components/busy-overlay/busy-overlay.component.js",
2478
+ "declarations": [
2479
+ {
2480
+ "kind": "class",
2481
+ "description": "",
2482
+ "name": "FlowUiBusyOverlay",
2483
+ "cssProperties": [
2484
+ {
2485
+ "description": "The delay after which the overlay is shown.",
2486
+ "name": "--transition-delay"
2755
2487
  },
2756
2488
  {
2757
- "kind": "field",
2758
- "name": "disabled",
2759
- "type": {
2760
- "text": "boolean"
2761
- },
2762
- "default": "false",
2763
- "description": "Disables the button.",
2764
- "attribute": "disabled",
2765
- "reflects": true
2489
+ "description": "The duration of the overlay's fade-in/out transition.",
2490
+ "name": "--transition-duration"
2491
+ },
2492
+ {
2493
+ "description": "The size of the default progress ring loading animation.",
2494
+ "name": "--progress-ring-size"
2495
+ },
2496
+ {
2497
+ "description": "The width of the default progress ring's track.",
2498
+ "name": "--progress-ring-track-width"
2499
+ },
2500
+ {
2501
+ "description": "The color of the default progress ring's track.",
2502
+ "name": "--progress-ring-track-color"
2503
+ },
2504
+ {
2505
+ "description": "The background color of the overlay.",
2506
+ "name": "--overlay-background-color"
2507
+ }
2508
+ ],
2509
+ "slots": [
2510
+ {
2511
+ "description": "The component to overlay with when busy.",
2512
+ "name": ""
2766
2513
  },
2514
+ {
2515
+ "description": "The indeterminate custom loading animation to display when busy.",
2516
+ "name": "busy-animation"
2517
+ }
2518
+ ],
2519
+ "members": [
2767
2520
  {
2768
2521
  "kind": "field",
2769
- "name": "loading",
2522
+ "name": "busy",
2770
2523
  "type": {
2771
2524
  "text": "boolean"
2772
2525
  },
2773
2526
  "default": "false",
2774
- "description": "Draws the button in a loading state.",
2775
- "attribute": "loading",
2527
+ "attribute": "busy",
2776
2528
  "reflects": true
2777
2529
  },
2778
2530
  {
2779
2531
  "kind": "field",
2780
- "name": "outline",
2532
+ "name": "variant",
2781
2533
  "type": {
2782
- "text": "boolean"
2534
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2783
2535
  },
2784
- "default": "false",
2785
- "description": "Draws an outlined button.",
2786
- "attribute": "outline",
2536
+ "default": "'neutral'",
2537
+ "description": "The default loading animation's theme variant.",
2538
+ "attribute": "variant",
2787
2539
  "reflects": true
2788
2540
  },
2789
2541
  {
2790
2542
  "kind": "field",
2791
- "name": "pill",
2543
+ "name": "size",
2792
2544
  "type": {
2793
- "text": "boolean"
2545
+ "text": "'small' | 'medium' | 'large'"
2794
2546
  },
2795
- "default": "false",
2796
- "description": "Draws a pill-style button with rounded edges.",
2797
- "attribute": "pill",
2547
+ "default": "'medium'",
2548
+ "description": "Size of the loading animation",
2549
+ "attribute": "size",
2798
2550
  "reflects": true
2799
2551
  },
2800
2552
  {
2801
2553
  "kind": "field",
2802
- "name": "fabCircle",
2554
+ "name": "overlayParent",
2803
2555
  "type": {
2804
2556
  "text": "boolean"
2805
2557
  },
2806
2558
  "default": "false",
2807
- "description": "Draws a circular FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
2808
- "attribute": "fab-circle",
2559
+ "description": "To overlay the parent element",
2560
+ "attribute": "overlay-parent",
2809
2561
  "reflects": true
2810
- },
2562
+ }
2563
+ ],
2564
+ "attributes": [
2811
2565
  {
2812
- "kind": "field",
2813
- "name": "fabSquare",
2566
+ "name": "busy",
2814
2567
  "type": {
2815
2568
  "text": "boolean"
2816
2569
  },
2817
2570
  "default": "false",
2818
- "description": "Draws a square FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
2819
- "attribute": "fab-square",
2820
- "reflects": true
2571
+ "fieldName": "busy"
2821
2572
  },
2822
2573
  {
2823
- "kind": "field",
2824
- "name": "type",
2574
+ "name": "variant",
2825
2575
  "type": {
2826
- "text": "'button' | 'submit' | 'reset'"
2576
+ "text": "'primary' | 'secondary' | 'success' | 'neutral' | 'warning' | 'danger'"
2827
2577
  },
2828
- "default": "'button'",
2829
- "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
2830
- "attribute": "type"
2578
+ "default": "'neutral'",
2579
+ "description": "The default loading animation's theme variant.",
2580
+ "fieldName": "variant"
2831
2581
  },
2832
2582
  {
2833
- "kind": "field",
2834
- "name": "name",
2583
+ "name": "size",
2835
2584
  "type": {
2836
- "text": "string"
2585
+ "text": "'small' | 'medium' | 'large'"
2837
2586
  },
2838
- "default": "''",
2839
- "description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
2840
- "attribute": "name"
2587
+ "default": "'medium'",
2588
+ "description": "Size of the loading animation",
2589
+ "fieldName": "size"
2841
2590
  },
2842
2591
  {
2843
- "kind": "field",
2844
- "name": "value",
2592
+ "name": "overlay-parent",
2845
2593
  "type": {
2846
- "text": "string"
2594
+ "text": "boolean"
2847
2595
  },
2848
- "default": "''",
2849
- "description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
2850
- "attribute": "value"
2596
+ "default": "false",
2597
+ "description": "To overlay the parent element",
2598
+ "fieldName": "overlayParent"
2599
+ }
2600
+ ],
2601
+ "superclass": {
2602
+ "name": "FlowRdfElement",
2603
+ "module": "/src/internal/flow-ui-rdf-element"
2604
+ },
2605
+ "tagName": "flow-ui-busy-overlay",
2606
+ "summary": "Busy overlay is used to indicate that a component which displays data is being currently updated.",
2607
+ "dependencies": [
2608
+ "flow-ui-progress-ring"
2609
+ ],
2610
+ "customElement": true
2611
+ }
2612
+ ],
2613
+ "exports": [
2614
+ {
2615
+ "kind": "js",
2616
+ "name": "default",
2617
+ "declaration": {
2618
+ "name": "FlowUiBusyOverlay",
2619
+ "module": "components/busy-overlay/busy-overlay.component.js"
2620
+ }
2621
+ }
2622
+ ]
2623
+ },
2624
+ {
2625
+ "kind": "javascript-module",
2626
+ "path": "components/busy-overlay/busy-overlay.js",
2627
+ "declarations": [],
2628
+ "exports": [
2629
+ {
2630
+ "kind": "js",
2631
+ "name": "default",
2632
+ "declaration": {
2633
+ "name": "FlowUiBusyOverlay",
2634
+ "module": "components/busy-overlay/busy-overlay.js"
2635
+ }
2636
+ }
2637
+ ]
2638
+ },
2639
+ {
2640
+ "kind": "javascript-module",
2641
+ "path": "components/button/button.component.js",
2642
+ "declarations": [
2643
+ {
2644
+ "kind": "class",
2645
+ "description": "",
2646
+ "name": "FlowUiButton",
2647
+ "cssParts": [
2648
+ {
2649
+ "description": "The component's base wrapper.",
2650
+ "name": "base"
2851
2651
  },
2852
2652
  {
2853
- "kind": "field",
2854
- "name": "href",
2855
- "type": {
2856
- "text": "string"
2857
- },
2858
- "default": "''",
2859
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
2860
- "attribute": "href"
2653
+ "description": "The container that wraps the prefix.",
2654
+ "name": "prefix"
2861
2655
  },
2862
2656
  {
2863
- "kind": "field",
2864
- "name": "target",
2865
- "type": {
2866
- "text": "'_blank' | '_parent' | '_self' | '_top'"
2867
- },
2868
- "description": "Tells the browser where to open the link. Only used when `href` is present.",
2869
- "attribute": "target"
2657
+ "description": "The button's label.",
2658
+ "name": "label"
2870
2659
  },
2871
2660
  {
2872
- "kind": "field",
2873
- "name": "rel",
2874
- "type": {
2875
- "text": "string"
2876
- },
2877
- "default": "'noreferrer noopener'",
2878
- "description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
2661
+ "description": "The container that wraps the suffix.",
2662
+ "name": "suffix"
2663
+ },
2664
+ {
2665
+ "description": "The button's caret icon, an `<flow-ui-icon>` element.",
2666
+ "name": "caret"
2667
+ }
2668
+ ],
2669
+ "slots": [
2670
+ {
2671
+ "description": "The button's label.",
2672
+ "name": ""
2673
+ },
2674
+ {
2675
+ "description": "A presentational prefix icon or similar element.",
2676
+ "name": "prefix"
2677
+ },
2678
+ {
2679
+ "description": "A presentational suffix icon or similar element.",
2680
+ "name": "suffix"
2681
+ }
2682
+ ],
2683
+ "members": [
2684
+ {
2685
+ "kind": "field",
2686
+ "name": "formControlController",
2687
+ "privacy": "private",
2688
+ "readonly": true,
2689
+ "default": "new FormControlController(this, {\n form: (input) => {\n // Buttons support a form attribute that points to an arbitrary form, so if this attribute is set we need to query\n // the form from the same root using its id\n if (input.hasAttribute('form')) {\n const doc = input.getRootNode() as Document | ShadowRoot;\n const formId = input.getAttribute('form')!;\n return doc.getElementById(formId) as HTMLFormElement;\n }\n\n // Fall back to the closest containing form\n return input.closest('form');\n },\n assumeInteractionOn: ['click']\n })"
2690
+ },
2691
+ {
2692
+ "kind": "field",
2693
+ "name": "hasSlotController",
2694
+ "privacy": "private",
2695
+ "readonly": true,
2696
+ "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')"
2697
+ },
2698
+ {
2699
+ "kind": "field",
2700
+ "name": "localize",
2701
+ "privacy": "private",
2702
+ "readonly": true,
2703
+ "default": "new LocalizeController(this)"
2704
+ },
2705
+ {
2706
+ "kind": "field",
2707
+ "name": "hasFocus",
2708
+ "type": {
2709
+ "text": "boolean"
2710
+ },
2711
+ "privacy": "private",
2712
+ "default": "false"
2713
+ },
2714
+ {
2715
+ "kind": "field",
2716
+ "name": "label",
2717
+ "type": {
2718
+ "text": "string"
2719
+ },
2720
+ "default": "''",
2721
+ "attribute": "label"
2722
+ },
2723
+ {
2724
+ "kind": "field",
2725
+ "name": "variant",
2726
+ "type": {
2727
+ "text": "| 'default'\n | 'primary'\n | 'secondary'\n | 'success'\n | 'neutral'\n | 'warning'\n | 'danger'\n | 'text'"
2728
+ },
2729
+ "default": "'default'",
2730
+ "description": "The button's theme variant.",
2731
+ "attribute": "variant",
2732
+ "reflects": true
2733
+ },
2734
+ {
2735
+ "kind": "field",
2736
+ "name": "size",
2737
+ "type": {
2738
+ "text": "'small' | 'medium' | 'large'"
2739
+ },
2740
+ "default": "'medium'",
2741
+ "description": "The button's size.",
2742
+ "attribute": "size",
2743
+ "reflects": true
2744
+ },
2745
+ {
2746
+ "kind": "field",
2747
+ "name": "caret",
2748
+ "type": {
2749
+ "text": "boolean"
2750
+ },
2751
+ "default": "false",
2752
+ "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
2753
+ "attribute": "caret",
2754
+ "reflects": true
2755
+ },
2756
+ {
2757
+ "kind": "field",
2758
+ "name": "disabled",
2759
+ "type": {
2760
+ "text": "boolean"
2761
+ },
2762
+ "default": "false",
2763
+ "description": "Disables the button.",
2764
+ "attribute": "disabled",
2765
+ "reflects": true
2766
+ },
2767
+ {
2768
+ "kind": "field",
2769
+ "name": "loading",
2770
+ "type": {
2771
+ "text": "boolean"
2772
+ },
2773
+ "default": "false",
2774
+ "description": "Draws the button in a loading state.",
2775
+ "attribute": "loading",
2776
+ "reflects": true
2777
+ },
2778
+ {
2779
+ "kind": "field",
2780
+ "name": "outline",
2781
+ "type": {
2782
+ "text": "boolean"
2783
+ },
2784
+ "default": "false",
2785
+ "description": "Draws an outlined button.",
2786
+ "attribute": "outline",
2787
+ "reflects": true
2788
+ },
2789
+ {
2790
+ "kind": "field",
2791
+ "name": "pill",
2792
+ "type": {
2793
+ "text": "boolean"
2794
+ },
2795
+ "default": "false",
2796
+ "description": "Draws a pill-style button with rounded edges.",
2797
+ "attribute": "pill",
2798
+ "reflects": true
2799
+ },
2800
+ {
2801
+ "kind": "field",
2802
+ "name": "fabCircle",
2803
+ "type": {
2804
+ "text": "boolean"
2805
+ },
2806
+ "default": "false",
2807
+ "description": "Draws a circular FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
2808
+ "attribute": "fab-circle",
2809
+ "reflects": true
2810
+ },
2811
+ {
2812
+ "kind": "field",
2813
+ "name": "fabSquare",
2814
+ "type": {
2815
+ "text": "boolean"
2816
+ },
2817
+ "default": "false",
2818
+ "description": "Draws a square FAB. When this attribute is present, the button expects a single `<flow-ui-icon>` in the\ndefault slot.",
2819
+ "attribute": "fab-square",
2820
+ "reflects": true
2821
+ },
2822
+ {
2823
+ "kind": "field",
2824
+ "name": "type",
2825
+ "type": {
2826
+ "text": "'button' | 'submit' | 'reset'"
2827
+ },
2828
+ "default": "'button'",
2829
+ "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
2830
+ "attribute": "type"
2831
+ },
2832
+ {
2833
+ "kind": "field",
2834
+ "name": "name",
2835
+ "type": {
2836
+ "text": "string"
2837
+ },
2838
+ "default": "''",
2839
+ "description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
2840
+ "attribute": "name"
2841
+ },
2842
+ {
2843
+ "kind": "field",
2844
+ "name": "value",
2845
+ "type": {
2846
+ "text": "string"
2847
+ },
2848
+ "default": "''",
2849
+ "description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
2850
+ "attribute": "value"
2851
+ },
2852
+ {
2853
+ "kind": "field",
2854
+ "name": "href",
2855
+ "type": {
2856
+ "text": "string"
2857
+ },
2858
+ "default": "''",
2859
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
2860
+ "attribute": "href"
2861
+ },
2862
+ {
2863
+ "kind": "field",
2864
+ "name": "target",
2865
+ "type": {
2866
+ "text": "'_blank' | '_parent' | '_self' | '_top'"
2867
+ },
2868
+ "description": "Tells the browser where to open the link. Only used when `href` is present.",
2869
+ "attribute": "target"
2870
+ },
2871
+ {
2872
+ "kind": "field",
2873
+ "name": "rel",
2874
+ "type": {
2875
+ "text": "string"
2876
+ },
2877
+ "default": "'noreferrer noopener'",
2878
+ "description": "When using `href`, this attribute will map to the underlying link's `rel` attribute. Unlike regular links, the\ndefault is `noreferrer noopener` to prevent security exploits. However, if you're using `target` to point to a\nspecific tab/window, this will prevent that from working correctly. You can remove or change the default value by\nsetting the attribute to an empty string or a value of your choice, respectively.",
2879
2879
  "attribute": "rel"
2880
2880
  },
2881
2881
  {
@@ -10529,47 +10529,49 @@
10529
10529
  },
10530
10530
  {
10531
10531
  "kind": "javascript-module",
10532
- "path": "components/icon/icon.component.js",
10532
+ "path": "components/icon-button/icon-button.component.js",
10533
10533
  "declarations": [
10534
10534
  {
10535
10535
  "kind": "class",
10536
10536
  "description": "",
10537
- "name": "FlowUiIcon",
10537
+ "name": "FlowUiIconButton",
10538
10538
  "cssParts": [
10539
10539
  {
10540
- "description": "The internal SVG element.",
10541
- "name": "svg"
10540
+ "description": "The component's base wrapper.",
10541
+ "name": "base"
10542
+ }
10543
+ ],
10544
+ "slots": [
10545
+ {
10546
+ "description": "The tooltip content to display when the user hovers over the icon button. Alternatively, you can use the `tooltip` attribute.",
10547
+ "name": "tooltip"
10542
10548
  }
10543
10549
  ],
10544
10550
  "members": [
10545
10551
  {
10546
- "kind": "method",
10547
- "name": "resolveIcon",
10552
+ "kind": "field",
10553
+ "name": "hasSlotController",
10548
10554
  "privacy": "private",
10549
- "static": true,
10550
- "return": {
10551
- "type": {
10552
- "text": "Promise<SVGResult>"
10553
- }
10554
- },
10555
- "parameters": [
10556
- {
10557
- "name": "url",
10558
- "type": {
10559
- "text": "string"
10560
- }
10561
- }
10562
- ],
10563
- "description": "Given a URL, this function returns the resulting SVG element or an appropriate error symbol."
10555
+ "readonly": true,
10556
+ "default": "new HasSlotController(this, 'tooltip')"
10564
10557
  },
10565
10558
  {
10566
10559
  "kind": "field",
10567
- "name": "svg",
10560
+ "name": "tooltipAnimating",
10568
10561
  "type": {
10569
- "text": "SVGElement | null"
10562
+ "text": "boolean"
10570
10563
  },
10571
10564
  "privacy": "private",
10572
- "default": "null"
10565
+ "default": "false"
10566
+ },
10567
+ {
10568
+ "kind": "field",
10569
+ "name": "hasFocus",
10570
+ "type": {
10571
+ "text": "boolean"
10572
+ },
10573
+ "privacy": "private",
10574
+ "default": "false"
10573
10575
  },
10574
10576
  {
10575
10577
  "kind": "field",
@@ -10578,8 +10580,16 @@
10578
10580
  "text": "string | undefined"
10579
10581
  },
10580
10582
  "description": "The name of the icon to draw. Available names depend on the icon library being used.",
10581
- "attribute": "name",
10582
- "reflects": true
10583
+ "attribute": "name"
10584
+ },
10585
+ {
10586
+ "kind": "field",
10587
+ "name": "library",
10588
+ "type": {
10589
+ "text": "string | undefined"
10590
+ },
10591
+ "description": "The name of a registered custom icon library.",
10592
+ "attribute": "library"
10583
10593
  },
10584
10594
  {
10585
10595
  "kind": "field",
@@ -10590,6 +10600,33 @@
10590
10600
  "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
10591
10601
  "attribute": "src"
10592
10602
  },
10603
+ {
10604
+ "kind": "field",
10605
+ "name": "href",
10606
+ "type": {
10607
+ "text": "string | undefined"
10608
+ },
10609
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
10610
+ "attribute": "href"
10611
+ },
10612
+ {
10613
+ "kind": "field",
10614
+ "name": "target",
10615
+ "type": {
10616
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
10617
+ },
10618
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
10619
+ "attribute": "target"
10620
+ },
10621
+ {
10622
+ "kind": "field",
10623
+ "name": "download",
10624
+ "type": {
10625
+ "text": "string | undefined"
10626
+ },
10627
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
10628
+ "attribute": "download"
10629
+ },
10593
10630
  {
10594
10631
  "kind": "field",
10595
10632
  "name": "label",
@@ -10597,36 +10634,169 @@
10597
10634
  "text": "string"
10598
10635
  },
10599
10636
  "default": "''",
10600
- "description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
10637
+ "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
10601
10638
  "attribute": "label"
10602
10639
  },
10603
10640
  {
10604
10641
  "kind": "field",
10605
- "name": "library",
10642
+ "name": "tooltip",
10606
10643
  "type": {
10607
10644
  "text": "string"
10608
10645
  },
10609
- "default": "'default'",
10610
- "description": "The name of a registered custom icon library.",
10611
- "attribute": "library",
10646
+ "default": "''",
10647
+ "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
10648
+ "attribute": "tooltip"
10649
+ },
10650
+ {
10651
+ "kind": "field",
10652
+ "name": "tooltipPlacement",
10653
+ "type": {
10654
+ "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
10655
+ },
10656
+ "default": "'top'",
10657
+ "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
10658
+ "attribute": "tooltip-placement"
10659
+ },
10660
+ {
10661
+ "kind": "field",
10662
+ "name": "tooltipDistance",
10663
+ "type": {
10664
+ "text": "number"
10665
+ },
10666
+ "default": "8",
10667
+ "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
10668
+ "attribute": "tooltip-distance"
10669
+ },
10670
+ {
10671
+ "kind": "field",
10672
+ "name": "tooltipSkidding",
10673
+ "type": {
10674
+ "text": "number"
10675
+ },
10676
+ "default": "0",
10677
+ "description": "The distance in pixels from which to offset the tooltip along the icon button.",
10678
+ "attribute": "tooltip-skidding"
10679
+ },
10680
+ {
10681
+ "kind": "field",
10682
+ "name": "disabled",
10683
+ "type": {
10684
+ "text": "boolean"
10685
+ },
10686
+ "default": "false",
10687
+ "description": "Disables the button.",
10688
+ "attribute": "disabled",
10612
10689
  "reflects": true
10613
10690
  },
10691
+ {
10692
+ "kind": "field",
10693
+ "name": "confirm",
10694
+ "type": {
10695
+ "text": "string"
10696
+ },
10697
+ "default": "''",
10698
+ "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
10699
+ "attribute": "confirm"
10700
+ },
10614
10701
  {
10615
10702
  "kind": "method",
10616
- "name": "getUrl",
10703
+ "name": "handleBlur",
10704
+ "privacy": "private"
10705
+ },
10706
+ {
10707
+ "kind": "method",
10708
+ "name": "handleFocus",
10709
+ "privacy": "private"
10710
+ },
10711
+ {
10712
+ "kind": "method",
10713
+ "name": "handleClick",
10714
+ "privacy": "protected",
10715
+ "parameters": [
10716
+ {
10717
+ "name": "event",
10718
+ "type": {
10719
+ "text": "MouseEvent"
10720
+ }
10721
+ }
10722
+ ]
10723
+ },
10724
+ {
10725
+ "kind": "method",
10726
+ "name": "click",
10727
+ "description": "Simulates a click on the icon button."
10728
+ },
10729
+ {
10730
+ "kind": "method",
10731
+ "name": "focus",
10732
+ "parameters": [
10733
+ {
10734
+ "name": "options",
10735
+ "optional": true,
10736
+ "type": {
10737
+ "text": "FocusOptions"
10738
+ }
10739
+ }
10740
+ ],
10741
+ "description": "Sets focus on the icon button."
10742
+ },
10743
+ {
10744
+ "kind": "method",
10745
+ "name": "blur",
10746
+ "description": "Removes focus from the icon button."
10747
+ },
10748
+ {
10749
+ "kind": "method",
10750
+ "name": "hideConfirm",
10751
+ "description": "Hide the confirmation tooltip if it is showing"
10752
+ },
10753
+ {
10754
+ "kind": "method",
10755
+ "name": "showConfirm",
10756
+ "description": "Show the confirmation tooltip"
10757
+ },
10758
+ {
10759
+ "kind": "method",
10760
+ "name": "handleConfirmClick",
10617
10761
  "privacy": "private"
10762
+ },
10763
+ {
10764
+ "kind": "method",
10765
+ "name": "renderWithTooltip",
10766
+ "privacy": "private",
10767
+ "parameters": [
10768
+ {
10769
+ "name": "contents",
10770
+ "type": {
10771
+ "text": "TemplateResult"
10772
+ }
10773
+ }
10774
+ ]
10775
+ },
10776
+ {
10777
+ "kind": "method",
10778
+ "name": "renderWithConfirmation",
10779
+ "privacy": "private",
10780
+ "parameters": [
10781
+ {
10782
+ "name": "contents",
10783
+ "type": {
10784
+ "text": "TemplateResult"
10785
+ }
10786
+ }
10787
+ ]
10618
10788
  }
10619
10789
  ],
10620
10790
  "events": [
10621
10791
  {
10622
- "description": "Emitted when the icon has loaded.",
10623
- "name": "flow-ui-load",
10624
- "reactName": "onFlowUiLoad"
10792
+ "description": "Emitted when the icon button loses focus.",
10793
+ "name": "flow-ui-blur",
10794
+ "reactName": "onFlowUiBlur"
10625
10795
  },
10626
10796
  {
10627
- "description": "Emitted when the icon fails to load due to an error.",
10628
- "name": "flow-ui-error",
10629
- "reactName": "onFlowUiError"
10797
+ "description": "Emitted when the icon button gains focus.",
10798
+ "name": "flow-ui-focus",
10799
+ "reactName": "onFlowUiFocus"
10630
10800
  }
10631
10801
  ],
10632
10802
  "attributes": [
@@ -10638,6 +10808,14 @@
10638
10808
  "description": "The name of the icon to draw. Available names depend on the icon library being used.",
10639
10809
  "fieldName": "name"
10640
10810
  },
10811
+ {
10812
+ "name": "library",
10813
+ "type": {
10814
+ "text": "string | undefined"
10815
+ },
10816
+ "description": "The name of a registered custom icon library.",
10817
+ "fieldName": "library"
10818
+ },
10641
10819
  {
10642
10820
  "name": "src",
10643
10821
  "type": {
@@ -10646,32 +10824,289 @@
10646
10824
  "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
10647
10825
  "fieldName": "src"
10648
10826
  },
10827
+ {
10828
+ "name": "href",
10829
+ "type": {
10830
+ "text": "string | undefined"
10831
+ },
10832
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
10833
+ "fieldName": "href"
10834
+ },
10835
+ {
10836
+ "name": "target",
10837
+ "type": {
10838
+ "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
10839
+ },
10840
+ "description": "Tells the browser where to open the link. Only used when `href` is set.",
10841
+ "fieldName": "target"
10842
+ },
10843
+ {
10844
+ "name": "download",
10845
+ "type": {
10846
+ "text": "string | undefined"
10847
+ },
10848
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
10849
+ "fieldName": "download"
10850
+ },
10649
10851
  {
10650
10852
  "name": "label",
10651
10853
  "type": {
10652
10854
  "text": "string"
10653
10855
  },
10654
10856
  "default": "''",
10655
- "description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
10857
+ "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
10656
10858
  "fieldName": "label"
10657
10859
  },
10658
10860
  {
10659
- "name": "library",
10861
+ "name": "tooltip",
10660
10862
  "type": {
10661
10863
  "text": "string"
10662
10864
  },
10663
- "default": "'default'",
10664
- "description": "The name of a registered custom icon library.",
10665
- "fieldName": "library"
10666
- }
10667
- ],
10668
- "superclass": {
10669
- "name": "FlowRdfElement",
10670
- "module": "/src/internal/flow-ui-rdf-element"
10671
- },
10672
- "tagName": "flow-ui-icon",
10673
- "summary": "Icons are symbols that can be used to represent various options within an application.",
10674
- "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/icon",
10865
+ "default": "''",
10866
+ "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
10867
+ "fieldName": "tooltip"
10868
+ },
10869
+ {
10870
+ "name": "tooltip-placement",
10871
+ "type": {
10872
+ "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
10873
+ },
10874
+ "default": "'top'",
10875
+ "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
10876
+ "fieldName": "tooltipPlacement"
10877
+ },
10878
+ {
10879
+ "name": "tooltip-distance",
10880
+ "type": {
10881
+ "text": "number"
10882
+ },
10883
+ "default": "8",
10884
+ "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
10885
+ "fieldName": "tooltipDistance"
10886
+ },
10887
+ {
10888
+ "name": "tooltip-skidding",
10889
+ "type": {
10890
+ "text": "number"
10891
+ },
10892
+ "default": "0",
10893
+ "description": "The distance in pixels from which to offset the tooltip along the icon button.",
10894
+ "fieldName": "tooltipSkidding"
10895
+ },
10896
+ {
10897
+ "name": "disabled",
10898
+ "type": {
10899
+ "text": "boolean"
10900
+ },
10901
+ "default": "false",
10902
+ "description": "Disables the button.",
10903
+ "fieldName": "disabled"
10904
+ },
10905
+ {
10906
+ "name": "confirm",
10907
+ "type": {
10908
+ "text": "string"
10909
+ },
10910
+ "default": "''",
10911
+ "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
10912
+ "fieldName": "confirm"
10913
+ }
10914
+ ],
10915
+ "superclass": {
10916
+ "name": "FlowRdfElement",
10917
+ "module": "/src/internal/flow-ui-rdf-element"
10918
+ },
10919
+ "tagName": "flow-ui-icon-button",
10920
+ "summary": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.",
10921
+ "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/icon-button",
10922
+ "status": "stable",
10923
+ "since": "2.0",
10924
+ "dependencies": [
10925
+ "flow-ui-icon",
10926
+ "flow-ui-tooltip"
10927
+ ],
10928
+ "customElement": true
10929
+ }
10930
+ ],
10931
+ "exports": [
10932
+ {
10933
+ "kind": "js",
10934
+ "name": "default",
10935
+ "declaration": {
10936
+ "name": "FlowUiIconButton",
10937
+ "module": "components/icon-button/icon-button.component.js"
10938
+ }
10939
+ }
10940
+ ]
10941
+ },
10942
+ {
10943
+ "kind": "javascript-module",
10944
+ "path": "components/icon-button/icon-button.js",
10945
+ "declarations": [],
10946
+ "exports": [
10947
+ {
10948
+ "kind": "js",
10949
+ "name": "*",
10950
+ "declaration": {
10951
+ "name": "*",
10952
+ "package": "./icon-button.component"
10953
+ }
10954
+ },
10955
+ {
10956
+ "kind": "js",
10957
+ "name": "default",
10958
+ "declaration": {
10959
+ "name": "FlowUiIconButton",
10960
+ "module": "components/icon-button/icon-button.js"
10961
+ }
10962
+ }
10963
+ ]
10964
+ },
10965
+ {
10966
+ "kind": "javascript-module",
10967
+ "path": "components/icon/icon.component.js",
10968
+ "declarations": [
10969
+ {
10970
+ "kind": "class",
10971
+ "description": "",
10972
+ "name": "FlowUiIcon",
10973
+ "cssParts": [
10974
+ {
10975
+ "description": "The internal SVG element.",
10976
+ "name": "svg"
10977
+ }
10978
+ ],
10979
+ "members": [
10980
+ {
10981
+ "kind": "method",
10982
+ "name": "resolveIcon",
10983
+ "privacy": "private",
10984
+ "static": true,
10985
+ "return": {
10986
+ "type": {
10987
+ "text": "Promise<SVGResult>"
10988
+ }
10989
+ },
10990
+ "parameters": [
10991
+ {
10992
+ "name": "url",
10993
+ "type": {
10994
+ "text": "string"
10995
+ }
10996
+ }
10997
+ ],
10998
+ "description": "Given a URL, this function returns the resulting SVG element or an appropriate error symbol."
10999
+ },
11000
+ {
11001
+ "kind": "field",
11002
+ "name": "svg",
11003
+ "type": {
11004
+ "text": "SVGElement | null"
11005
+ },
11006
+ "privacy": "private",
11007
+ "default": "null"
11008
+ },
11009
+ {
11010
+ "kind": "field",
11011
+ "name": "name",
11012
+ "type": {
11013
+ "text": "string | undefined"
11014
+ },
11015
+ "description": "The name of the icon to draw. Available names depend on the icon library being used.",
11016
+ "attribute": "name",
11017
+ "reflects": true
11018
+ },
11019
+ {
11020
+ "kind": "field",
11021
+ "name": "src",
11022
+ "type": {
11023
+ "text": "string | undefined"
11024
+ },
11025
+ "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
11026
+ "attribute": "src"
11027
+ },
11028
+ {
11029
+ "kind": "field",
11030
+ "name": "label",
11031
+ "type": {
11032
+ "text": "string"
11033
+ },
11034
+ "default": "''",
11035
+ "description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
11036
+ "attribute": "label"
11037
+ },
11038
+ {
11039
+ "kind": "field",
11040
+ "name": "library",
11041
+ "type": {
11042
+ "text": "string"
11043
+ },
11044
+ "default": "'default'",
11045
+ "description": "The name of a registered custom icon library.",
11046
+ "attribute": "library",
11047
+ "reflects": true
11048
+ },
11049
+ {
11050
+ "kind": "method",
11051
+ "name": "getUrl",
11052
+ "privacy": "private"
11053
+ }
11054
+ ],
11055
+ "events": [
11056
+ {
11057
+ "description": "Emitted when the icon has loaded.",
11058
+ "name": "flow-ui-load",
11059
+ "reactName": "onFlowUiLoad"
11060
+ },
11061
+ {
11062
+ "description": "Emitted when the icon fails to load due to an error.",
11063
+ "name": "flow-ui-error",
11064
+ "reactName": "onFlowUiError"
11065
+ }
11066
+ ],
11067
+ "attributes": [
11068
+ {
11069
+ "name": "name",
11070
+ "type": {
11071
+ "text": "string | undefined"
11072
+ },
11073
+ "description": "The name of the icon to draw. Available names depend on the icon library being used.",
11074
+ "fieldName": "name"
11075
+ },
11076
+ {
11077
+ "name": "src",
11078
+ "type": {
11079
+ "text": "string | undefined"
11080
+ },
11081
+ "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
11082
+ "fieldName": "src"
11083
+ },
11084
+ {
11085
+ "name": "label",
11086
+ "type": {
11087
+ "text": "string"
11088
+ },
11089
+ "default": "''",
11090
+ "description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
11091
+ "fieldName": "label"
11092
+ },
11093
+ {
11094
+ "name": "library",
11095
+ "type": {
11096
+ "text": "string"
11097
+ },
11098
+ "default": "'default'",
11099
+ "description": "The name of a registered custom icon library.",
11100
+ "fieldName": "library"
11101
+ }
11102
+ ],
11103
+ "superclass": {
11104
+ "name": "FlowRdfElement",
11105
+ "module": "/src/internal/flow-ui-rdf-element"
11106
+ },
11107
+ "tagName": "flow-ui-icon",
11108
+ "summary": "Icons are symbols that can be used to represent various options within an application.",
11109
+ "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/icon",
10675
11110
  "status": "stable",
10676
11111
  "since": "2.0",
10677
11112
  "customElement": true
@@ -10783,596 +11218,161 @@
10783
11218
  ],
10784
11219
  "exports": [
10785
11220
  {
10786
- "kind": "js",
10787
- "name": "default",
10788
- "declaration": {
10789
- "name": "systemLibrary",
10790
- "module": "components/icon/library.system.js"
10791
- }
10792
- }
10793
- ]
10794
- },
10795
- {
10796
- "kind": "javascript-module",
10797
- "path": "components/icon/library.js",
10798
- "declarations": [
10799
- {
10800
- "kind": "function",
10801
- "name": "watchIcon",
10802
- "parameters": [
10803
- {
10804
- "name": "icon",
10805
- "type": {
10806
- "text": "FlowIcon"
10807
- }
10808
- }
10809
- ],
10810
- "description": "Adds an icon to the list of watched icons."
10811
- },
10812
- {
10813
- "kind": "function",
10814
- "name": "unwatchIcon",
10815
- "parameters": [
10816
- {
10817
- "name": "icon",
10818
- "type": {
10819
- "text": "FlowIcon"
10820
- }
10821
- }
10822
- ],
10823
- "description": "Removes an icon from the list of watched icons."
10824
- },
10825
- {
10826
- "kind": "function",
10827
- "name": "getIconLibrary",
10828
- "parameters": [
10829
- {
10830
- "name": "name",
10831
- "optional": true,
10832
- "type": {
10833
- "text": "string"
10834
- }
10835
- }
10836
- ],
10837
- "description": "Returns a library from the registry."
10838
- },
10839
- {
10840
- "kind": "function",
10841
- "name": "registerIconLibrary",
10842
- "parameters": [
10843
- {
10844
- "name": "name",
10845
- "type": {
10846
- "text": "string"
10847
- },
10848
- "description": "The name of the custom icon library."
10849
- },
10850
- {
10851
- "name": "options",
10852
- "type": {
10853
- "text": "{ resolver: IconLibraryResolver; mutator?: IconLibraryMutator }"
10854
- },
10855
- "description": "The icon library resolver and optional mutator."
10856
- },
10857
- {
10858
- "description": "A function that returns the URL of given icon.",
10859
- "name": "options.resolver"
10860
- },
10861
- {
10862
- "description": "An optional function that mutates the SVG element of the icon.",
10863
- "name": "options.mutator"
10864
- }
10865
- ],
10866
- "description": "\nUse this function to add a custom icon library to the registry or override an existing one.\nProvide a resolver function that returns the URL of the icon based on its name.\nOptionally, provide a mutator function that modifies the SVG element of the icon.\n\nTwo icon libraries are included by default:\n- `system` (System icons used by `flow-rdf-ui` components)\n- `default` (FontAwesome 6.4.2)\n\nTo use a custom icon library, set the `library` property of the `<flow-ui-icon>` component\nto the registered name of the library. If omitted, the `default` library is used.\n\n```typescript\n// Register FontAwesome icon library using SVGs from Flo.w CDN\nregisterIconLibrary('fa', {\n resolver: (name) => {\n const filename = name.replace(/^fa[rbs]-/, '');\n let folder = 'regular';\n if (name.substring(0, 4) === 'fas-') folder = 'solid';\n if (name.substring(0, 4) === 'fab-') folder = 'brands';\n return `https://flow-cdn.emu-analytics.net/icons/fontawesome-6.4.2/${folder}/${filename}.svg`;\n },\n mutator: (svg) => svg.setAttribute('fill', 'currentColor')\n});\n```\n\n```html\n<flow-ui-icon library=\"fa\" name=\"fas-house\"></flow-ui-icon>\n```"
10867
- },
10868
- {
10869
- "kind": "function",
10870
- "name": "redrawWatchedIcons"
10871
- },
10872
- {
10873
- "kind": "function",
10874
- "name": "unregisterIconLibrary",
10875
- "parameters": [
10876
- {
10877
- "name": "name",
10878
- "type": {
10879
- "text": "string"
10880
- }
10881
- }
10882
- ],
10883
- "description": "Removes a custom icon library from the registry."
10884
- }
10885
- ],
10886
- "exports": [
10887
- {
10888
- "kind": "js",
10889
- "name": "addIcons",
10890
- "declaration": {
10891
- "name": "addIcons",
10892
- "module": "./library.default"
10893
- }
10894
- },
10895
- {
10896
- "kind": "js",
10897
- "name": "watchIcon",
10898
- "declaration": {
10899
- "name": "watchIcon",
10900
- "module": "components/icon/library.js"
10901
- }
10902
- },
10903
- {
10904
- "kind": "js",
10905
- "name": "unwatchIcon",
10906
- "declaration": {
10907
- "name": "unwatchIcon",
10908
- "module": "components/icon/library.js"
10909
- }
10910
- },
10911
- {
10912
- "kind": "js",
10913
- "name": "getIconLibrary",
10914
- "declaration": {
10915
- "name": "getIconLibrary",
10916
- "module": "components/icon/library.js"
10917
- }
10918
- },
10919
- {
10920
- "kind": "js",
10921
- "name": "registerIconLibrary",
10922
- "declaration": {
10923
- "name": "registerIconLibrary",
10924
- "module": "components/icon/library.js"
10925
- }
10926
- },
10927
- {
10928
- "kind": "js",
10929
- "name": "redrawWatchedIcons",
10930
- "declaration": {
10931
- "name": "redrawWatchedIcons",
10932
- "module": "components/icon/library.js"
10933
- }
10934
- },
10935
- {
10936
- "kind": "js",
10937
- "name": "unregisterIconLibrary",
10938
- "declaration": {
10939
- "name": "unregisterIconLibrary",
10940
- "module": "components/icon/library.js"
10941
- }
10942
- }
10943
- ]
10944
- },
10945
- {
10946
- "kind": "javascript-module",
10947
- "path": "components/icon-button/icon-button.component.js",
10948
- "declarations": [
10949
- {
10950
- "kind": "class",
10951
- "description": "",
10952
- "name": "FlowUiIconButton",
10953
- "cssParts": [
10954
- {
10955
- "description": "The component's base wrapper.",
10956
- "name": "base"
10957
- }
10958
- ],
10959
- "slots": [
10960
- {
10961
- "description": "The tooltip content to display when the user hovers over the icon button. Alternatively, you can use the `tooltip` attribute.",
10962
- "name": "tooltip"
10963
- }
10964
- ],
10965
- "members": [
10966
- {
10967
- "kind": "field",
10968
- "name": "hasSlotController",
10969
- "privacy": "private",
10970
- "readonly": true,
10971
- "default": "new HasSlotController(this, 'tooltip')"
10972
- },
10973
- {
10974
- "kind": "field",
10975
- "name": "tooltipAnimating",
10976
- "type": {
10977
- "text": "boolean"
10978
- },
10979
- "privacy": "private",
10980
- "default": "false"
10981
- },
10982
- {
10983
- "kind": "field",
10984
- "name": "hasFocus",
10985
- "type": {
10986
- "text": "boolean"
10987
- },
10988
- "privacy": "private",
10989
- "default": "false"
10990
- },
10991
- {
10992
- "kind": "field",
10993
- "name": "name",
10994
- "type": {
10995
- "text": "string | undefined"
10996
- },
10997
- "description": "The name of the icon to draw. Available names depend on the icon library being used.",
10998
- "attribute": "name"
10999
- },
11000
- {
11001
- "kind": "field",
11002
- "name": "library",
11003
- "type": {
11004
- "text": "string | undefined"
11005
- },
11006
- "description": "The name of a registered custom icon library.",
11007
- "attribute": "library"
11008
- },
11009
- {
11010
- "kind": "field",
11011
- "name": "src",
11012
- "type": {
11013
- "text": "string | undefined"
11014
- },
11015
- "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
11016
- "attribute": "src"
11017
- },
11018
- {
11019
- "kind": "field",
11020
- "name": "href",
11021
- "type": {
11022
- "text": "string | undefined"
11023
- },
11024
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
11025
- "attribute": "href"
11026
- },
11027
- {
11028
- "kind": "field",
11029
- "name": "target",
11030
- "type": {
11031
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
11032
- },
11033
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
11034
- "attribute": "target"
11035
- },
11036
- {
11037
- "kind": "field",
11038
- "name": "download",
11039
- "type": {
11040
- "text": "string | undefined"
11041
- },
11042
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
11043
- "attribute": "download"
11044
- },
11045
- {
11046
- "kind": "field",
11047
- "name": "label",
11048
- "type": {
11049
- "text": "string"
11050
- },
11051
- "default": "''",
11052
- "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
11053
- "attribute": "label"
11054
- },
11055
- {
11056
- "kind": "field",
11057
- "name": "tooltip",
11058
- "type": {
11059
- "text": "string"
11060
- },
11061
- "default": "''",
11062
- "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
11063
- "attribute": "tooltip"
11064
- },
11065
- {
11066
- "kind": "field",
11067
- "name": "tooltipPlacement",
11068
- "type": {
11069
- "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
11070
- },
11071
- "default": "'top'",
11072
- "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
11073
- "attribute": "tooltip-placement"
11074
- },
11075
- {
11076
- "kind": "field",
11077
- "name": "tooltipDistance",
11078
- "type": {
11079
- "text": "number"
11080
- },
11081
- "default": "8",
11082
- "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
11083
- "attribute": "tooltip-distance"
11084
- },
11085
- {
11086
- "kind": "field",
11087
- "name": "tooltipSkidding",
11088
- "type": {
11089
- "text": "number"
11090
- },
11091
- "default": "0",
11092
- "description": "The distance in pixels from which to offset the tooltip along the icon button.",
11093
- "attribute": "tooltip-skidding"
11094
- },
11095
- {
11096
- "kind": "field",
11097
- "name": "disabled",
11098
- "type": {
11099
- "text": "boolean"
11100
- },
11101
- "default": "false",
11102
- "description": "Disables the button.",
11103
- "attribute": "disabled",
11104
- "reflects": true
11105
- },
11106
- {
11107
- "kind": "field",
11108
- "name": "confirm",
11109
- "type": {
11110
- "text": "string"
11111
- },
11112
- "default": "''",
11113
- "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
11114
- "attribute": "confirm"
11115
- },
11116
- {
11117
- "kind": "method",
11118
- "name": "handleBlur",
11119
- "privacy": "private"
11120
- },
11121
- {
11122
- "kind": "method",
11123
- "name": "handleFocus",
11124
- "privacy": "private"
11125
- },
11126
- {
11127
- "kind": "method",
11128
- "name": "handleClick",
11129
- "privacy": "protected",
11130
- "parameters": [
11131
- {
11132
- "name": "event",
11133
- "type": {
11134
- "text": "MouseEvent"
11135
- }
11136
- }
11137
- ]
11138
- },
11139
- {
11140
- "kind": "method",
11141
- "name": "click",
11142
- "description": "Simulates a click on the icon button."
11143
- },
11144
- {
11145
- "kind": "method",
11146
- "name": "focus",
11147
- "parameters": [
11148
- {
11149
- "name": "options",
11150
- "optional": true,
11151
- "type": {
11152
- "text": "FocusOptions"
11153
- }
11154
- }
11155
- ],
11156
- "description": "Sets focus on the icon button."
11157
- },
11158
- {
11159
- "kind": "method",
11160
- "name": "blur",
11161
- "description": "Removes focus from the icon button."
11162
- },
11163
- {
11164
- "kind": "method",
11165
- "name": "hideConfirm",
11166
- "description": "Hide the confirmation tooltip if it is showing"
11167
- },
11168
- {
11169
- "kind": "method",
11170
- "name": "showConfirm",
11171
- "description": "Show the confirmation tooltip"
11172
- },
11173
- {
11174
- "kind": "method",
11175
- "name": "handleConfirmClick",
11176
- "privacy": "private"
11177
- },
11178
- {
11179
- "kind": "method",
11180
- "name": "renderWithTooltip",
11181
- "privacy": "private",
11182
- "parameters": [
11183
- {
11184
- "name": "contents",
11185
- "type": {
11186
- "text": "TemplateResult"
11187
- }
11188
- }
11189
- ]
11190
- },
11221
+ "kind": "js",
11222
+ "name": "default",
11223
+ "declaration": {
11224
+ "name": "systemLibrary",
11225
+ "module": "components/icon/library.system.js"
11226
+ }
11227
+ }
11228
+ ]
11229
+ },
11230
+ {
11231
+ "kind": "javascript-module",
11232
+ "path": "components/icon/library.js",
11233
+ "declarations": [
11234
+ {
11235
+ "kind": "function",
11236
+ "name": "watchIcon",
11237
+ "parameters": [
11191
11238
  {
11192
- "kind": "method",
11193
- "name": "renderWithConfirmation",
11194
- "privacy": "private",
11195
- "parameters": [
11196
- {
11197
- "name": "contents",
11198
- "type": {
11199
- "text": "TemplateResult"
11200
- }
11201
- }
11202
- ]
11239
+ "name": "icon",
11240
+ "type": {
11241
+ "text": "FlowIcon"
11242
+ }
11203
11243
  }
11204
11244
  ],
11205
- "events": [
11206
- {
11207
- "description": "Emitted when the icon button loses focus.",
11208
- "name": "flow-ui-blur",
11209
- "reactName": "onFlowUiBlur"
11210
- },
11245
+ "description": "Adds an icon to the list of watched icons."
11246
+ },
11247
+ {
11248
+ "kind": "function",
11249
+ "name": "unwatchIcon",
11250
+ "parameters": [
11211
11251
  {
11212
- "description": "Emitted when the icon button gains focus.",
11213
- "name": "flow-ui-focus",
11214
- "reactName": "onFlowUiFocus"
11252
+ "name": "icon",
11253
+ "type": {
11254
+ "text": "FlowIcon"
11255
+ }
11215
11256
  }
11216
11257
  ],
11217
- "attributes": [
11258
+ "description": "Removes an icon from the list of watched icons."
11259
+ },
11260
+ {
11261
+ "kind": "function",
11262
+ "name": "getIconLibrary",
11263
+ "parameters": [
11218
11264
  {
11219
11265
  "name": "name",
11220
- "type": {
11221
- "text": "string | undefined"
11222
- },
11223
- "description": "The name of the icon to draw. Available names depend on the icon library being used.",
11224
- "fieldName": "name"
11225
- },
11226
- {
11227
- "name": "library",
11228
- "type": {
11229
- "text": "string | undefined"
11230
- },
11231
- "description": "The name of a registered custom icon library.",
11232
- "fieldName": "library"
11233
- },
11234
- {
11235
- "name": "src",
11236
- "type": {
11237
- "text": "string | undefined"
11238
- },
11239
- "description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
11240
- "fieldName": "src"
11241
- },
11242
- {
11243
- "name": "href",
11244
- "type": {
11245
- "text": "string | undefined"
11246
- },
11247
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
11248
- "fieldName": "href"
11249
- },
11250
- {
11251
- "name": "target",
11252
- "type": {
11253
- "text": "'_blank' | '_parent' | '_self' | '_top' | undefined"
11254
- },
11255
- "description": "Tells the browser where to open the link. Only used when `href` is set.",
11256
- "fieldName": "target"
11257
- },
11258
- {
11259
- "name": "download",
11260
- "type": {
11261
- "text": "string | undefined"
11262
- },
11263
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
11264
- "fieldName": "download"
11265
- },
11266
- {
11267
- "name": "label",
11266
+ "optional": true,
11268
11267
  "type": {
11269
11268
  "text": "string"
11270
- },
11271
- "default": "''",
11272
- "description": "A description that gets read by assistive devices. For optimal accessibility, you should always include a label\nthat describes what the icon button does.",
11273
- "fieldName": "label"
11274
- },
11269
+ }
11270
+ }
11271
+ ],
11272
+ "description": "Returns a library from the registry."
11273
+ },
11274
+ {
11275
+ "kind": "function",
11276
+ "name": "registerIconLibrary",
11277
+ "parameters": [
11275
11278
  {
11276
- "name": "tooltip",
11279
+ "name": "name",
11277
11280
  "type": {
11278
11281
  "text": "string"
11279
11282
  },
11280
- "default": "''",
11281
- "description": "Tooltip text that gets displayed when the user hovers over the icon button. If you need to display HTML, use the\n`tooltip` slot instead.",
11282
- "fieldName": "tooltip"
11283
- },
11284
- {
11285
- "name": "tooltip-placement",
11286
- "type": {
11287
- "text": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
11288
- },
11289
- "default": "'top'",
11290
- "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
11291
- "fieldName": "tooltipPlacement"
11283
+ "description": "The name of the custom icon library."
11292
11284
  },
11293
11285
  {
11294
- "name": "tooltip-distance",
11286
+ "name": "options",
11295
11287
  "type": {
11296
- "text": "number"
11288
+ "text": "{ resolver: IconLibraryResolver; mutator?: IconLibraryMutator }"
11297
11289
  },
11298
- "default": "8",
11299
- "description": "The distance in pixels from which to offset the tooltip away from the icon button.",
11300
- "fieldName": "tooltipDistance"
11290
+ "description": "The icon library resolver and optional mutator."
11301
11291
  },
11302
11292
  {
11303
- "name": "tooltip-skidding",
11304
- "type": {
11305
- "text": "number"
11306
- },
11307
- "default": "0",
11308
- "description": "The distance in pixels from which to offset the tooltip along the icon button.",
11309
- "fieldName": "tooltipSkidding"
11293
+ "description": "A function that returns the URL of given icon.",
11294
+ "name": "options.resolver"
11310
11295
  },
11311
11296
  {
11312
- "name": "disabled",
11313
- "type": {
11314
- "text": "boolean"
11315
- },
11316
- "default": "false",
11317
- "description": "Disables the button.",
11318
- "fieldName": "disabled"
11319
- },
11297
+ "description": "An optional function that mutates the SVG element of the icon.",
11298
+ "name": "options.mutator"
11299
+ }
11300
+ ],
11301
+ "description": "\nUse this function to add a custom icon library to the registry or override an existing one.\nProvide a resolver function that returns the URL of the icon based on its name.\nOptionally, provide a mutator function that modifies the SVG element of the icon.\n\nTwo icon libraries are included by default:\n- `system` (System icons used by `flow-rdf-ui` components)\n- `default` (FontAwesome 6.4.2)\n\nTo use a custom icon library, set the `library` property of the `<flow-ui-icon>` component\nto the registered name of the library. If omitted, the `default` library is used.\n\n```typescript\n// Register FontAwesome icon library using SVGs from Flo.w CDN\nregisterIconLibrary('fa', {\n resolver: (name) => {\n const filename = name.replace(/^fa[rbs]-/, '');\n let folder = 'regular';\n if (name.substring(0, 4) === 'fas-') folder = 'solid';\n if (name.substring(0, 4) === 'fab-') folder = 'brands';\n return `https://flow-cdn.emu-analytics.net/icons/fontawesome-6.4.2/${folder}/${filename}.svg`;\n },\n mutator: (svg) => svg.setAttribute('fill', 'currentColor')\n});\n```\n\n```html\n<flow-ui-icon library=\"fa\" name=\"fas-house\"></flow-ui-icon>\n```"
11302
+ },
11303
+ {
11304
+ "kind": "function",
11305
+ "name": "redrawWatchedIcons"
11306
+ },
11307
+ {
11308
+ "kind": "function",
11309
+ "name": "unregisterIconLibrary",
11310
+ "parameters": [
11320
11311
  {
11321
- "name": "confirm",
11312
+ "name": "name",
11322
11313
  "type": {
11323
11314
  "text": "string"
11324
- },
11325
- "default": "''",
11326
- "description": "Confirmation text that gets displayed in a tooltip when the user clicks the icon button.\n If you need to display HTML, use the `confirm` slot instead.",
11327
- "fieldName": "confirm"
11315
+ }
11328
11316
  }
11329
11317
  ],
11330
- "superclass": {
11331
- "name": "FlowRdfElement",
11332
- "module": "/src/internal/flow-ui-rdf-element"
11333
- },
11334
- "tagName": "flow-ui-icon-button",
11335
- "summary": "Icons buttons are simple, icon-only buttons that can be used for actions and in toolbars.",
11336
- "documentation": "https://developer.emu-analytics.net/docs/flow-ui-rdf/components/icon-button",
11337
- "status": "stable",
11338
- "since": "2.0",
11339
- "dependencies": [
11340
- "flow-ui-icon",
11341
- "flow-ui-tooltip"
11342
- ],
11343
- "customElement": true
11318
+ "description": "Removes a custom icon library from the registry."
11344
11319
  }
11345
11320
  ],
11346
11321
  "exports": [
11347
11322
  {
11348
11323
  "kind": "js",
11349
- "name": "default",
11324
+ "name": "addIcons",
11350
11325
  "declaration": {
11351
- "name": "FlowUiIconButton",
11352
- "module": "components/icon-button/icon-button.component.js"
11326
+ "name": "addIcons",
11327
+ "module": "./library.default"
11353
11328
  }
11354
- }
11355
- ]
11356
- },
11357
- {
11358
- "kind": "javascript-module",
11359
- "path": "components/icon-button/icon-button.js",
11360
- "declarations": [],
11361
- "exports": [
11329
+ },
11362
11330
  {
11363
11331
  "kind": "js",
11364
- "name": "*",
11332
+ "name": "watchIcon",
11365
11333
  "declaration": {
11366
- "name": "*",
11367
- "package": "./icon-button.component"
11334
+ "name": "watchIcon",
11335
+ "module": "components/icon/library.js"
11368
11336
  }
11369
11337
  },
11370
11338
  {
11371
11339
  "kind": "js",
11372
- "name": "default",
11340
+ "name": "unwatchIcon",
11373
11341
  "declaration": {
11374
- "name": "FlowUiIconButton",
11375
- "module": "components/icon-button/icon-button.js"
11342
+ "name": "unwatchIcon",
11343
+ "module": "components/icon/library.js"
11344
+ }
11345
+ },
11346
+ {
11347
+ "kind": "js",
11348
+ "name": "getIconLibrary",
11349
+ "declaration": {
11350
+ "name": "getIconLibrary",
11351
+ "module": "components/icon/library.js"
11352
+ }
11353
+ },
11354
+ {
11355
+ "kind": "js",
11356
+ "name": "registerIconLibrary",
11357
+ "declaration": {
11358
+ "name": "registerIconLibrary",
11359
+ "module": "components/icon/library.js"
11360
+ }
11361
+ },
11362
+ {
11363
+ "kind": "js",
11364
+ "name": "redrawWatchedIcons",
11365
+ "declaration": {
11366
+ "name": "redrawWatchedIcons",
11367
+ "module": "components/icon/library.js"
11368
+ }
11369
+ },
11370
+ {
11371
+ "kind": "js",
11372
+ "name": "unregisterIconLibrary",
11373
+ "declaration": {
11374
+ "name": "unregisterIconLibrary",
11375
+ "module": "components/icon/library.js"
11376
11376
  }
11377
11377
  }
11378
11378
  ]
@@ -25895,6 +25895,6 @@
25895
25895
  ],
25896
25896
  "package": {
25897
25897
  "name": "@emuanalytics/flow-rdf-ui",
25898
- "version": "4.1.18"
25898
+ "version": "4.1.20"
25899
25899
  }
25900
25900
  }