@pequity/squirrel 1.0.26-beta.1 → 1.0.26
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 +10 -3
- package/dist/cjs/tailwind.js +5 -4333
- package/dist/es/tailwind.js +5 -4333
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,14 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
The [Squirrel component library](https://getpequity.github.io/squirrel) is a comprehensive suite of feature-rich UI components that encapsulate the styling of the Pequity Squirrel Design System.
|
|
4
4
|
|
|
5
|
-
The library is built using Vue 3 and
|
|
5
|
+
The library is built using [Vue 3](https://vuejs.org/) and [Tailwind CSS](https://tailwindcss.com/) and is designed to be used in Vue 3 projects.
|
|
6
|
+
[Vite](https://vitejs.dev/) is used as the build tool for the library and [Storybook](https://storybook.js.org/) is used for component development and documentation.
|
|
6
7
|
|
|
7
8
|
## Installation and Usage
|
|
8
9
|
|
|
9
|
-
Install the package and its dependencies using pnpm
|
|
10
|
+
Install the package and its dependencies using `pnpm`:
|
|
10
11
|
|
|
11
12
|
```bash
|
|
12
|
-
pnpm i @pequity/squirrel @popperjs/core @tanstack/vue-virtual dayjs floating-vue lodash-es v-calendar vue-currency-input
|
|
13
|
+
pnpm i vue vue-router @pequity/squirrel @popperjs/core @tanstack/vue-virtual dayjs floating-vue lodash-es v-calendar vue-currency-input vue-toastification@2.0.0-rc.5
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Install Tailwind CSS:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pnpm i -D tailwindcss
|
|
13
20
|
```
|
|
14
21
|
|
|
15
22
|
Import the Squirrel CSS to your project's `main.css` file:
|