@fairshare/ui-kit 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 +4 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Accessible, typed React components for building AI and agent interfaces. It incl
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
npm install
|
|
8
|
+
npm install @fairshare/ui-kit
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
React and React DOM are peer dependencies. React 17, 18, and 19 are supported.
|
|
@@ -15,8 +15,8 @@ React and React DOM are peer dependencies. React 17, 18, and 19 are supported.
|
|
|
15
15
|
Import the stylesheet once near the root of your application, then import components from the package:
|
|
16
16
|
|
|
17
17
|
```tsx
|
|
18
|
-
import '
|
|
19
|
-
import { Button, Message, PromptInput } from '
|
|
18
|
+
import '@fairshare/ui-kit/styles.css'
|
|
19
|
+
import { Button, Message, PromptInput } from '@fairshare/ui-kit'
|
|
20
20
|
|
|
21
21
|
export function Chat() {
|
|
22
22
|
return (
|
|
@@ -53,24 +53,14 @@ Override the package's CSS custom properties globally or on a wrapping element:
|
|
|
53
53
|
|
|
54
54
|
Dark mode follows the system preference by default. Force a theme with `data-theme="dark"` or `data-theme="light"` on an ancestor such as `<html>`.
|
|
55
55
|
|
|
56
|
-
## Development
|
|
56
|
+
## Development
|
|
57
57
|
|
|
58
58
|
```sh
|
|
59
59
|
npm install
|
|
60
60
|
npm test
|
|
61
61
|
npm run build
|
|
62
|
-
npm run check:package
|
|
63
62
|
```
|
|
64
63
|
|
|
65
|
-
Before publishing, replace the provisional `name` in `package.json` if needed and verify availability with `npm view <name>`. Then authenticate and publish:
|
|
66
|
-
|
|
67
|
-
```sh
|
|
68
|
-
npm login
|
|
69
|
-
npm publish
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
The `prepublishOnly` hook runs the test suite and production build automatically.
|
|
73
|
-
|
|
74
64
|
## License
|
|
75
65
|
|
|
76
66
|
MIT
|
package/package.json
CHANGED