@paperless/react 0.0.3-alpha.5 → 0.1.0-alpha.100

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/README.md CHANGED
@@ -1,25 +1,29 @@
1
- <p align="center">
1
+ <div class="pb-10">
2
+ <p align="center">
2
3
 
3
4
  <a href="https://paperless.employes.nl">
4
5
  <img src="https://github.com/Employes/paperless/raw/main/packages/core/src/assets/images/paperless.png" alt="Employes UI" width="400" />
5
6
  </a>
6
7
  <br />
7
- <span>
8
- A collection of React & Angular components that conform to the Employes design system.
9
- </span>
10
8
 
11
- </p>
9
+ <span>
10
+ A collection of Web, React & Angular components that conform to the Employes design system.
11
+ </span>
12
12
 
13
- <div align="center">
13
+ </p>
14
+
15
+ <div align="center">
14
16
 
15
17
  [![](https://badgen.net/npm/v/@paperless/core/latest?label=@paperless/core)](https://www.npmjs.com/package/@paperless/core)
16
18
  [![](https://badgen.net/npm/v/@paperless/angular/latest?label=@paperless/angular)](https://www.npmjs.com/package/@paperless/angular)
17
- [![](https://badgen.net/npm/v/@paperless/angular/latest?label=@paperless/react)](https://www.npmjs.com/package/@paperless/react)
19
+ [![](https://badgen.net/npm/v/@paperless/react/latest?label=@paperless/react)](https://www.npmjs.com/package/@paperless/react)
20
+ [![](https://badgen.net/npm/v/@paperless/conventions/latest?label=@paperless/conventions)](https://www.npmjs.com/package/@paperless/conventions)
18
21
 
19
- </div>
22
+ </div>
20
23
 
21
- <div align="center">
22
- <a href="https://paperless.employes.nl">https://paperless.employes.nl</a>
24
+ <div align="center" >
25
+ <a href="https://paperless.employes.nl">https://paperless.employes.nl</a>
26
+ </div>
23
27
  </div>
24
28
 
25
29
  ## 📦 Install
@@ -59,6 +63,12 @@ yarn add @paperless/core
59
63
  #### React
60
64
 
61
65
  ```jsx
66
+ // setup
67
+ import { applyPolyfills, defineCustomElements } from '@paperless/core/loader';
68
+
69
+ applyPolyfills().then(() => defineCustomElements());
70
+
71
+ // usage
62
72
  import { Button } from '@employes/paperless';
63
73
 
64
74
  const App = () => <Button>Click me!</Button>;
@@ -67,6 +77,16 @@ const App = () => <Button>Click me!</Button>;
67
77
  #### Angular
68
78
 
69
79
  ```jsx
80
+ // main.ts
81
+ import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
82
+ import { applyPolyfills, defineCustomElements } from '@paperless/core/loader';
83
+
84
+ applyPolyfills()
85
+ .then(() => defineCustomElements())
86
+ .then(() => platformBrowserDynamic().bootstrapModule(AppModule))
87
+ .catch((err) => console.error(err));
88
+
89
+ // App Module
70
90
  import { PaperlessModule } from '@employes/paperless-ngx';
71
91
 
72
92
  @NgModule({
@@ -77,6 +97,7 @@ import { PaperlessModule } from '@employes/paperless-ngx';
77
97
  })
78
98
  export class AppModule {}
79
99
 
100
+ // Any component
80
101
  @Component({
81
102
  selector: 'app-root',
82
103
  templateUrl: `