@assemblyvoting/ui-library 0.0.1 → 0.0.3

package/README.md

@@ -6,18 +6,17 @@ Description...
 
 ## Setup
 
-```
-npm i npm-package-name
-```
-`yarn add npm-package-name`
+`npm i @assemblyvoting/ui-library`
+
+`yarn add @assemblyvoting/ui-library`
 
-## Importing library as a plugin
+## Importing library as a plugin (recommended)
 
 In the main file:
 
 ```
-import * as UILibrary from "npm-package-name"; // Imports components
-import "npm-package-name/styles"; // Imports styles
+import * as UILibrary from "@assemblyvoting/ui-library"; // Imports components
+import "@assemblyvoting/ui-library/styles"; // Imports styles
 
 const app = createApp(App);
 app.use(UILibrary.default); // Plugin-in the library
@@ -29,9 +28,9 @@ app.mount("#app");
 In the file you want to use it:
 
 ```
-import { ComponentName } from 'npm-package-name'
+import { ComponentName } from "@assemblyvoting/ui-library"
 
-<component-name />
+<ComponentName />
 
 ```
 ## Project Setup
@@ -77,14 +76,11 @@ yarn build-storybook
 ```
 ### Creating new components
 
-Remember to include them on the component index at:
-
-```sh
-@app/src/components.index.ts
-```
-
-and then add them in the Library (both as plugin component and as regular export) at:
-
-```sh
-@app/src/UILibrary.ts
-```
+Recommendations:
+- Use REMs as measure units. `1 REM = 16px`.
+- Check the component in different browsers.
+- Check the component both in the storybook view and in the development App.
+- Most of the UI components from our design system uses [Tailwindcss utility classes](https://tailwindcss.com/docs/preflight) , you can implement them by using `@apply utility-class-1 utility-class2;` in your regular css file.
+- The colors we use are named `slate`, `avblue` and `semantic`, which you can use inside the utility classes: `bg-avblue-600`, `text-slate-800`, `border-semantic-danger-1`.
+- Remember to use the AV prefix both for component and class names.
+- Once the component is ready, you need to include it on the component index at `@app/src/components.index.ts` and then in the Library (both as plugin component and as regular export) at `@app/src/UILibrary.ts`.

package/dist/{components/atoms/AVDatetimeInput → AVDatetimeInput}/AVDatetimeInput.vue.d.ts

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVDatetimeInput/AVDatetimeInput.vue?vue&type=script&setup=true&lang.ts";
-import "./AVDatetimeInput.css?vue&type=style&index=0&src=907a88e7&scoped=907a88e7&lang.css";
+import "./AVDatetimeInput.css?vue&type=style&index=0&src=930f7343&scoped=930f7343&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVDatetimeInput.vue.d.ts.map

package/dist/AVDatetimeInput/AVDatetimeInput.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVDatetimeInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVDatetimeInput/AVDatetimeInput.vue"],"names":[],"mappings":"AACA,cAAc,sIAAsI,CAAC;AACrJ,OAAO,oFAAoF,CAAC;;AAE5F,wBAA0F"}

package/dist/{components/atoms/AVDropdown/AVDropdown.vue.d.ts → AVDropdown.vue.d.ts}

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVDropdown/AVDropdown.vue?vue&type=script&setup=true&lang.ts";
-import "./AVDropdown.css?vue&type=style&index=0&src=63303fab&scoped=63303fab&lang.css";
+import "./AVDropdown.css?vue&type=style&index=0&src=4daf9f87&scoped=4daf9f87&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVDropdown.vue.d.ts.map

package/dist/AVDropdown.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVDropdown.vue.d.ts","sourceRoot":"","sources":["../src/components/atoms/AVDropdown/AVDropdown.vue"],"names":[],"mappings":"AACA,cAAc,4HAA4H,CAAC;AAC3I,OAAO,+EAA+E,CAAC;;AAEvF,wBAA0F"}

package/dist/{components/atoms/AVFileInput → AVFileInput}/AVFileInput.vue.d.ts

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVFileInput/AVFileInput.vue?vue&type=script&setup=true&lang.ts";
-import "./AVFileInput.css?vue&type=style&index=0&src=94ec2e5c&scoped=94ec2e5c&lang.css";
+import "./AVFileInput.css?vue&type=style&index=0&src=6a262d53&scoped=6a262d53&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVFileInput.vue.d.ts.map

package/dist/AVFileInput/AVFileInput.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVFileInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVFileInput/AVFileInput.vue"],"names":[],"mappings":"AACA,cAAc,8HAA8H,CAAC;AAC7I,OAAO,gFAAgF,CAAC;;AAExF,wBAA0F"}

package/dist/{components/atoms/AVNumberInput → AVNumberInput}/AVNumberInput.vue.d.ts

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVNumberInput/AVNumberInput.vue?vue&type=script&setup=true&lang.ts";
-import "./AVNumberInput.css?vue&type=style&index=0&src=5919673d&scoped=5919673d&lang.css";
+import "./AVNumberInput.css?vue&type=style&index=0&src=70e8a9d4&scoped=70e8a9d4&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVNumberInput.vue.d.ts.map

package/dist/AVNumberInput/AVNumberInput.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVNumberInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVNumberInput/AVNumberInput.vue"],"names":[],"mappings":"AACA,cAAc,kIAAkI,CAAC;AACjJ,OAAO,kFAAkF,CAAC;;AAE1F,wBAA0F"}

package/dist/{components/atoms/AVPasswordInput → AVPasswordInput}/AVPasswordInput.vue.d.ts

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVPasswordInput/AVPasswordInput.vue?vue&type=script&setup=true&lang.ts";
-import "./AVPasswordInput.css?vue&type=style&index=0&src=97b319a3&scoped=97b319a3&lang.css";
+import "./AVPasswordInput.css?vue&type=style&index=0&src=89846f2b&scoped=89846f2b&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVPasswordInput.vue.d.ts.map

package/dist/AVPasswordInput/AVPasswordInput.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVPasswordInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVPasswordInput/AVPasswordInput.vue"],"names":[],"mappings":"AACA,cAAc,sIAAsI,CAAC;AACrJ,OAAO,oFAAoF,CAAC;;AAE5F,wBAA0F"}

package/dist/AVRadio/AVRadio.vue.d.ts

@@ -0,0 +1,5 @@
+export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVRadio/AVRadio.vue?vue&type=script&setup=true&lang.ts";
+import "./AVRadio.css?vue&type=style&index=0&src=d8e45fa7&scoped=d8e45fa7&lang.css";
+declare const _default: any;
+export default _default;
+//# sourceMappingURL=AVRadio.vue.d.ts.map

package/dist/AVRadio/AVRadio.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVRadio.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVRadio/AVRadio.vue"],"names":[],"mappings":"AACA,cAAc,sHAAsH,CAAC;AACrI,OAAO,4EAA4E,CAAC;;AAEpF,wBAA0F"}

package/dist/{components/atoms/AVTextArea → AVTextArea}/AVTextArea.vue.d.ts

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVTextArea/AVTextArea.vue?vue&type=script&setup=true&lang.ts";
-import "./AVTextArea.css?vue&type=style&index=0&src=6211aba7&scoped=6211aba7&lang.css";
+import "./AVTextArea.css?vue&type=style&index=0&src=092f6ab7&scoped=092f6ab7&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVTextArea.vue.d.ts.map

package/dist/AVTextArea/AVTextArea.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVTextArea.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVTextArea/AVTextArea.vue"],"names":[],"mappings":"AACA,cAAc,4HAA4H,CAAC;AAC3I,OAAO,+EAA+E,CAAC;;AAEvF,wBAA0F"}

package/dist/{components/atoms/AVTextInput → AVTextInput}/AVTextInput.vue.d.ts

@@ -1,5 +1,5 @@
 export * from "/Users/alexis.toledo/Projects/ui-library/src/components/atoms/AVTextInput/AVTextInput.vue?vue&type=script&setup=true&lang.ts";
-import "./AVTextInput.css?vue&type=style&index=0&src=8460c413&scoped=8460c413&lang.css";
+import "./AVTextInput.css?vue&type=style&index=0&src=9e19bd68&scoped=9e19bd68&lang.css";
 declare const _default: any;
 export default _default;
 //# sourceMappingURL=AVTextInput.vue.d.ts.map

package/dist/AVTextInput/AVTextInput.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AVTextInput.vue.d.ts","sourceRoot":"","sources":["../../src/components/atoms/AVTextInput/AVTextInput.vue"],"names":[],"mappings":"AACA,cAAc,8HAA8H,CAAC;AAC7I,OAAO,gFAAgF,CAAC;;AAExF,wBAA0F"}

package/dist/UILibrary.d.ts

@@ -1,7 +1,7 @@
-import { AVButton, AVSpinner, AVBullet, AVTextInput, AVNumberInput, AVPasswordInput, AVRoundBox, AVRoundButton, AVLabel, AVDatetimeInput, AVTextArea, AVDropdown, AVDropdownContent, AVDropdownItem, AVAlert, AVFileInput } from "./components";
+import { AVButton, AVSpinner, AVBullet, AVTextInput, AVNumberInput, AVPasswordInput, AVRoundBox, AVRoundButton, AVLabel, AVDatetimeInput, AVTextArea, AVDropdown, AVDropdownContent, AVDropdownItem, AVAlert, AVFileInput, AVRadio, AVRadioGroup } from "./components";
 declare const _default: {
     install: (app: any) => void;
 };
 export default _default;
-export { AVButton, AVSpinner, AVBullet, AVTextInput, AVNumberInput, AVPasswordInput, AVRoundBox, AVRoundButton, AVLabel, AVDatetimeInput, AVTextArea, AVDropdown, AVDropdownContent, AVDropdownItem, AVAlert, AVFileInput };
+export { AVButton, AVSpinner, AVBullet, AVTextInput, AVNumberInput, AVPasswordInput, AVRoundBox, AVRoundButton, AVLabel, AVDatetimeInput, AVTextArea, AVDropdown, AVDropdownContent, AVDropdownItem, AVAlert, AVFileInput, AVRadio, AVRadioGroup };
 //# sourceMappingURL=UILibrary.d.ts.map

package/dist/UILibrary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UILibrary.d.ts","sourceRoot":"","sources":["../src/UILibrary.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,aAAa,EACb,eAAe,EACf,UAAU,EACV,aAAa,EACb,OAAO,EACP,eAAe,EACf,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,OAAO,EACP,WAAW,EACZ,MAAM,cAAc,CAAC;;;;AACtB,wBAoBE;AACF,OAAO,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,aAAa,EACb,eAAe,EACf,UAAU,EACV,aAAa,EACb,OAAO,EACP,eAAe,EACf,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,OAAO,EACP,WAAW,EACZ,CAAC"}
+{"version":3,"file":"UILibrary.d.ts","sourceRoot":"","sources":["../src/UILibrary.ts"],"names":[],"mappings":"AACA,OAAO,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,aAAa,EACb,eAAe,EACf,UAAU,EACV,aAAa,EACb,OAAO,EACP,eAAe,EACf,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,OAAO,EACP,WAAW,EACX,OAAO,EACP,YAAY,EACb,MAAM,cAAc,CAAC;;;;AACtB,wBAsBE;AACF,OAAO,EACL,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,WAAW,EACX,aAAa,EACb,eAAe,EACf,UAAU,EACV,aAAa,EACb,OAAO,EACP,eAAe,EACf,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,OAAO,EACP,WAAW,EACX,OAAO,EACP,YAAY,EACb,CAAC"}