@acontplus/ng-components 1.0.11 → 1.0.13

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,119 @@
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
+
26
+ Reusable card components for displaying content.
27
+
28
+ ### Dialog Wrapper
29
+
30
+ Enhanced dialog components with wrapper functionality.
31
+
32
+ ### Icons
33
+
34
+ Icon components for consistent iconography.
35
+
36
+ ### Material Input Chip
37
+
38
+ Chip input components integrated with Angular Material.
39
+
40
+ ### Material Theme Button
41
+
42
+ Themed button components.
43
+
44
+ ### Spinner
45
+
46
+ Loading spinner components.
47
+
48
+ ### Tables
49
+
50
+ Table components for data display.
51
+
52
+ ### Theme Toggle
53
+
54
+ Dark/light mode toggle component.
55
+
56
+ ### Autocomplete Wrapper
57
+
58
+ Enhanced autocomplete components.
59
+
60
+ ## Directives
61
+
62
+ ### To Upper Case
63
+
64
+ Directive to transform text to uppercase.
65
+
66
+ ## Pipes
67
+
68
+ ### Get Total
69
+
70
+ Pipe for calculating totals from arrays.
71
+
72
+ ### Status Display
73
+
74
+ Pipe for formatting status values.
75
+
76
+ ## Services
77
+
78
+ ### Dialog Service
79
+
80
+ Service for managing dialogs.
81
+
82
+ ### Overlay Service
83
+
84
+ Service for overlay management.
85
+
86
+ ### Theme Service
87
+
88
+ Service for theme management including dark mode.
89
+
90
+ ### Autocomplete Wrapper Service
91
+
92
+ Service for autocomplete functionality.
93
+
94
+ ## Form Controls
95
+
96
+ ### Dynamic Input
97
+
98
+ Dynamic form input components.
99
+
100
+ ## Styling
101
+
102
+ The library includes custom SCSS files for theming and styling:
103
+
104
+ - Custom button styles
105
+ - Custom dialog styles
106
+ - Mixins for reusable styles
107
+ - CSS variables for theming
108
+
109
+ ## Usage
110
+
111
+ Import the components you need:
112
+
113
+ ```typescript
114
+ import { CardsComponent, ThemeToggleComponent } from '@acontplus/ng-components';
115
+ ```
116
+
117
+ ## Running unit tests
118
+
119
+ Run `nx test ng-components` to execute the unit tests.