ngx-pk-ui 0.0.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.
package/README.md ADDED
@@ -0,0 +1,74 @@
1
+ # ngx-pk-ui (Library Package)
2
+
3
+ Angular 21 UI component library and CSS utilities.
4
+
5
+ License: MIT
6
+
7
+ Source path:
8
+
9
+ - `projects/ngx-pk-ui/src/lib` for components
10
+ - `projects/ngx-pk-ui/src/styles` for CSS utilities
11
+
12
+ ## Build
13
+
14
+ ```bash
15
+ ng build ngx-pk-ui
16
+ ```
17
+
18
+ Output:
19
+
20
+ - `dist/ngx-pk-ui`
21
+
22
+ ## Test
23
+
24
+ ```bash
25
+ ng test ngx-pk-ui --no-watch
26
+ ```
27
+
28
+ Run one spec:
29
+
30
+ ```bash
31
+ npx vitest run projects/ngx-pk-ui/src/lib/pk-tabs/pk-tabs.spec.ts
32
+ ```
33
+
34
+ ## Publish
35
+
36
+ ```bash
37
+ ng build ngx-pk-ui
38
+ npm publish dist/ngx-pk-ui
39
+ ```
40
+
41
+ ## Exported API groups
42
+
43
+ - Tabs: `PkTabs`, `PkTab`
44
+ - Toastr: `PkToastr`, `PkToastrService`
45
+ - Alert: `PkAlert`, `PkAlertService`
46
+ - Modal: `PkModal`, `PkModalHeader`, `PkModalBody`, `PkModalFooter`
47
+ - Icon: `PkIcon`, icon model types
48
+ - Datagrid: `PkDatagridModule` and datagrid subcomponents/directives
49
+ - Datepicker: `PkDatepickerComponent`, services
50
+ - Progress: `PkProgressComponent`
51
+ - Treeview: `PkTreeviewComponent`, `PkTreeviewModule`
52
+ - Select: `PkSelectComponent`
53
+ - Autocomplete: `PkAutocompleteComponent`
54
+ - Typeahead: `PkTypeaheadComponent`
55
+
56
+ ## CSS utility files
57
+
58
+ - `styles/pk-ui.css` (all-in-one)
59
+ - `styles/pk-grid.css`
60
+ - `styles/pk-btn.css`
61
+ - `styles/pk-spinner.css`
62
+ - `styles/pk-badge.css`
63
+ - `styles/pk-card.css`
64
+ - `styles/pk-icon-font.css`
65
+
66
+ ## Consumer setup example
67
+
68
+ ```json
69
+ "styles": ["node_modules/ngx-pk-ui/styles/pk-ui.css"]
70
+ ```
71
+
72
+ ```ts
73
+ import { PkModal, PkModalHeader, PkModalBody, PkModalFooter } from 'ngx-pk-ui';
74
+ ```