@acontplus/ng-components 1.0.10 → 1.0.12

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 CHANGED
@@ -1,9 +1,102 @@
1
1
  # @acontplus/ng-components
2
2
 
3
- Components for angular applications.
3
+ Angular UI components library for AcontPlus applications, providing reusable components, directives, pipes, and services built with Angular Material.
4
4
 
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
8
  npm install @acontplus/ng-components
9
9
  ```
10
+
11
+ ## Features
12
+
13
+ - **UI Components**: Cards, dialogs, icons, input chips, theme buttons, spinners, tables, theme toggle, autocomplete wrapper
14
+ - **Directives**: Text transformation directives (to-upper-case)
15
+ - **Pipes**: Data transformation pipes (get-total, status-display)
16
+ - **Services**: Dialog management, overlay services, theme management, autocomplete functionality
17
+ - **Form Controls**: Dynamic input components
18
+ - **Styling**: Custom SCSS mixins, variables, and theme support including dark mode
19
+ - **Angular Material Integration**: Built on top of Angular Material for consistent design
20
+ - **TypeScript Support**: Full type safety with comprehensive TypeScript definitions
21
+
22
+ ## Components
23
+
24
+ ### Cards
25
+ Reusable card components for displaying content.
26
+
27
+ ### Dialog Wrapper
28
+ Enhanced dialog components with wrapper functionality.
29
+
30
+ ### Icons
31
+ Icon components for consistent iconography.
32
+
33
+ ### Material Input Chip
34
+ Chip input components integrated with Angular Material.
35
+
36
+ ### Material Theme Button
37
+ Themed button components.
38
+
39
+ ### Spinner
40
+ Loading spinner components.
41
+
42
+ ### Tables
43
+ Table components for data display.
44
+
45
+ ### Theme Toggle
46
+ Dark/light mode toggle component.
47
+
48
+ ### Autocomplete Wrapper
49
+ Enhanced autocomplete components.
50
+
51
+ ## Directives
52
+
53
+ ### To Upper Case
54
+ Directive to transform text to uppercase.
55
+
56
+ ## Pipes
57
+
58
+ ### Get Total
59
+ Pipe for calculating totals from arrays.
60
+
61
+ ### Status Display
62
+ Pipe for formatting status values.
63
+
64
+ ## Services
65
+
66
+ ### Dialog Service
67
+ Service for managing dialogs.
68
+
69
+ ### Overlay Service
70
+ Service for overlay management.
71
+
72
+ ### Theme Service
73
+ Service for theme management including dark mode.
74
+
75
+ ### Autocomplete Wrapper Service
76
+ Service for autocomplete functionality.
77
+
78
+ ## Form Controls
79
+
80
+ ### Dynamic Input
81
+ Dynamic form input components.
82
+
83
+ ## Styling
84
+
85
+ The library includes custom SCSS files for theming and styling:
86
+
87
+ - Custom button styles
88
+ - Custom dialog styles
89
+ - Mixins for reusable styles
90
+ - CSS variables for theming
91
+
92
+ ## Usage
93
+
94
+ Import the components you need:
95
+
96
+ ```typescript
97
+ import { CardsComponent, ThemeToggleComponent } from '@acontplus/ng-components';
98
+ ```
99
+
100
+ ## Running unit tests
101
+
102
+ Run `nx test ng-components` to execute the unit tests.