@vsn-ux/ngx-gaia 1.0.0-alpha.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 (53) hide show
  1. package/README.md +55 -0
  2. package/fesm2022/vsn-ux-ngx-gaia.mjs +979 -0
  3. package/fesm2022/vsn-ux-ngx-gaia.mjs.map +1 -0
  4. package/index.d.ts +5 -0
  5. package/lib/button/button.directive.d.ts +7 -0
  6. package/lib/button/button.module.d.ts +8 -0
  7. package/lib/button/icon-button.directive.d.ts +8 -0
  8. package/lib/button/index.d.ts +3 -0
  9. package/lib/checkbox/checkbox-required.validator.d.ts +13 -0
  10. package/lib/checkbox/checkbox.component.d.ts +62 -0
  11. package/lib/checkbox/checkbox.module.d.ts +8 -0
  12. package/lib/checkbox/index.d.ts +3 -0
  13. package/lib/form-field/field-info.component.d.ts +5 -0
  14. package/lib/form-field/field-label.component.d.ts +9 -0
  15. package/lib/form-field/form-control.di.d.ts +10 -0
  16. package/lib/form-field/form-field.component.d.ts +8 -0
  17. package/lib/form-field/form-field.module.d.ts +10 -0
  18. package/lib/form-field/index.d.ts +5 -0
  19. package/lib/input/index.d.ts +3 -0
  20. package/lib/input/input.component.d.ts +11 -0
  21. package/lib/input/input.directive.d.ts +20 -0
  22. package/lib/input/input.module.d.ts +8 -0
  23. package/lib/menu/index.d.ts +5 -0
  24. package/lib/menu/menu-item.component.d.ts +6 -0
  25. package/lib/menu/menu-separator.componen.d.ts +5 -0
  26. package/lib/menu/menu-trigger.directive.d.ts +10 -0
  27. package/lib/menu/menu.component.d.ts +6 -0
  28. package/lib/menu/menu.module.d.ts +10 -0
  29. package/lib/segmented-control/index.d.ts +3 -0
  30. package/lib/segmented-control/segmented-control-button.directive.d.ts +10 -0
  31. package/lib/segmented-control/segmented-control.component.d.ts +7 -0
  32. package/lib/segmented-control/segmented-control.module.d.ts +8 -0
  33. package/lib/tooltip/index.d.ts +3 -0
  34. package/lib/tooltip/tooltip.component.d.ts +25 -0
  35. package/lib/tooltip/tooltip.directive.d.ts +60 -0
  36. package/lib/tooltip/tooltip.module.d.ts +7 -0
  37. package/package.json +33 -0
  38. package/public-api.d.ts +7 -0
  39. package/schematics/collection.json +16 -0
  40. package/schematics/ng-add/index.d.ts +3 -0
  41. package/schematics/ng-add/index.js +50 -0
  42. package/schematics/ng-add/index.js.map +1 -0
  43. package/schematics/ng-add/messages.d.ts +1 -0
  44. package/schematics/ng-add/messages.js +7 -0
  45. package/schematics/ng-add/messages.js.map +1 -0
  46. package/schematics/ng-add/schema.d.ts +10 -0
  47. package/schematics/ng-add/schema.js +3 -0
  48. package/schematics/ng-add/schema.js.map +1 -0
  49. package/schematics/ng-add/schema.json +21 -0
  50. package/schematics/ng-add/setup-project.d.ts +3 -0
  51. package/schematics/ng-add/setup-project.js +89 -0
  52. package/schematics/ng-add/setup-project.js.map +1 -0
  53. package/styles/global.scss +5 -0
package/README.md ADDED
@@ -0,0 +1,55 @@
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
+ TBA
13
+
14
+ ## Installation
15
+
16
+ ```sh
17
+ ng add @vsn-ux/ngx-gaia
18
+ ```
19
+
20
+ ## Manual installation
21
+
22
+ 1. Install this package together with two peer dependencies:
23
+
24
+ ```sh
25
+ npm i @vsn-ux/ngx-gaia @vsn-ux/gaia-styles @angular/cdk
26
+ ```
27
+
28
+ 2. Import the required styles inside your global (e.g. `style.css`) file:
29
+
30
+ ```css
31
+ // load inter font faces, you can skip this if you already have it in your project or want to use CDN
32
+ @import '@vsn-ux/gaia-styles/font/inter.css';
33
+
34
+ // One import that includes both global `@vsn-ux/gaia-styles` styles and extensions needed for the library
35
+ @import '@vsn-ux/ngx-gaia';
36
+
37
+ // In case you want to have a more granual control, import these prebuilt files manully:
38
+ // @import '@angular/cdk/overlay-prebuilt.css';
39
+ // @import '@vsn-ux/gaia-styles/all.css';
40
+ ```
41
+
42
+ ## Icons
43
+
44
+ TBA
45
+
46
+ ## Browser support
47
+
48
+ Follows PDAB Compatibility Policy:
49
+ the latest major stable version of Firefox, Chrome, Safari and Edge are supported. **No support for IE.**
50
+
51
+ ## Contributing to the library
52
+
53
+ You are more than welcome to open an issue or create a pull-request.
54
+ In the latter case, please make sure the changes follows the same coding principles,
55
+ is covered with unit tests and meets the official Gaia Design guidelines. 🙏