@momentum-design/components 0.7.12 → 0.7.14

Sign up to get free protection for your applications and to get access to all the features.
@@ -127,7 +127,7 @@
127
127
  "kind": "field",
128
128
  "name": "type",
129
129
  "type": {
130
- "text": "string | undefined"
130
+ "text": "BadgeType | undefined"
131
131
  },
132
132
  "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
133
133
  "attribute": "type",
@@ -145,6 +145,9 @@
145
145
  {
146
146
  "kind": "field",
147
147
  "name": "variant",
148
+ "type": {
149
+ "text": "IconVariant"
150
+ },
148
151
  "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
149
152
  "default": "primary",
150
153
  "attribute": "variant",
@@ -236,26 +239,11 @@
236
239
  "description": "the name of the icon from the icon set"
237
240
  },
238
241
  {
239
- "name": "overlay",
240
- "type": {
241
- "text": "boolean"
242
- },
243
- "description": "boolean indicating whether the badge should have an overlay."
244
- },
245
- {
246
- "name": "iconVariant",
242
+ "name": "backgroundClassPostfix",
247
243
  "type": {
248
244
  "text": "string"
249
245
  },
250
- "description": "the variant of the icon badge."
251
- },
252
- {
253
- "name": "type",
254
- "optional": true,
255
- "type": {
256
- "text": "string"
257
- },
258
- "description": "the type of the badge."
246
+ "description": "postfix for the class to style the badge icon."
259
247
  }
260
248
  ],
261
249
  "description": "Method to generate the badge icon."
@@ -269,52 +257,8 @@
269
257
  "text": ""
270
258
  }
271
259
  },
272
- "parameters": [
273
- {
274
- "name": "overlay",
275
- "type": {
276
- "text": "boolean"
277
- },
278
- "description": "boolean indicating whether the badge should have an overlay."
279
- }
280
- ],
281
260
  "description": "Method to generate the badge dot template."
282
261
  },
283
- {
284
- "kind": "method",
285
- "name": "getIconClasses",
286
- "privacy": "private",
287
- "return": {
288
- "type": {
289
- "text": ""
290
- }
291
- },
292
- "parameters": [
293
- {
294
- "name": "overlay",
295
- "type": {
296
- "text": "boolean"
297
- },
298
- "description": "boolean indicating whether the badge should have an overlay."
299
- },
300
- {
301
- "name": "iconVariant",
302
- "type": {
303
- "text": "string"
304
- },
305
- "description": "the variant of the icon badge."
306
- },
307
- {
308
- "name": "type",
309
- "optional": true,
310
- "type": {
311
- "text": "string"
312
- },
313
- "description": "the type of the badge."
314
- }
315
- ],
316
- "description": "This method generates the CSS classes for the badge icon."
317
- },
318
262
  {
319
263
  "kind": "method",
320
264
  "name": "getBadgeCounterText",
@@ -324,30 +268,6 @@
324
268
  "text": ""
325
269
  }
326
270
  },
327
- "parameters": [
328
- {
329
- "name": "maxCounter",
330
- "type": {
331
- "text": "number"
332
- },
333
- "description": "the maximum limit which can be displayed on the badge"
334
- },
335
- {
336
- "name": "overlay",
337
- "type": {
338
- "text": "boolean"
339
- },
340
- "description": "whether the badge should have an overlay."
341
- },
342
- {
343
- "name": "counter",
344
- "optional": true,
345
- "type": {
346
- "text": "number"
347
- },
348
- "description": "the number to be displayed on the badge"
349
- }
350
- ],
351
271
  "description": "Method to generate the badge text and counter template."
352
272
  },
353
273
  {
@@ -377,7 +297,7 @@
377
297
  {
378
298
  "name": "type",
379
299
  "type": {
380
- "text": "string | undefined"
300
+ "text": "BadgeType | undefined"
381
301
  },
382
302
  "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
383
303
  "fieldName": "type"
@@ -392,6 +312,9 @@
392
312
  },
393
313
  {
394
314
  "name": "variant",
315
+ "type": {
316
+ "text": "IconVariant"
317
+ },
395
318
  "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
396
319
  "default": "primary",
397
320
  "fieldName": "variant"
@@ -452,144 +375,6 @@
452
375
  }
453
376
  ]
454
377
  },
