@davincihealthcare/elty-design-system-vue 1.64.1 → 1.64.3
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 +20 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
This collection of reusable Vue components is designed to help you easily integrate and maintain a consistent design system across your company's projects. Whether you're building a new application or updating an existing one, these components are ready to be used and customized to match your brand guidelines.
|
|
4
4
|
|
|
5
|
+
## Version Information
|
|
6
|
+
|
|
7
|
+
The library is available in two major versions:
|
|
8
|
+
|
|
9
|
+
- **Version 1.x.x** (default): Stable version with current component implementations
|
|
10
|
+
- **Version 2.x.x** (beta): Next major version with breaking changes and better alignment with the design system
|
|
11
|
+
|
|
5
12
|
## Getting Started
|
|
6
13
|
|
|
7
14
|
To get started with using these components in your Vue project, follow these simple steps
|
|
@@ -10,12 +17,20 @@ To get started with using these components in your Vue project, follow these sim
|
|
|
10
17
|
|
|
11
18
|
First install Tailwindcss following the steps at https://tailwindcss.com/docs/installation/framework-guides
|
|
12
19
|
|
|
13
|
-
Then install required plugins and the design system package itself
|
|
20
|
+
Then install required plugins and the design system package itself:
|
|
14
21
|
|
|
15
22
|
```bash
|
|
16
|
-
#
|
|
17
|
-
yarn add -D tailwindcss postcss autoprefixer @tailwindcss/forms @tailwindcss/typography
|
|
23
|
+
# Version 1 (default)
|
|
18
24
|
yarn add @davincihealthcare/elty-design-system-vue
|
|
25
|
+
|
|
26
|
+
# Version 2 (contains breaking changes and better alignment with the design system)
|
|
27
|
+
yarn add @davincihealthcare/elty-design-system-vue@v2
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Required peer dependencies:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
yarn add -D tailwindcss postcss autoprefixer @tailwindcss/forms @tailwindcss/typography
|
|
19
34
|
```
|
|
20
35
|
|
|
21
36
|
## Usage
|
|
@@ -145,3 +160,5 @@ This section handles the styling for your Vue component library, leveraging Tail
|
|
|
145
160
|
- button v2 will have a different interface
|
|
146
161
|
- remove id from input which is useless and just use name prop
|
|
147
162
|
- from IDs will be delegated to the parent https://davincisalute.slack.com/archives/C03HLJGN04S/p1720704672112299
|
|
163
|
+
|
|
164
|
+
Migration instructions are available in [MIGRATION.md](MIGRATION.md)
|