@officesdk/design 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/README.md +54 -0
- package/dist/components/index.d.mts +936 -0
- package/dist/components/index.d.ts +936 -0
- package/dist/components/index.js +2320 -0
- package/dist/components/index.js.map +1 -0
- package/dist/components/index.mjs +2293 -0
- package/dist/components/index.mjs.map +1 -0
- package/dist/icons/index.d.mts +93 -0
- package/dist/icons/index.d.ts +93 -0
- package/dist/icons/index.js +293 -0
- package/dist/icons/index.js.map +1 -0
- package/dist/icons/index.mjs +224 -0
- package/dist/icons/index.mjs.map +1 -0
- package/dist/index.d.mts +2 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/index.mjs +2 -0
- package/dist/theme/index.d.mts +9 -0
- package/dist/theme/index.d.ts +9 -0
- package/dist/theme/index.js +1264 -0
- package/dist/theme/index.js.map +1 -0
- package/dist/theme/index.mjs +1261 -0
- package/dist/theme/index.mjs.map +1 -0
- package/dist/utils/index.d.mts +18 -0
- package/dist/utils/index.d.ts +18 -0
- package/dist/utils/index.js +54 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/index.mjs +49 -0
- package/dist/utils/index.mjs.map +1 -0
- package/package.json +75 -0
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# @officesdk/design
|
|
2
|
+
|
|
3
|
+
> OfficeSdk UI Component Library - A modern UI component library built with React and styled-components
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @officesdk/design styled-components@^5.3.0
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Button, UIConfigProvider, createUIConfig } from '@officesdk/design';
|
|
15
|
+
import { lightTheme } from '@officesdk/design/theme';
|
|
16
|
+
|
|
17
|
+
const config = createUIConfig({
|
|
18
|
+
theme: lightTheme,
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
function App() {
|
|
22
|
+
return (
|
|
23
|
+
<UIConfigProvider config={config}>
|
|
24
|
+
<Button>Click Me</Button>
|
|
25
|
+
</UIConfigProvider>
|
|
26
|
+
);
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Importing Modules
|
|
31
|
+
|
|
32
|
+
```tsx
|
|
33
|
+
// Components
|
|
34
|
+
import { Button, Input, Tooltip } from '@officesdk/design';
|
|
35
|
+
|
|
36
|
+
// Theme
|
|
37
|
+
import { lightTheme } from '@officesdk/design/theme';
|
|
38
|
+
|
|
39
|
+
// Icons
|
|
40
|
+
import { Search, Close } from '@officesdk/design/icons';
|
|
41
|
+
|
|
42
|
+
// Utils
|
|
43
|
+
import { deepMerge } from '@officesdk/design/utils';
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Documentation
|
|
47
|
+
|
|
48
|
+
- [Full Documentation](https://github.com/officesdk/officesdk-design#readme)
|
|
49
|
+
- [Storybook](https://officesdk.github.io/officesdk-design)
|
|
50
|
+
- [Changelog](https://github.com/officesdk/officesdk-design/blob/main/CHANGELOG.md)
|
|
51
|
+
|
|
52
|
+
## License
|
|
53
|
+
|
|
54
|
+
MIT © OfficeSdk Team
|