455
- {
456
- "kind": "javascript-module",
457
- "path": "components/iconprovider/iconprovider.component.js",
458
- "declarations": [
459
- {
460
- "kind": "class",
461
- "description": "IconProvider component, which allows to be consumed from sub components\n(see `providerUtils.consume` for how to consume)\n\nBundling icons will be up to the consumer of this component, such\nthat only a url has to be passed in from which the icons will be\nfetched.",
462
- "name": "IconProvider",
463
- "slots": [
464
- {
465
- "description": "children",
466
- "name": ""
467
- }
468
- ],
469
- "members": [
470
- {
471
- "kind": "field",
472
- "name": "Context",
473
- "privacy": "public",
474
- "static": true,
475
- "description": "Context object of the IconProvider, to be consumed by child components",
476
- "readonly": true
477
- },
478
- {
479
- "kind": "field",
480
- "name": "url",
481
- "type": {
482
- "text": "string | undefined"
483
- },
484
- "description": "Url of where icons will be fetched from",
485
- "attribute": "url"
486
- },
487
- {
488
- "kind": "field",
489
- "name": "fileExtension",
490
- "type": {
491
- "text": "string | undefined"
492
- },
493
- "description": "File extension of icons",
494
- "default": "svg",
495
- "attribute": "file-extension",
496
- "reflects": true
497
- },
498
- {
499
- "kind": "field",
500
- "name": "lengthUnit",
501
- "type": {
502
- "text": "string"
503
- },
504
- "description": "Length unit used for sizing of icons",
505
- "default": "em",
506
- "attribute": "length-unit",
507
- "reflects": true
508
- },
509
- {
510
- "kind": "field",
511
- "name": "size",
512
- "type": {
513
- "text": "number | undefined"
514
- },
515
- "description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
516
- "default": "1",
517
- "attribute": "size",
518
- "reflects": true
519
- },
520
- {
521
- "kind": "method",
522
- "name": "updateValuesInContext",
523
- "privacy": "private"
524
- },
525
- {
526
- "kind": "method",
527
- "name": "updateContext",
528
- "privacy": "protected",
529
- "return": {
530
- "type": {
531
- "text": "void"
532
- }
533
- }
534
- }
535
- ],
536
- "attributes": [
537
- {
538
- "name": "url",
539
- "type": {
540
- "text": "string | undefined"
541
- },
542
- "description": "Url of where icons will be fetched from",
543
- "fieldName": "url"
544
- },
545
- {
546
- "name": "file-extension",
547
- "type": {
548
- "text": "string | undefined"
549
- },
550
- "description": "File extension of icons",
551
- "default": "svg",
552
- "fieldName": "fileExtension"
553
- },
554
- {
555
- "name": "length-unit",
556
- "type": {
557
- "text": "string"
558
- },
559
- "description": "Length unit used for sizing of icons",
560
- "default": "em",
561
- "fieldName": "lengthUnit"
562
- },
563
- {
564
- "name": "size",
565
- "type": {
566
- "text": "number | undefined"
567
- },
568
- "description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
569
- "default": "1",
570
- "fieldName": "size"
571
- }
572
- ],
573
- "superclass": {
574
- "name": "Provider",
575
- "module": "/src/models"
576
- },
577
- "tagName": "mdc-iconprovider",
578
- "jsDoc": "/**\n * IconProvider component, which allows to be consumed from sub components\n * (see `providerUtils.consume` for how to consume)\n *\n * Bundling icons will be up to the consumer of this component, such\n * that only a url has to be passed in from which the icons will be\n * fetched.\n *\n * @tagname mdc-iconprovider\n *\n * @slot - children\n */",
579
- "customElement": true
580
- }
581
- ],
582
- "exports": [
583
- {
584
- "kind": "js",
585
- "name": "default",
586
- "declaration": {
587
- "name": "IconProvider",
588
- "module": "components/iconprovider/iconprovider.component.js"
589
- }
590
- }
591
- ]
592
- },
593
378
  {
594
379
  "kind": "javascript-module",
595
380
  "path": "components/icon/icon.component.js",
@@ -762,6 +547,144 @@
762
547
  }
763
548
  ]
764
549
  },
