@inspectr/ui 0.0.11 → 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 +62 -0
- package/dist/inspectr-ui.es.js +3399 -2842
- package/dist/inspectr-ui.umd.js +21 -17
- package/dist/ui.css +1 -1
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Inspectr UI
|
|
2
|
+
|
|
3
|
+
React UI components for [Inspectr](https://github.com/inspectr-hq/inspectr#readme).
|
|
4
|
+
|
|
5
|
+
<img src="https://raw.githubusercontent.com/inspectr-hq/inspectr/main/assets/inspectr-app.png" alt="Request Inspectr" width="80%">
|
|
6
|
+
|
|
7
|
+
## Introduction
|
|
8
|
+
|
|
9
|
+
**Inspectr UI** is a collection of React UI components built for the [Inspectr](https://github.com/inspectr-hq/inspectr#readme) project. It leverages modern tools like Vite and TailwindCSS to provide a fast, customizable, and modular UI library for your React applications.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
<a href="https://www.npmjs.com/package/@inspectr/ui" alt="Latest Stable Version"></a>
|
|
14
|
+
<a href="https://www.npmjs.com/package/@inspectr/ui" alt="Total Downloads"></a>
|
|
15
|
+
|
|
16
|
+
Install the package via npm:
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
npm install @inspectr/ui
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
Import the components and accompanying CSS into your React project:
|
|
25
|
+
|
|
26
|
+
```jsx
|
|
27
|
+
import React from 'react';
|
|
28
|
+
import { InspectrApp } from '@inspectr/ui';
|
|
29
|
+
import '@inspectr/ui/style.css';
|
|
30
|
+
|
|
31
|
+
const App = () => (
|
|
32
|
+
<div>
|
|
33
|
+
<InspectrApp />
|
|
34
|
+
</div>
|
|
35
|
+
);
|
|
36
|
+
|
|
37
|
+
export default App;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Storybook
|
|
41
|
+
|
|
42
|
+
Explore and test components in isolation with Storybook.
|
|
43
|
+
|
|
44
|
+
- Start Storybook locally:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm run storybook
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
- Build a static Storybook site:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
npm run build-storybook
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Contributing
|
|
57
|
+
|
|
58
|
+
Contributions are welcome! If you have ideas, improvements, or bug fixes, please open an issue or submit a pull request via the [GitHub repository](https://github.com/inspectr-hq/inspectr-ui).
|
|
59
|
+
|
|
60
|
+
## Bugs & Issues
|
|
61
|
+
|
|
62
|
+
Found a bug or have a feature request? Please report it via the [issue tracker](https://github.com/inspectr-hq/inspectr-ui/issues).
|