@rt-tools/utils 0.0.1

package/README.md

@@ -0,0 +1,99 @@
+# @rt-tools/utils
+
+Utility functions, pipes, directives, validators and services for Angular applications.
+
+## Installation
+
+```bash
+npm install @rt-tools/utils @rt-tools/core
+# or
+pnpm add @rt-tools/utils @rt-tools/core
+```
+
+## Features
+
+### Functions
+
+```typescript
+import { isEqual, isEmpty, isString, isNumber, debounce } from '@rt-tools/utils';
+
+// Check equality
+isEqual(obj1, obj2);
+
+// Check if value is empty
+isEmpty(value);
+
+// Type guards
+isString(value);
+isNumber(value);
+
+// Debounce function calls
+const debouncedFn = debounce(() => { /* ... */ }, 300);
+```
+
+### Pipes
+
+```typescript
+import { BreakStringPipe, SanitizePipe, EqualPipe, TernaryPipe } from '@rt-tools/utils';
+
+@Component({
+    imports: [BreakStringPipe, SanitizePipe, EqualPipe, TernaryPipe],
+    template: `
+        {{ 'camelCaseString' | breakString }}
+        {{ htmlContent | sanitize }}
+        {{ value | equal:compareValue }}
+        {{ condition | ternary:'yes':'no' }}
+    `
+})
+```
+
+### Directives
+
+```typescript
+import { RtIconOutlinedDirective, ScrollToElementDirective } from '@rt-tools/utils';
+
+@Component({
+    imports: [RtIconOutlinedDirective, ScrollToElementDirective],
+    template: `
+        <mat-icon rtIconOutlined>settings</mat-icon>
+        <div rtScrollToElement [scrollTarget]="target"></div>
+    `
+})
+```
+
+### Services
+
+```typescript
+import { BreakpointService, DeviceDetectorService } from '@rt-tools/utils';
+
+@Component({ /* ... */ })
+export class MyComponent {
+    private breakpointService = inject(BreakpointService);
+    private deviceDetector = inject(DeviceDetectorService);
+
+    isMobile = this.breakpointService.isMobile;
+    isDesktop = this.breakpointService.isDesktop;
+}
+```
+
+### Providers
+
+```typescript
+import { provideRtUtils } from '@rt-tools/utils';
+
+bootstrapApplication(RootComponent, {
+    providers: [
+        provideRtUtils()
+    ]
+});
+```
+
+## Requirements
+
+- Angular 21+
+- @rt-tools/core ^0.0.1
+- RxJS 7.8+
+
+## License
+
+Apache-2.0