@vsn-ux/ngx-gaia 0.1.1

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.
Files changed (59) hide show
  1. package/README.md +59 -0
  2. package/fesm2022/vsn-ux-ngx-gaia.mjs +1039 -0
  3. package/fesm2022/vsn-ux-ngx-gaia.mjs.map +1 -0
  4. package/index.d.ts +5 -0
  5. package/lib/badge/badge.component.d.ts +10 -0
  6. package/lib/badge/badge.module.d.ts +7 -0
  7. package/lib/badge/index.d.ts +2 -0
  8. package/lib/button/button.directive.d.ts +7 -0
  9. package/lib/button/button.module.d.ts +8 -0
  10. package/lib/button/icon-button.directive.d.ts +8 -0
  11. package/lib/button/index.d.ts +3 -0
  12. package/lib/card/card.component.d.ts +7 -0
  13. package/lib/card/card.module.d.ts +7 -0
  14. package/lib/card/index.d.ts +2 -0
  15. package/lib/checkbox/checkbox-required.validator.d.ts +13 -0
  16. package/lib/checkbox/checkbox.component.d.ts +62 -0
  17. package/lib/checkbox/checkbox.module.d.ts +8 -0
  18. package/lib/checkbox/index.d.ts +3 -0
  19. package/lib/form-field/field-info.component.d.ts +5 -0
  20. package/lib/form-field/field-label.component.d.ts +9 -0
  21. package/lib/form-field/form-control.di.d.ts +10 -0
  22. package/lib/form-field/form-field.component.d.ts +8 -0
  23. package/lib/form-field/form-field.module.d.ts +10 -0
  24. package/lib/form-field/index.d.ts +5 -0
  25. package/lib/input/index.d.ts +3 -0
  26. package/lib/input/input.component.d.ts +11 -0
  27. package/lib/input/input.directive.d.ts +20 -0
  28. package/lib/input/input.module.d.ts +8 -0
  29. package/lib/menu/index.d.ts +5 -0
  30. package/lib/menu/menu-item.component.d.ts +6 -0
  31. package/lib/menu/menu-separator.componen.d.ts +5 -0
  32. package/lib/menu/menu-trigger.directive.d.ts +10 -0
  33. package/lib/menu/menu.component.d.ts +6 -0
  34. package/lib/menu/menu.module.d.ts +10 -0
  35. package/lib/segmented-control/index.d.ts +3 -0
  36. package/lib/segmented-control/segmented-control-button.directive.d.ts +10 -0
  37. package/lib/segmented-control/segmented-control.component.d.ts +7 -0
  38. package/lib/segmented-control/segmented-control.module.d.ts +8 -0
  39. package/lib/tooltip/index.d.ts +3 -0
  40. package/lib/tooltip/tooltip.component.d.ts +25 -0
  41. package/lib/tooltip/tooltip.directive.d.ts +61 -0
  42. package/lib/tooltip/tooltip.module.d.ts +7 -0
  43. package/package.json +34 -0
  44. package/public-api.d.ts +9 -0
  45. package/schematics/collection.json +16 -0
  46. package/schematics/ng-add/index.d.ts +3 -0
  47. package/schematics/ng-add/index.js +50 -0
  48. package/schematics/ng-add/index.js.map +1 -0
  49. package/schematics/ng-add/messages.d.ts +1 -0
  50. package/schematics/ng-add/messages.js +7 -0
  51. package/schematics/ng-add/messages.js.map +1 -0
  52. package/schematics/ng-add/schema.d.ts +10 -0
  53. package/schematics/ng-add/schema.js +3 -0
  54. package/schematics/ng-add/schema.js.map +1 -0
  55. package/schematics/ng-add/schema.json +21 -0
  56. package/schematics/ng-add/setup-project.d.ts +3 -0
  57. package/schematics/ng-add/setup-project.js +89 -0
  58. package/schematics/ng-add/setup-project.js.map +1 -0
  59. package/styles/global.scss +5 -0
package/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # ngx-gaia
2
+
3
+ Common **Gaia UI** components for [Angular](https://angular.io).
4
+
5
+ - 🔥 Uses [storybook](https://storybook.js.org/);
6
+ - 🔥 Follows [semantic versioning](https://semver.org/);
7
+ - 🔥 Uses [conventional commits](https://www.conventionalcommits.org) together with [standard version](https://github.com/conventional-changelog/standard-version) for a better changelog;
8
+ - 🔥 Accessibility in mind;
9
+
10
+ ## Demo & documentation
11
+
12
+ https://super-barnacle-7kqz8r2.pages.github.io/
13
+
14
+ ## Disclaimer
15
+
16
+ The Tailwind CSS utility classes (e.g. `flex gap-2`) used in these storybook examples are used for demo purposes only, they represent UI structure rather than specific design choices. Your application will need to include its own Tailwind CSS setup or alternative solution.
17
+
18
+ ## Installation
19
+
20
+ ```sh
21
+ ng add @vsn-ux/ngx-gaia
22
+ ```
23
+
24
+ ## Manual installation
25
+
26
+ 1. Install this package:
27
+
28
+ ```sh
29
+ npm i @vsn-ux/ngx-gaia
30
+ ```
31
+
32
+ 2. Import the required styles inside your global (e.g. `style.css`) file:
33
+
34
+ ```css
35
+ // load inter font faces, you can skip this if you already have it in your project or want to use CDN
36
+ @import '@vsn-ux/gaia-styles/font/inter.css';
37
+
38
+ // One import that includes both global `@vsn-ux/gaia-styles` styles and extensions needed for the library
39
+ @import '@vsn-ux/ngx-gaia';
40
+
41
+ // In case you want to have a more granual control, import these prebuilt files manully:
42
+ // @import '@angular/cdk/overlay-prebuilt.css';
43
+ // @import '@vsn-ux/gaia-styles/all.css';
44
+ ```
45
+
46
+ ## Icons
47
+
48
+ TBA
49
+
50
+ ## Browser support
51
+
52
+ Follows PDAB Compatibility Policy:
53
+ the latest major stable version of Firefox, Chrome, Safari and Edge are supported. **No support for IE.**
54
+
55
+ ## Contributing to the library
56
+
57
+ You are more than welcome to open an issue or create a pull-request.
58
+ In the latter case, please make sure the changes follows the same coding principles,
59
+ is covered with unit tests and meets the official Gaia Design guidelines. 🙏