550
+ {
551
+ "kind": "javascript-module",
552
+ "path": "components/iconprovider/iconprovider.component.js",
553
+ "declarations": [
554
+ {
555
+ "kind": "class",
556
+ "description": "IconProvider component, which allows to be consumed from sub components\n(see `providerUtils.consume` for how to consume)\n\nBundling icons will be up to the consumer of this component, such\nthat only a url has to be passed in from which the icons will be\nfetched.",
557
+ "name": "IconProvider",
558
+ "slots": [
559
+ {
560
+ "description": "children",
561
+ "name": ""
562
+ }
563
+ ],
564
+ "members": [
565
+ {
566
+ "kind": "field",
567
+ "name": "Context",
568
+ "privacy": "public",
569
+ "static": true,
570
+ "description": "Context object of the IconProvider, to be consumed by child components",
571
+ "readonly": true
572
+ },
573
+ {
574
+ "kind": "field",
575
+ "name": "url",
576
+ "type": {
577
+ "text": "string | undefined"
578
+ },
579
+ "description": "Url of where icons will be fetched from",
580
+ "attribute": "url"
581
+ },
582
+ {
583
+ "kind": "field",
584
+ "name": "fileExtension",
585
+ "type": {
586
+ "text": "string | undefined"
587
+ },
588
+ "description": "File extension of icons",
589
+ "default": "svg",
590
+ "attribute": "file-extension",
591
+ "reflects": true
592
+ },
593
+ {
594
+ "kind": "field",
595
+ "name": "lengthUnit",
596
+ "type": {
597
+ "text": "string"
598
+ },
599
+ "description": "Length unit used for sizing of icons",
600
+ "default": "em",
601
+ "attribute": "length-unit",
602
+ "reflects": true
603
+ },
604
+ {
605
+ "kind": "field",
606
+ "name": "size",
607
+ "type": {
608
+ "text": "number | undefined"
609
+ },
610
+ "description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
611
+ "default": "1",
612
+ "attribute": "size",
613
+ "reflects": true
614
+ },
615
+ {
616
+ "kind": "method",
617
+ "name": "updateValuesInContext",
618
+ "privacy": "private"
619
+ },
620
+ {
621
+ "kind": "method",
622
+ "name": "updateContext",
623
+ "privacy": "protected",
624
+ "return": {
625
+ "type": {
626
+ "text": "void"
627
+ }
628
+ }
629
+ }
630
+ ],
631
+ "attributes": [
632
+ {
633
+ "name": "url",
634
+ "type": {
635
+ "text": "string | undefined"
636
+ },
637
+ "description": "Url of where icons will be fetched from",
638
+ "fieldName": "url"
639
+ },
640
+ {
641
+ "name": "file-extension",
642
+ "type": {
643
+ "text": "string | undefined"
644
+ },
645
+ "description": "File extension of icons",
646
+ "default": "svg",
647
+ "fieldName": "fileExtension"
648
+ },
649
+ {
650
+ "name": "length-unit",
651
+ "type": {
652
+ "text": "string"
653
+ },
654
+ "description": "Length unit used for sizing of icons",
655
+ "default": "em",
656
+ "fieldName": "lengthUnit"
657
+ },
658
+ {
659
+ "name": "size",
660
+ "type": {
661
+ "text": "number | undefined"
662
+ },
663
+ "description": "The default size of the icon.\nIf not set, it falls back to the size defined by the length unit.",
664
+ "default": "1",
665
+ "fieldName": "size"
666
+ }
667
+ ],
668
+ "superclass": {
669
+ "name": "Provider",
670
+ "module": "/src/models"
671
+ },
672
+ "tagName": "mdc-iconprovider",
673
+ "jsDoc": "/**\n * IconProvider component, which allows to be consumed from sub components\n * (see `providerUtils.consume` for how to consume)\n *\n * Bundling icons will be up to the consumer of this component, such\n * that only a url has to be passed in from which the icons will be\n * fetched.\n *\n * @tagname mdc-iconprovider\n *\n * @slot - children\n */",
674
+ "customElement": true
675
+ }
676
+ ],
677
+ "exports": [
678
+ {
679
+ "kind": "js",
680
+ "name": "default",
681
+ "declaration": {
682
+ "name": "IconProvider",
683
+ "module": "components/iconprovider/iconprovider.component.js"
684
+ }
685
+ }
686
+ ]
687
+ },
765
688
  {
766
689
  "kind": "javascript-module",
767
690
  "path": "components/presence/presence.component.js",
@@ -774,6 +697,9 @@
774
697
  {
775
698
  "kind": "field",
776
699
  "name": "type",
700
+ "type": {
701
+ "text": "PresenceType"
702
+ },
777
703
  "description": "Supported presence types:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
778
704
  "default": "active",
779
705
  "attribute": "type",
@@ -782,6 +708,9 @@
782
708
  {
783
709
  "kind": "field",
784
710
  "name": "size",
711
+ "type": {
712
+ "text": "PresenceSize"
713
+ },
785
714
  "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE",
786
715
  "default": "small",
787
716
  "attribute": "size",
@@ -805,12 +734,18 @@
805
734
  "attributes": [
806
735
  {
807
736
  "name": "type",
737
+ "type": {
738
+ "text": "PresenceType"
739
+ },
808
740
  "description": "Supported presence types:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
809
741
  "default": "active",
810
742
  "fieldName": "type"
811
743
  },
812
744
  {
813
745
  "name": "size",
746
+ "type": {
747
+ "text": "PresenceSize"
748
+ },
814
749
  "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE",
815
750
  "default": "small",
816
751
  "fieldName": "size"
@@ -860,6 +795,9 @@
860
795
  {
861
796
  "kind": "field",
862
797
  "name": "type",
798
+ "type": {
799
+ "text": "FontType"
800
+ },
863
801
  "privacy": "public",
864
802
  "description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
865
803
  "default": "body-large-regular",
@@ -869,6 +807,9 @@
869
807
  {
870
808
  "kind": "field",
871
809
  "name": "tagname",
810
+ "type": {
811
+ "text": "TagName | undefined"
812
+ },
872
813
  "privacy": "public",
873
814
  "description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
874
815
  "attribute": "tagname",
@@ -878,12 +819,18 @@
878
819
  "attributes": [
879
820
  {
880
821
  "name": "type",
822
+ "type": {
823
+ "text": "FontType"
824
+ },
881
825
  "description": "Specifies the text style to be applied.\n\nAcceptable values include:\n\n- 'body-small-regular'\n- 'body-small-medium'\n- 'body-small-bold'\n- 'body-midsize-regular'\n- 'body-midsize-medium'\n- 'body-midsize-bold'\n- 'body-large-regular'\n- 'body-large-medium'\n- 'body-large-bold'\n- 'body-small-regular-underline'\n- 'body-small-medium-underline'\n- 'body-midsize-regular-underline'\n- 'body-midsize-medium-underline'\n- 'body-large-regular-underline'\n- 'body-large-medium-underline'\n- 'heading-small-regular'\n- 'heading-small-medium'\n- 'heading-small-bold'\n- 'heading-midsize-regular'\n- 'heading-midsize-medium'\n- 'heading-midsize-bold'\n- 'heading-large-regular'\n- 'heading-large-medium'\n- 'heading-large-bold'\n- 'heading-xlarge-regular'\n- 'heading-xlarge-medium'\n- 'heading-xlarge-bold'\n- 'headline-small-light'\n- 'headline-small-regular'",
882
826
  "default": "body-large-regular",
883
827
  "fieldName": "type"
884
828
  },
885
829
  {
886
830
  "name": "tagname",
831
+ "type": {
832
+ "text": "TagName | undefined"
833
+ },
887
834
  "description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the text element.\n\nAcceptable values include:\n\n- 'h1'\n- 'h2'\n- 'h3'\n- 'h4'\n- 'h5'\n- 'h6'\n- 'p'\n- 'small'\n- 'span'\n- 'div'\n\nFor instance, setting this attribute to `h2` will render the text element as an `h2` element.\nNote that the styling is determined by the `type` attribute.",
888
835
  "fieldName": "tagname"
889
836
  }
@@ -1,7 +1,7 @@
1
1
  export { default as Avatar } from './avatar';
2
2
  export { default as Badge } from './badge';
3
- export { default as IconProvider } from './iconprovider';
4
3
  export { default as Icon } from './icon';
4
+ export { default as IconProvider } from './iconprovider';
5
5
  export { default as Presence } from './presence';
6
6
  export { default as Text } from './text';
7
7
  export { default as ThemeProvider } from './themeprovider';
@@ -1,7 +1,7 @@
1
1
  export { default as Avatar } from './avatar';
2
2
  export { default as Badge } from './badge';
3
- export { default as IconProvider } from './iconprovider';
4
3
  export { default as Icon } from './icon';
4
+ export { default as IconProvider } from './iconprovider';
5
5
  export { default as Presence } from './presence';
6
6
  export { default as Text } from './text';
7
7
  export { default as ThemeProvider } from './themeprovider';
package/package.json CHANGED
@@ -37,5 +37,5 @@
37
37
  "@momentum-design/icons": "*",
38
38
  "@momentum-design/tokens": "*"
39
39
  },
40
- "version": "0.7.12"
40
+ "version": "0.7.14"
41
41
  }