@brightspot/ui 0.0.0-alpha.1 → 0.0.0-alpha.2
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 +13 -1
- package/package.json +27 -4
package/README.md
CHANGED
|
@@ -22,6 +22,9 @@
|
|
|
22
22
|
<li>
|
|
23
23
|
<a href="#using-plugins">Using Plugins</a>
|
|
24
24
|
</li>
|
|
25
|
+
<li>
|
|
26
|
+
<a href="#examples">Examples</a>
|
|
27
|
+
</li>
|
|
25
28
|
<li>
|
|
26
29
|
<a href="#development">Development</a>
|
|
27
30
|
</li>
|
|
@@ -128,6 +131,15 @@ An example of including all the plugins:
|
|
|
128
131
|
```
|
|
129
132
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
130
133
|
|
|
134
|
+
## Examples
|
|
135
|
+
|
|
136
|
+
We use [Storybook](https://storybook.js.org/) for interactive previewing of our ui components. Launch that in the browser by running:
|
|
137
|
+
```sh
|
|
138
|
+
yarn storybook
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
142
|
+
|
|
131
143
|
## Development
|
|
132
144
|
|
|
133
145
|
* To build, run `yarn build` from the package root to create the `dist` folder
|
|
@@ -144,7 +156,7 @@ A: TODO
|
|
|
144
156
|
|
|
145
157
|
Q: How can I see examples of the components and theme?
|
|
146
158
|
|
|
147
|
-
A:
|
|
159
|
+
A: See the ["Examples"](#examples) section above.
|
|
148
160
|
|
|
149
161
|
Q: Can I choose which Brightspot UI plugins my project uses?
|
|
150
162
|
|
package/package.json
CHANGED
|
@@ -1,27 +1,50 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brightspot/ui",
|
|
3
|
-
"version": "0.0.0-alpha.
|
|
3
|
+
"version": "0.0.0-alpha.2",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
|
+
"description": "A UI library for building Brightspot CMS components.",
|
|
5
6
|
"main": "./dist/tailwind.config.ts",
|
|
6
7
|
"scripts": {
|
|
7
8
|
"format": "prettier --write .",
|
|
8
9
|
"clean": "shx rm -rf ./dist/*",
|
|
9
|
-
"build": "yarn clean && tsc --noEmitOnError && shx cp ./src/*.ts ./dist",
|
|
10
|
-
"prepack": "yarn build"
|
|
10
|
+
"build": "yarn clean && tsc --noEmitOnError && shx cp ./src/*.ts ./dist && shx rm ./dist/tailwind.storybook.config* && shx rm -Rf ./dist/stories",
|
|
11
|
+
"prepack": "yarn build",
|
|
12
|
+
"storybook": "storybook dev -p 6006",
|
|
13
|
+
"build-storybook": "storybook build"
|
|
11
14
|
},
|
|
12
15
|
"devDependencies": {
|
|
13
16
|
"@eslint/js": "^9.23.0",
|
|
17
|
+
"@storybook/addon-essentials": "^8.6.12",
|
|
18
|
+
"@storybook/addon-styling-webpack": "^1.0.1",
|
|
19
|
+
"@storybook/addon-webpack5-compiler-swc": "^3.0.0",
|
|
20
|
+
"@storybook/blocks": "^8.6.12",
|
|
21
|
+
"@storybook/test": "^8.6.12",
|
|
22
|
+
"@storybook/web-components": "^8.6.12",
|
|
23
|
+
"@storybook/web-components-webpack5": "^8.6.12",
|
|
24
|
+
"@tailwindcss/container-queries": "^0.1.1",
|
|
14
25
|
"@types/node": "^22.15.3",
|
|
26
|
+
"autoprefixer": "10.4.21",
|
|
27
|
+
"css-loader": "7.1.2",
|
|
15
28
|
"eslint": "^9.23.0",
|
|
16
29
|
"eslint-config-prettier": "^10.1.2",
|
|
17
30
|
"eslint-plugin-prettier": "^5.4.0",
|
|
31
|
+
"eslint-plugin-storybook": "^0.12.0",
|
|
18
32
|
"globals": "^16.0.0",
|
|
33
|
+
"lit": "^3.3.0",
|
|
34
|
+
"mini-css-extract-plugin": "2.9.2",
|
|
35
|
+
"postcss-import": "16.1.0",
|
|
36
|
+
"postcss-loader": "8",
|
|
19
37
|
"prettier": "^3.5.3",
|
|
20
38
|
"prettier-plugin-tailwindcss": "^0.6.11",
|
|
21
39
|
"shx": "^0.4.0",
|
|
40
|
+
"storybook": "^8.6.12",
|
|
41
|
+
"style-loader": "4.0.0",
|
|
22
42
|
"ts-node": "^10.9.2",
|
|
23
43
|
"typescript": "^4.7.3",
|
|
24
|
-
"typescript-eslint": "^8.29.0"
|
|
44
|
+
"typescript-eslint": "^8.29.0",
|
|
45
|
+
"webpack": "^5.99.8",
|
|
46
|
+
"webpack-cli": "^6.0.1",
|
|
47
|
+
"webpack-merge": "6.0.1"
|
|
25
48
|
},
|
|
26
49
|
"dependencies": {
|
|
27
50
|
"lucide-static": "0.508.0",
|