@momentum-design/components 0.15.3 → 0.15.5

Sign up to get free protection for your applications and to get access to all the features.
@@ -56,7 +56,7 @@ declare class Button extends Buttonsimple {
56
56
  * Button sizing is based on the button type.
57
57
  * - **Pill button**: 40, 32, 28, 24.
58
58
  * - **Icon button**: 64, 52, 40, 32, 28, 24.
59
- * - Tertiary icon button cam also be 20.
59
+ * - Tertiary icon button can also be 20.
60
60
  * @default 32
61
61
  */
62
62
  size: PillButtonSize | IconButtonSize;
@@ -60,7 +60,7 @@ class Button extends Buttonsimple {
60
60
  * Button sizing is based on the button type.
61
61
  * - **Pill button**: 40, 32, 28, 24.
62
62
  * - **Icon button**: 64, 52, 40, 32, 28, 24.
63
- * - Tertiary icon button cam also be 20.
63
+ * - Tertiary icon button can also be 20.
64
64
  * @default 32
65
65
  */
66
66
  this.size = DEFAULTS.SIZE;
@@ -35,10 +35,7 @@ declare class Buttonsimple extends Component {
35
35
  */
36
36
  softDisabled: boolean;
37
37
  /**
38
- * Button sizing is based on the button type.
39
- * - **Pill button**: 40, 32, 28, 24.
40
- * - **Icon button**: 64, 52, 40, 32, 28, 24.
41
- * - Tertiary icon button cam also be 20.
38
+ * Simplebutton size is a super set of all the sizes supported by children components.
42
39
  * @default 32
43
40
  */
44
41
  size: ButtonSize;
@@ -52,10 +52,7 @@ class Buttonsimple extends Component {
52
52
  */
53
53
  this.softDisabled = false;
54
54
  /**
55
- * Button sizing is based on the button type.
56
- * - **Pill button**: 40, 32, 28, 24.
57
- * - **Icon button**: 64, 52, 40, 32, 28, 24.
58
- * - Tertiary icon button cam also be 20.
55
+ * Simplebutton size is a super set of all the sizes supported by children components.
59
56
  * @default 32
60
57
  */
61
58
  this.size = DEFAULTS.SIZE;
@@ -2,184 +2,6 @@
2
2
  "schemaVersion": "1.0.0",
3
3
  "readme": "",
4
4
  "modules": [
5
- {
6
- "kind": "javascript-module",
7
- "path": "components/avatar/avatar.component.js",
8
- "declarations": [
9
- {
10
- "kind": "class",
11
- "description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
12
- "name": "Avatar",
13
- "cssProperties": [
14
- {
15
- "description": "Allows customization of the default background color.",
16
- "name": "--mdc-avatar-default-background-color"
17
- },
18
- {
19
- "description": "Allows customization of the default foreground color.",
20
- "name": "--mdc-avatar-default-foreground-color"
21
- },
22
- {
23
- "description": "Allows customization of the loading indicator background color.",
24
- "name": "--mdc-avatar-loading-indicator-background-color"
25
- },
26
- {
27
- "description": "Allows customization of the loading indicator foreground color.",
28
- "name": "--mdc-avatar-loading-indicator-foreground-color"
29
- },
30
- {
31
- "description": "Allows customization of the loading overlay background color.",
32
- "name": "--mdc-avatar-loading-overlay-background-color"
33
- }
34
- ],
35
- "members": [
36
- {
37
- "kind": "field",
38
- "name": "src",
39
- "type": {
40
- "text": "string | undefined"
41
- },
42
- "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
43
- "attribute": "src"
44
- },
45
- {
46
- "kind": "field",
47
- "name": "initials",
48
- "type": {
49
- "text": "string | undefined"
50
- },
51
- "description": "The initials to be displayed for the avatar.",
52
- "attribute": "initials"
53
- },
54
- {
55
- "kind": "field",
56
- "name": "presence",
57
- "type": {
58
- "text": "PresenceType | undefined"
59
- },
60
- "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\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`",
61
- "attribute": "presence"
62
- },
63
- {
64
- "kind": "field",
65
- "name": "size",
66
- "type": {
67
- "text": "AvatarSize"
68
- },
69
- "description": "Acceptable values include:\n- xx_small\n- x_small\n- small\n- midsize\n- large\n- x_large\n- xx_large",
70
- "default": "x_small",
71
- "attribute": "size",
72
- "reflects": true
73
- },
74
- {
75
- "kind": "field",
76
- "name": "iconName",
77
- "type": {
78
- "text": "IconNames | undefined"
79
- },
80
- "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
81
- "attribute": "icon-name"
82
- },
83
- {
84
- "kind": "field",
85
- "name": "counter",
86
- "type": {
87
- "text": "number | undefined"
88
- },
89
- "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the give number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
90
- "attribute": "counter"
91
- },
92
- {
93
- "kind": "field",
94
- "name": "isTyping",
95
- "type": {
96
- "text": "boolean"
97
- },
98
- "default": "false",
99
- "description": "Represents the typing indicator when the user is typing.",
100
- "attribute": "is-typing"
101
- }
102
- ],
103
- "attributes": [
104
- {
105
- "name": "src",
106
- "type": {
107
- "text": "string | undefined"
108
- },
109
- "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
110
- "fieldName": "src"
111
- },
112
- {
113
- "name": "initials",
114
- "type": {
115
- "text": "string | undefined"
116
- },
117
- "description": "The initials to be displayed for the avatar.",
118
- "fieldName": "initials"
119
- },
120
- {
121
- "name": "presence",
122
- "type": {
123
- "text": "PresenceType | undefined"
124
- },
125
- "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\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`",
126
- "fieldName": "presence"
127
- },
128
- {
129
- "name": "size",
130
- "type": {
131
- "text": "AvatarSize"
132
- },
133
- "description": "Acceptable values include:\n- xx_small\n- x_small\n- small\n- midsize\n- large\n- x_large\n- xx_large",
134
- "default": "x_small",
135
- "fieldName": "size"
136
- },
137
- {
138
- "name": "icon-name",
139
- "type": {
140
- "text": "IconNames | undefined"
141
- },
142
- "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
143
- "fieldName": "iconName"
144
- },
145
- {
146
- "name": "counter",
147
- "type": {
148
- "text": "number | undefined"
149
- },
150
- "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the give number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
151
- "fieldName": "counter"
152
- },
153
- {
154
- "name": "is-typing",
155
- "type": {
156
- "text": "boolean"
157
- },
158
- "default": "false",
159
- "description": "Represents the typing indicator when the user is typing.",
160
- "fieldName": "isTyping"
161
- }
162
- ],
163
- "superclass": {
164
- "name": "Component",
165
- "module": "/src/models"
166
- },
167
- "tagName": "mdc-avatar",
168
- "jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
169
- "customElement": true
170
- }
171
- ],
172
- "exports": [
173
- {
174
- "kind": "js",
175
- "name": "default",
176
- "declaration": {
177
- "name": "Avatar",
178
- "module": "components/avatar/avatar.component.js"
179
- }
180
- }
181
- ]
182
- },
183
5
  {
184
6
  "kind": "javascript-module",
185
7
  "path": "components/badge/badge.component.js",
@@ -441,6 +263,184 @@
441
263
  }
442
264
  ]
443
265
  },
266
+ {
267
+ "kind": "javascript-module",
268
+ "path": "components/avatar/avatar.component.js",
269
+ "declarations": [
270
+ {
271
+ "kind": "class",
272
+ "description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
273
+ "name": "Avatar",
274
+ "cssProperties": [
275
+ {
276
+ "description": "Allows customization of the default background color.",
277
+ "name": "--mdc-avatar-default-background-color"
278
+ },
279
+ {
280
+ "description": "Allows customization of the default foreground color.",
281
+ "name": "--mdc-avatar-default-foreground-color"
282
+ },
283
+ {
284
+ "description": "Allows customization of the loading indicator background color.",
285
+ "name": "--mdc-avatar-loading-indicator-background-color"
286
+ },
287
+ {
288
+ "description": "Allows customization of the loading indicator foreground color.",
289
+ "name": "--mdc-avatar-loading-indicator-foreground-color"
290
+ },
291
+ {
292
+ "description": "Allows customization of the loading overlay background color.",
293
+ "name": "--mdc-avatar-loading-overlay-background-color"
294
+ }
295
+ ],
296
+ "members": [
297
+ {
298
+ "kind": "field",
299
+ "name": "src",
300
+ "type": {
301
+ "text": "string | undefined"
302
+ },
303
+ "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
304
+ "attribute": "src"
305
+ },
306
+ {
307
+ "kind": "field",
308
+ "name": "initials",
309
+ "type": {
310
+ "text": "string | undefined"
311
+ },
312
+ "description": "The initials to be displayed for the avatar.",
313
+ "attribute": "initials"
314
+ },
315
+ {
316
+ "kind": "field",
317
+ "name": "presence",
318
+ "type": {
319
+ "text": "PresenceType | undefined"
320
+ },
321
+ "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\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`",
322
+ "attribute": "presence"
323
+ },
324
+ {
325
+ "kind": "field",
326
+ "name": "size",
327
+ "type": {
328
+ "text": "AvatarSize"
329
+ },
330
+ "description": "Acceptable values include:\n- xx_small\n- x_small\n- small\n- midsize\n- large\n- x_large\n- xx_large",
331
+ "default": "x_small",
332
+ "attribute": "size",
333
+ "reflects": true
334
+ },
335
+ {
336
+ "kind": "field",
337
+ "name": "iconName",
338
+ "type": {
339
+ "text": "IconNames | undefined"
340
+ },
341
+ "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
342
+ "attribute": "icon-name"
343
+ },
344
+ {
345
+ "kind": "field",
346
+ "name": "counter",
347
+ "type": {
348
+ "text": "number | undefined"
349
+ },
350
+ "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the give number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
351
+ "attribute": "counter"
352
+ },
353
+ {
354
+ "kind": "field",
355
+ "name": "isTyping",
356
+ "type": {
357
+ "text": "boolean"
358
+ },
359
+ "default": "false",
360
+ "description": "Represents the typing indicator when the user is typing.",
361
+ "attribute": "is-typing"
362
+ }
363
+ ],
364
+ "attributes": [
365
+ {
366
+ "name": "src",
367
+ "type": {
368
+ "text": "string | undefined"
369
+ },
370
+ "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
371
+ "fieldName": "src"
372
+ },
373
+ {
374
+ "name": "initials",
375
+ "type": {
376
+ "text": "string | undefined"
377
+ },
378
+ "description": "The initials to be displayed for the avatar.",
379
+ "fieldName": "initials"
380
+ },
381
+ {
382
+ "name": "presence",
383
+ "type": {
384
+ "text": "PresenceType | undefined"
385
+ },
386
+ "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\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`",
387
+ "fieldName": "presence"
388
+ },
389
+ {
390
+ "name": "size",
391
+ "type": {
392
+ "text": "AvatarSize"
393
+ },
394
+ "description": "Acceptable values include:\n- xx_small\n- x_small\n- small\n- midsize\n- large\n- x_large\n- xx_large",
395
+ "default": "x_small",
396
+ "fieldName": "size"
397
+ },
398
+ {
399
+ "name": "icon-name",
400
+ "type": {
401
+ "text": "IconNames | undefined"
402
+ },
403
+ "description": "Name of the icon to be displayed inside the Avatar.\nMust be a valid icon name.",
404
+ "fieldName": "iconName"
405
+ },
406
+ {
407
+ "name": "counter",
408
+ "type": {
409
+ "text": "number | undefined"
410
+ },
411
+ "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the give number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
412
+ "fieldName": "counter"
413
+ },
414
+ {
415
+ "name": "is-typing",
416
+ "type": {
417
+ "text": "boolean"
418
+ },
419
+ "default": "false",
420
+ "description": "Represents the typing indicator when the user is typing.",
421
+ "fieldName": "isTyping"
422
+ }
423
+ ],
424
+ "superclass": {
425
+ "name": "Component",
426
+ "module": "/src/models"
427
+ },
428
+ "tagName": "mdc-avatar",
429
+ "jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
430
+ "customElement": true
431
+ }
432
+ ],
433
+ "exports": [
434
+ {
435
+ "kind": "js",
436
+ "name": "default",
437
+ "declaration": {
438
+ "name": "Avatar",
439
+ "module": "components/avatar/avatar.component.js"
440
+ }
441
+ }
442
+ ]
443
+ },
444
444
  {
445
445
  "kind": "javascript-module",
446
446
  "path": "components/bullet/bullet.component.js",
@@ -563,7 +563,7 @@
563
563
  "type": {
564
564
  "text": "ButtonSize"
565
565
  },
566
- "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button cam also be 20.",
566
+ "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
567
567
  "default": "32",
568
568
  "attribute": "size",
569
569
  "reflects": true,
@@ -907,7 +907,7 @@
907
907
  "type": {
908
908
  "text": "ButtonSize"
909
909
  },
910
- "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button cam also be 20.",
910
+ "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
911
911
  "default": "32",
912
912
  "fieldName": "size",
913
913
  "inheritedFrom": {
@@ -1068,7 +1068,7 @@
1068
1068
  "type": {
1069
1069
  "text": "ButtonSize"
1070
1070
  },
1071
- "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button cam also be 20.",
1071
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1072
1072
  "default": "32",
1073
1073
  "attribute": "size",
1074
1074
  "reflects": true
@@ -1243,7 +1243,7 @@
1243
1243
  "type": {
1244
1244
  "text": "ButtonSize"
1245
1245
  },
1246
- "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button cam also be 20.",
1246
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1247
1247
  "default": "32",
1248
1248
  "fieldName": "size"
1249
1249
  },
@@ -1,5 +1,5 @@
1
- export { default as Avatar } from './avatar';
2
1
  export { default as Badge } from './badge';
2
+ export { default as Avatar } from './avatar';
3
3
  export { default as Bullet } from './bullet';
4
4
  export { default as Button } from './button';
5
5
  export { default as Buttonsimple } from './buttonsimple';
@@ -1,5 +1,5 @@
1
- export { default as Avatar } from './avatar';
2
1
  export { default as Badge } from './badge';
2
+ export { default as Avatar } from './avatar';
3
3
  export { default as Bullet } from './bullet';
4
4
  export { default as Button } from './button';
5
5
  export { default as Buttonsimple } from './buttonsimple';
package/package.json CHANGED
@@ -35,5 +35,5 @@
35
35
  "@momentum-design/tokens": "*",
36
36
  "lit": "^3.2.0"
37
37
  },
38
- "version": "0.15.3"
38
+ "version": "0.15.5"
39
39
  }