sevago-library 1.1.2 → 1.1.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.
- package/CHANGELOG.md +6 -0
- package/README.md +1 -112
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -27,94 +27,13 @@ Install required peer dependencies:
|
|
|
27
27
|
npm install react react-dom @emotion/react @emotion/styled @mui/material @mui/system @reduxjs/toolkit react-redux react-router-dom redux-persist
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
## Usage
|
|
33
|
-
|
|
34
|
-
Import components, constants, utilities, and types directly from the package:
|
|
35
|
-
|
|
36
|
-
```tsx
|
|
37
|
-
import { AppGrid, MODE, timeUtils } from 'sevago-library';
|
|
38
|
-
import type { AppInfo } from 'sevago-library';
|
|
39
|
-
|
|
40
|
-
const theme = MODE.light;
|
|
41
|
-
const dateText = timeUtils.getDateTime(new Date());
|
|
42
|
-
|
|
43
|
-
function AppList({ apps }: { apps: AppInfo[] }) {
|
|
44
|
-
return (
|
|
45
|
-
<AppGrid
|
|
46
|
-
apps={apps}
|
|
47
|
-
columns={5}
|
|
48
|
-
rows={3}
|
|
49
|
-
onClickApp={(app) => window.open(app.path.production)}
|
|
50
|
-
/>
|
|
51
|
-
);
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
For applications that use the bundled provider/app shell:
|
|
56
|
-
|
|
57
|
-
```tsx
|
|
58
|
-
import React from 'react';
|
|
59
|
-
import { Provider } from 'react-redux';
|
|
60
|
-
import { PersistGate } from 'redux-persist/integration/react';
|
|
61
|
-
import { BrowserRouter } from 'react-router-dom';
|
|
62
|
-
import App from 'sevago-library';
|
|
63
|
-
|
|
64
|
-
function RootApp() {
|
|
65
|
-
return (
|
|
66
|
-
<Provider store={store}>
|
|
67
|
-
<PersistGate loading={null} persistor={persistor}>
|
|
68
|
-
<BrowserRouter>
|
|
69
|
-
<App />
|
|
70
|
-
</BrowserRouter>
|
|
71
|
-
</PersistGate>
|
|
72
|
-
</Provider>
|
|
73
|
-
);
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
export default RootApp;
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
30
|
## Documentation
|
|
82
31
|
|
|
83
32
|
Useful project references:
|
|
84
33
|
|
|
85
34
|
- [Repository](https://github.com/core-sevago/sevago-library)
|
|
86
35
|
- [npm package](https://www.npmjs.com/package/sevago-library)
|
|
87
|
-
- [
|
|
88
|
-
|
|
89
|
-
---
|
|
90
|
-
|
|
91
|
-
## Components
|
|
92
|
-
|
|
93
|
-
Common exports include:
|
|
94
|
-
|
|
95
|
-
- `AppGrid`
|
|
96
|
-
- `AppsSidebar`
|
|
97
|
-
- `SystemMonitorScreen`
|
|
98
|
-
- `SystemMonitorSidebarPart`
|
|
99
|
-
- `DefaultLayout`
|
|
100
|
-
- `LoadingComponent`
|
|
101
|
-
- `LogoComponent`
|
|
102
|
-
- `MotionBox`
|
|
103
|
-
- `NoteComponent`
|
|
104
|
-
- `PriceComponent`
|
|
105
|
-
- `ReviewComponent`
|
|
106
|
-
|
|
107
|
-
The library also exports shared elements, styles, constants, enums, interfaces, and utility functions.
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
## TypeScript
|
|
112
|
-
|
|
113
|
-
The package ships with generated TypeScript declarations from `dist`.
|
|
114
|
-
|
|
115
|
-
```tsx
|
|
116
|
-
import type { AppInfo, AppGridProps, Environment } from 'sevago-library';
|
|
117
|
-
```
|
|
36
|
+
- [Core-sevago/sevago-library](https://core-sevago.github.io/sevago-library)
|
|
118
37
|
|
|
119
38
|
---
|
|
120
39
|
|
|
@@ -126,26 +45,6 @@ For issues and usage questions, use the project repository:
|
|
|
126
45
|
|
|
127
46
|
---
|
|
128
47
|
|
|
129
|
-
## Contributing
|
|
130
|
-
|
|
131
|
-
Create a changeset for every public change:
|
|
132
|
-
|
|
133
|
-
```bash
|
|
134
|
-
npm run changeset
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
Choose `patch`, `minor`, or `major`, then commit the generated file in `.changeset/`.
|
|
138
|
-
|
|
139
|
-
To publish a new version from a clean `master` branch:
|
|
140
|
-
|
|
141
|
-
```bash
|
|
142
|
-
bash deploy.sh
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
The deploy script applies Changesets, builds the library, commits release artifacts, publishes to npm, and pushes the release commit with tags.
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
48
|
## Changelog
|
|
150
49
|
|
|
151
50
|
The [changelog](https://github.com/core-sevago/sevago-library/blob/master/CHANGELOG.md) is generated by Changesets and updated for every release.
|
|
@@ -158,18 +57,8 @@ Future changes should be tracked through GitHub issues and released with Changes
|
|
|
158
57
|
|
|
159
58
|
---
|
|
160
59
|
|
|
161
|
-
## License
|
|
162
|
-
|
|
163
|
-
This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
|
|
167
60
|
## Security
|
|
168
61
|
|
|
169
62
|
Do not publish credentials, tokens, private URLs, or environment files. Report security issues through the project maintainers.
|
|
170
63
|
|
|
171
64
|
---
|
|
172
|
-
|
|
173
|
-
## Keywords
|
|
174
|
-
|
|
175
|
-
`sso` `authentication` `react` `typescript` `sevago`
|