@inialum/memories-react 0.0.2 → 0.0.3-canary.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 +41 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,3 +1,44 @@
|
|
|
1
1
|
# @inialum/memories-react
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@inialum/memories-react)
|
|
4
|
+
|
|
3
5
|
React component library for the Memories - INIALUM Design System.
|
|
6
|
+
|
|
7
|
+
- [Storybook](https://memories-react.pages.dev)
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
Before installing this package, make sure you have installed [Tailwind CSS](https://tailwindcss.com/docs/installation).
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm add -D @inialum/memories-css @inialum/memories-react
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Tailwind CSS Configuration
|
|
18
|
+
|
|
19
|
+
You should add the `memories` plugin to your `tailwind.config.[ts|js|cjs]`.
|
|
20
|
+
Also, you should add the `@inialum/memories-react` to the `content` option.
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
// tailwind.config.ts
|
|
24
|
+
|
|
25
|
+
import { memories } from '@inialum/memories-css'
|
|
26
|
+
import { type Config } from 'tailwindcss'
|
|
27
|
+
|
|
28
|
+
const config = {
|
|
29
|
+
content: [
|
|
30
|
+
'./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}',
|
|
31
|
+
|
|
32
|
+
// Do not forget to add this line!
|
|
33
|
+
'./node_modules/@inialum/memories-react/**/*.js',
|
|
34
|
+
],
|
|
35
|
+
plugins: [memories],
|
|
36
|
+
} satisfies Config
|
|
37
|
+
|
|
38
|
+
export default config
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
Licensed under [Apache License 2.0](LICENSE). (except for images)
|
|
44
|
+
You are not allowed to use or distribute the images.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inialum/memories-react",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3-canary.0",
|
|
4
4
|
"description": "React component library for the Memories - INIALUM Design System",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": {
|
|
@@ -60,7 +60,7 @@
|
|
|
60
60
|
"vite": "^5.2.8",
|
|
61
61
|
"vite-plugin-dts": "^3.8.1",
|
|
62
62
|
"vite-plugin-svgr": "^4.2.0",
|
|
63
|
-
"@inialum/memories-css": "0.0.
|
|
63
|
+
"@inialum/memories-css": "0.0.4-canary.0"
|
|
64
64
|
},
|
|
65
65
|
"peerDependencies": {
|
|
66
66
|
"@inialum/memories-css": ">= 0.0.1",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"format": "pnpm run format:fix",
|
|
77
77
|
"format:check": "prettier --cache --check \"**/*.{js,jsx,ts,tsx,json,md}\"",
|
|
78
78
|
"format:fix": "prettier --cache --write \"**/*.{js,jsx,ts,tsx,json,md}\"",
|
|
79
|
-
"storybook:dev": "storybook dev -p
|
|
79
|
+
"storybook:dev": "storybook dev -p 6007 --no-open",
|
|
80
80
|
"storybook:build": "storybook build",
|
|
81
81
|
"typecheck": "tsc --noEmit"
|
|
82
82
|
}
|