@momentum-design/components 0.27.2 → 0.27.3

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.
@@ -3,12 +3,18 @@ import Component from '../../components/iconprovider';
3
3
  * IconProvider component, which allows to be consumed from sub components
4
4
  * (see `providerUtils.consume` for how to consume)
5
5
  *
6
- * Bundling icons will be up to the consumer of this component, such
7
- * that only a url has to be passed in from which the icons will be
8
- * fetched.
6
+ * Attribute `iconSet` can be set to either `momentum-icons` or `custom-icons`.
7
+ * If `momentum-icons` is selected, the icons will be fetched from the
8
+ * Momentum Design System icon set per a dynamic JS Import (no need to provide a URL).
9
+ * This requires the consumer to have the `@momentum-designs` package installed and the
10
+ * build tooling needs to support dynamic imports.
9
11
  *
10
- * If `cacheStrategy` is provided, the IconProvider will cache the icons
11
- * in the selected cache (either web-api-cache or in-memory-cache),
12
+ * If `custom-icons` is selected, the icons will be fetched from the provided URL.
13
+ * This requires the consumer to provide a URL from which the icons will be fetched and
14
+ * the consumer needs to make sure to bundle the icons in the application.
15
+ *
16
+ * If `cacheStrategy` is provided (only works with iconSet = `custom-icons`), the
17
+ * IconProvider will cache the icons in the selected cache (either web-api-cache or in-memory-cache),
12
18
  * to avoid fetching the same icon multiple times over the network.
13
19
  * This is useful when the same icon is used multiple times in the application.
14
20
  * To consider:
@@ -6,12 +6,18 @@ import { TAG_NAME } from '../../components/iconprovider/iconprovider.constants';
6
6
  * IconProvider component, which allows to be consumed from sub components
7
7
  * (see `providerUtils.consume` for how to consume)
8
8
  *
9
- * Bundling icons will be up to the consumer of this component, such
10
- * that only a url has to be passed in from which the icons will be
11
- * fetched.
9
+ * Attribute `iconSet` can be set to either `momentum-icons` or `custom-icons`.
10
+ * If `momentum-icons` is selected, the icons will be fetched from the
11
+ * Momentum Design System icon set per a dynamic JS Import (no need to provide a URL).
12
+ * This requires the consumer to have the `@momentum-designs` package installed and the
13
+ * build tooling needs to support dynamic imports.
12
14
  *
13
- * If `cacheStrategy` is provided, the IconProvider will cache the icons
14
- * in the selected cache (either web-api-cache or in-memory-cache),
15
+ * If `custom-icons` is selected, the icons will be fetched from the provided URL.
16
+ * This requires the consumer to provide a URL from which the icons will be fetched and
17
+ * the consumer needs to make sure to bundle the icons in the application.
18
+ *
19
+ * If `cacheStrategy` is provided (only works with iconSet = `custom-icons`), the
20
+ * IconProvider will cache the icons in the selected cache (either web-api-cache or in-memory-cache),
15
21
  * to avoid fetching the same icon multiple times over the network.
16
22
  * This is useful when the same icon is used multiple times in the application.
17
23
  * To consider:
@@ -2,9 +2,9 @@ export { default as Avatar } from './avatar';
2
2
  export { default as AvatarButton } from './avatarbutton';
3
3
  export { default as Badge } from './badge';
4
4
  export { default as Bullet } from './bullet';
5
- export { default as Button } from './button';
6
5
  export { default as Buttonsimple } from './buttonsimple';
7
6
  export { default as Checkbox } from './checkbox';
7
+ export { default as Button } from './button';
8
8
  export { default as Divider } from './divider';
9
9
  export { default as FormfieldGroup } from './formfieldgroup';
10
10
  export { default as FormfieldWrapper } from './formfieldwrapper';
@@ -2,9 +2,9 @@ export { default as Avatar } from './avatar';
2
2
  export { default as AvatarButton } from './avatarbutton';
3
3
  export { default as Badge } from './badge';
4
4
  export { default as Bullet } from './bullet';
5
- export { default as Button } from './button';
6
5
  export { default as Buttonsimple } from './buttonsimple';
7
6
  export { default as Checkbox } from './checkbox';
7
+ export { default as Button } from './button';
8
8
  export { default as Divider } from './divider';
9
9
  export { default as FormfieldGroup } from './formfieldgroup';
10
10
  export { default as FormfieldWrapper } from './formfieldwrapper';
package/package.json CHANGED
@@ -37,5 +37,5 @@
37
37
  "lit": "^3.2.0",
38
38
  "uuid": "^11.0.5"
39
39
  },
40
- "version": "0.27.2"
40
+ "version": "0.27.3"
41
41
  }