@davincihealthcare/elty-design-system-vue 1.8.0 → 1.9.1

package/README.md

@@ -21,11 +21,42 @@ in tailwind.config file
 
 module.exports = {
   ...
-  plugins: [require('@davincihealthcare/elty-design-system-vue').EltyPlugin]
+  content: [..., './node_modules/@davincihealthcare/elty-design-system-vue/**/*.{tsx,js}'],
+  plugins: [
+    require('@tailwindcss/forms'),
+    require('@tailwindcss/typography'),
+    require('@davincihealthcare/elty-design-system-vue').EltyTailwindPlugin
+  ]
   ...
 }
 ```
 
+Note: content needs a new entry in the array, alongside other you may already have.
+
+Make sure to:
+
+- NOT to import the elty foundations which are already imported alongside this plugin.
+- import other required official tailwind plugins
+  - `@tailwindcss/forms`
+  - `@tailwindcss/typography`
+
+in main.ts file
+
+```js
+import { createApp } from 'vue';
+import { EltyVuePlugin } from '@davincihealthcare/elty-design-system-vue';
+
+...
+
+const app = createApp();
+app.use(EltyVuePlugin);
+
+
+...
+```
+
+remember to `use` the related vue plugin (it will install form validation rules)!
+
 ```js
 // Import the component you need
 import { ElButton } from '@davincihealthcare/elty-design-system-vue';
@@ -36,16 +67,14 @@ Now, you can use the imported component in your templates:
 ```vue
 <template>
   <div>
-    <ElButton @click="handleClick">Click me</Button>
+    <ElButton label="Click me" @click="onClick" />
   </div>
 </template>
 
 <script lang="ts" setup>
-
-const handleClick = () => {
-    // Handle button click
-}
-
+import { ElButton } from '@davincihealthcare/elty-design-system-vue';
+const onClick = () => {
+  window.alert('click');
+};
 </script>
-
 ```

package/dist/forms/validation-rules.d.ts

@@ -1 +1 @@
-export {};
+export declare const defineValidationRules: () => void;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { default as EltyPlugin } from './elty.plugin';
+export { default as EltyVuePlugin } from './vue.plugin';
+export { default as EltyTailwindPlugin } from './tailwind.plugin';
 export * from './routes';
 export * from './types';
 export * from './ElAccordion.vue';