@xiriframework/xiri-ng 0.2.0

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,69 @@
1
+ # @xiriframework/xiri-ng
2
+
3
+ Angular UI component library for the Xiri Framework.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @xiriframework/xiri-ng
9
+ ```
10
+
11
+ ## Configuration
12
+
13
+ ```typescript
14
+ import { provideXiriServices } from '@xiriframework/xiri-ng';
15
+
16
+ bootstrapApplication(AppComponent, {
17
+ providers: [
18
+ provideXiriServices({ api: '/api/' }),
19
+ ]
20
+ });
21
+ ```
22
+
23
+ The `api` configuration sets the base URL for the `XiriDataService`, which prepends this path to all HTTP requests.
24
+
25
+ ## Components
26
+
27
+ Import components individually for optimal tree-shaking:
28
+
29
+ ```typescript
30
+ import { XiriTableComponent, XiriFormComponent } from '@xiriframework/xiri-ng';
31
+ ```
32
+
33
+ ### Available Components
34
+
35
+ - **XiriFormComponent** - Dynamic form generation from configuration
36
+ - **XiriTableComponent** - Feature-rich data table with server-side operations
37
+ - **XiriRawTableComponent** - Basic table for simple use cases
38
+ - **XiriCardComponent** - Card-based layouts
39
+ - **XiriDialogComponent** - Modal dialogs
40
+ - **XiriStepperComponent** - Multi-step workflows
41
+ - **XiriTabsComponent** - Tabbed layouts
42
+ - **XiriHeaderComponent** - Page headers
43
+ - **XiriSidenavComponent** - Navigation sidebar
44
+ - **XiriButtonlineComponent** - Button groups
45
+ - **XiriSearchComponent** - Search input
46
+ - **XiriQueryComponent** - Query/filter component
47
+ - **XiriAlertComponent** - Status messages
48
+ - **XiriListComponent** - List display
49
+
50
+ ### Available Services
51
+
52
+ - **XiriDataService** - Central HTTP service
53
+ - **XiriDateService** - Date manipulation (wraps date-fns)
54
+ - **XiriFormService** - Form state management
55
+ - **XiriNumberService** - Number formatting
56
+ - **XiriLocalStorageService** - Type-safe localStorage wrapper
57
+ - **XiriSessionStorageService** - Type-safe sessionStorage wrapper
58
+ - **ThemeService** - Theme management
59
+
60
+ ## Peer Dependencies
61
+
62
+ - Angular 21+
63
+ - Angular Material 21+
64
+ - date-fns 4+
65
+ - RxJS 7+
66
+
67
+ ## License
68
+
69
+ Apache-2.0