@tactics/lokaal-loket 0.1.9 → 0.1.11
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 +35 -1
- package/build/index.cjs +873 -788
- package/build/index.d.cts +40 -1
- package/build/index.d.ts +40 -1
- package/build/index.js +873 -788
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,35 @@
|
|
|
1
|
-
#
|
|
1
|
+
# LLK
|
|
2
|
+
|
|
3
|
+
This is the React UI Kit for LLK. It is a collection of components that can be used to build applications for LLK.
|
|
4
|
+
All available components are listed in the sidebar. Click on a component to view its documentation.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
To install the UI Kit, run the following command:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
pnpm add @tactics/lokaal-loket
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
To use a component, import it from the UI Kit and use it in your application. For example:
|
|
17
|
+
|
|
18
|
+
```jsx
|
|
19
|
+
import Screen from "@tactics/lokaal-loket";
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Basic Setup
|
|
23
|
+
|
|
24
|
+
To ensure all components work as expected, make sure to wrap your application in the following component.
|
|
25
|
+
In the storybook this is done inside the preview.tsx, so you don't have to worry about it.
|
|
26
|
+
|
|
27
|
+
```jsx
|
|
28
|
+
const App = () => {
|
|
29
|
+
return (
|
|
30
|
+
<Screen>
|
|
31
|
+
<MyApp />
|
|
32
|
+
</Screen>
|
|
33
|
+
);
|
|
34
|
+
};
|
|
35
|
+
```
|