@bfme-technology/spa 0.1.0 → 0.1.1
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 +40 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @bfme-technology/spa
|
|
2
|
+
|
|
3
|
+
Shared SPA utilities/components for BFME apps.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @bfme-technology/spa
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Exports
|
|
12
|
+
|
|
13
|
+
- `FocusAreaLoadElement`
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import { FocusAreaLoadElement } from "@bfme-technology/spa";
|
|
19
|
+
|
|
20
|
+
<FocusAreaLoadElement areaName="DashboardWidget">
|
|
21
|
+
<Widget />
|
|
22
|
+
</FocusAreaLoadElement>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Peer dependencies
|
|
26
|
+
|
|
27
|
+
- `react >= 18`
|
|
28
|
+
- `react-dom >= 18`
|
|
29
|
+
|
|
30
|
+
## Local development
|
|
31
|
+
|
|
32
|
+
This package is consumed locally in workspace projects via `file:` dependencies.
|
|
33
|
+
|
|
34
|
+
Example:
|
|
35
|
+
|
|
36
|
+
```json
|
|
37
|
+
"@bfme-technology/spa": "file:../npm_packages/@bfme-technology/spa"
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
After local changes, run `npm install` in the consuming project to refresh linked metadata when needed.
|