@myhealth-belgium/webcomponent-vaccinations 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,13 @@
1
+ # 0.1.0
2
+
3
+ Initial version.
4
+
5
+ This version contains the vaccinations component as seen in (MyHealth)[https://myhealth.belgium.be/], packaged as a webcomponent.
6
+
7
+ The webcomponent implements the [MyHealth Webcomponent integration library](https://www.npmjs.com/package/@smals-belgium/myhealth-wc-integration) and use the [MyHealth - Angular design kit](https://www.npmjs.com/package/@myhealth-belgium/design-kit) package for styling.
8
+
9
+ It should be noted there is no authorization built into the component yet, so the data retrieved by the webcomponent will always be null and an error will be shown.
10
+
11
+ **New features:**
12
+
13
+ - Vaccinations webcomponent with inputs as declared in [MyHealth Webcomponent integration library](https://www.npmjs.com/package/@smals-belgium/myhealth-wc-integration)
package/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # MyHealth Vaccinations Webcomponent
2
+
3
+ The MyHealth Vaccinations Webcomponent provides a comprehensive view of a user's vaccination history.
4
+
5
+ All MyHealth webcomponents implement the [MyHealth Webcomponent integration library](https://www.npmjs.com/package/@smals-belgium/myhealth-wc-integration) and use the [MyHealth - Angular design kit](https://www.npmjs.com/package/@myhealth-belgium/design-kit) package for styling.
6
+
7
+ ## Usage
8
+
9
+ To use the MyHealth Vaccinations Webcomponent, simply import the package's JavaScript and CSS into your application:
10
+
11
+ ```ts
12
+ import '@myhealth-belgium/vaccinations';
13
+ ```
14
+
15
+ ```scss
16
+ @use '@myhealth-belgium/vaccinations/styles.css';
17
+ ```
18
+
19
+ Then, implement the webcomponent in your HTML according to [MyHealth Webcomponent integration library](https://www.npmjs.com/package/@smals-belgium/myhealth-wc-integration)'s guidelines. Example:
20
+
21
+ ```html
22
+ <mh-vaccinations-webcomponent
23
+ version="${hostSpecVersion}"
24
+ language="${Language.EN}"
25
+ configname="${Configuration.DEV}"
26
+ services="${services}"
27
+ ></mh-vaccinations-webcomponent>
28
+ ```
29
+
30
+ ### Mock data
31
+
32
+ There is an option to display simple mock data with this webcomponent by changing the `configname` attribute passed to the webcomponent to: `configname="demo"`.
33
+ When in demo mode, the webcomponent will not make API calls and use standard mock data instead.
34
+
35
+ ### Design kit integration
36
+
37
+ As stated before, all MyHealth webcomponents use the [MyHealth - Angular design kit](https://www.npmjs.com/package/@myhealth-belgium/design-kit) package.
38
+
39
+ This means all webcomponents use the core functionality of the design kit, and override the Material components that the webcomponent consumes.