@rt-tools/ui-kit 0.0.28 → 0.1.0

package/README.md

@@ -1,178 +1,99 @@
-# @rt-tools/ui-kit
-
-[![npm](https://img.shields.io/npm/v/@rt-tools/ui-kit?color=c00)](https://www.npmjs.com/package/@rt-tools/ui-kit)
-[![Angular](https://img.shields.io/badge/Angular-22%2B-dd0031?logo=angular&logoColor=white)](https://angular.dev)
-[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/Eyhenij/rt-tools/blob/main/LICENSE)
-
-Themeable, signal-based UI components for Angular. Every component is standalone, tree-shakeable,
-and driven by CSS design tokens with built-in light / dark / auto theming and swappable brand
-color schemes.
-
-## Installation
-
-```bash
-pnpm add @rt-tools/ui-kit
-# or
-npm install @rt-tools/ui-kit
-```
-
-`@rt-tools/core`, `@rt-tools/store`, and `@rt-tools/utils` are installed automatically as dependencies.
-
-**Peer requirements:** Angular `^22.0.0` (`@angular/core`, `common`, `forms`, `animations`,
-`cdk`, `material`, `router`, `platform-browser`), `rxjs ^7.8.2`, `typescript ^6.0.0`.
-
-## Setup
-
-Provide the UI configuration once at bootstrap:
-
+# Set of utility types and functions for TypeScript
+Package uses Angular Signals (Angular 16+).
+
+## Interfaces & Types
+
+* ```typescript
+  IDictionary
+    ```
+* ```typescript
+  IntersectionType
+    ```
+* ```typescript
+  Modify
+  ```
+* ```typescript
+  IMapper
+  ```
+* ```typescript
+  Nullable
+  ```
+* ```typescript
+  PartialOmit
+  ```
+* ```typescript
+  Primitive
+  ```
+* Makes selected props from a record optional
 ```typescript
-import { bootstrapApplication } from '@angular/platform-browser';
-import { provideRtUi } from '@rt-tools/ui-kit';
-
-bootstrapApplication(AppComponent, {
-    providers: [
-        provideRtUi({
-            global: { theme: 'auto', design: 'custom' },
-            components: { button: { size: 'md', appearance: 'solid' } },
-        }),
-    ],
-});
-```
-
-Import the design-token stylesheet so components and your own styles share the same `--rt-*` variables:
-
-```scss
-@use '@rt-tools/ui-kit/styles/tokens.css';
-```
-
-## Usage
-
-Components are standalone — import only what you use:
-
+  Optional
+  ```
+* Get the union type of all the values in an object, array or array-like type
 ```typescript
-import { Component } from '@angular/core';
-import { RtuiButtonComponent } from '@rt-tools/ui-kit';
-
-@Component({
-    selector: 'app-demo',
-    imports: [RtuiButtonComponent],
-    template: `
-        <rtui-button type="pill" variant="primary" text="Save" icon="check" (click)="save()" />
-    `,
-})
-export class DemoComponent {
-    save(): void {
-        /* ... */
-    }
-}
-```
-
-## Components
-
-All components use the `rtui-` prefix.
-
-| Group | Components |
-| --- | --- |
-| **Actions & forms** | `rtui-button`, `rtui-multi-button`, `rtui-icon`, `rtui-checkbox`, `rtui-toggle`, `rtui-file-upload`, `rtui-image-upload` |
-| **Overlays & feedback** | `rtui-modal`, `rtui-aside`, `rtui-popover`, `rtui-snack-bar`, `rtui-spinner`, `rtui-info-badge` |
-| **Data display** | `rtui-table`, `rtui-dynamic-list`, `rtui-dynamic-selector`, `rtui-dynamic-input`, `rtui-pagination` |
-| **Layout & navigation** | `rtui-header`, `rtui-toolbar`, `rtui-side-menu`, `rtui-scrollable`, `rtui-action-bar` |
-
-### `rtui-button`
+  ValuesType
+  ```
 
-The button is fully configurable through inputs (all with sensible defaults):
 
-| Input | Type | Default |
-| --- | --- | --- |
-| `type` | `'icon' \| 'fab' \| 'pill'` | `'icon'` |
-| `variant` | `'default' \| 'primary' \| 'danger' \| 'success' \| 'warning' \| 'accent'` | `'default'` |
-| `appearance` | `'solid' \| 'outline' \| 'light' \| 'text'` | config / `'solid'` |
-| `size` | `'xs' \| 'sm' \| 'md' \| 'lg'` | config / `'md'` |
-| `radius` | `'none' \| 'sm' \| 'md' \| 'lg' \| 'full'` | config / `'full'` |
-| `design` | `'custom' \| 'material'` | config / `'custom'` |
-| `icon` / `iconPosition` | `string` / `'start' \| 'end'` | `''` / `'start'` |
-| `text` | `string` | `''` |
-| `loading` / `disabled` | `boolean` | `false` |
+## Functions
 
-```html
-<rtui-button type="pill" variant="primary" appearance="outline" text="Confirm" icon="check" />
-<rtui-button type="icon" icon="delete" variant="danger" />
-<rtui-button type="pill" text="Loading" [loading]="true" />
-```
-
-## Theming
-
-`RtThemeService` controls the active mode and brand palette from anywhere:
 
+* ```typescript
+  isDateValid(date?: Date): boolean;
+  ```
+* ```typescript
+  dateStringToDate(date: string | Date): Date;
+  ```
+* Indicates if the arguments are equal
 ```typescript
-import { inject } from '@angular/core';
-import { RtThemeService } from '@rt-tools/ui-kit';
-
-const theme = inject(RtThemeService);
-
-theme.setTheme('dark'); // 'light' | 'dark' | 'auto'
-theme.toggle();
-
-// Register and activate a brand color scheme (tonal ramp, 0–100)
-theme.registerColorScheme('teal', {
-    primary: { 40: '#5cb8b5', 60: '#1a9d99', 100: '#008582' },
-    brand: { 100: '#008582' },
-});
-theme.setColorScheme('teal'); // pass null to reset to the default palette
-```
-
-Accent roles a scheme may override: `primary`, `info`, `success`, `warning`, `danger`, `brand`.
-One ramp serves both light and dark — the active mode selects the tone. The chosen theme and
-scheme are persisted per user.
-
-## Configuration resolution
-
-Defaults are resolved most-specific-first:
-
-1. the component input on a concrete instance,
-2. `components.<name>` in `provideRtUi()`,
-3. `global` in `provideRtUi()`,
-4. the library default.
-
-## Design modes
-
-Design-aware controls render in one of two modes:
-
-- **`custom`** — the native rt-tools look driven by design tokens (default).
-- **`material`** — the control renders as a real Angular Material component, so it matches
-  surrounding Material UI while you migrate.
-
-```html
-<rtui-button design="material" type="pill" text="Native Material" />
-```
-
-## Using Material Symbols icons
-
-`rtui-icon` (and icon-bearing components) render [Material Symbols](https://fonts.google.com/icons):
-
-1. Add the font to `index.html`:
-
-   ```html
-   <link rel="preconnect" href="https://fonts.gstatic.com" />
-   <link
-       href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&display=block"
-       rel="stylesheet" />
-   ```
-
-2. Set the default font set in your root component:
-
-   ```typescript
-   import { inject } from '@angular/core';
-   import { MatIconRegistry } from '@angular/material/icon';
-
-   inject(MatIconRegistry).setDefaultFontSetClass('material-symbols-outlined');
-   ```
-
-## Documentation
-
-Full API references and live examples are available in **Storybook** (`pnpm run storybook` in the
-[repository](https://github.com/Eyhenij/rt-tools)).
-
-## License
-
-[Apache-2.0](https://github.com/Eyhenij/rt-tools/blob/main/LICENSE) © Yauheni Krumin
+  isEqual<T>(f: T, s: T): boolean;
+  ```
+* Indicates if the content of two arrays is identical
+```typescript
+  areArraysEqual<T>(f: T[], s: T[]): boolean;
+  ```
+* Indicates if the content of two arrays is identical
+```typescript
+  areObjectsEqual<T>(f: T, s: T): boolean;
+  ```
+* ```typescript
+  isNumber<T>(value: T | number | unknown | undefined): value is number;
+  ```
+* ```typescript
+  initToday(): Date;
+  ```
+* ```typescript
+  isToday(date: Date): boolean;
+  ```
+* Make shallow copy of passed object 
+```typescript
+  removeFieldFromObject<T extends object, K extends string>(obj: T, key: K): Omit<T, K>;
+  ``` 
+* Allow to compare two values by provided comparator
+```typescript
+  safeCompare<T>(a: T, b: T, comparator: ComparatorType<T>): number;
+  ```
+* Allow to safely compare two string values
+```typescript
+  safeStrCompare(a: string, b: string): number;
+  ```
+* Allow to safely compare two number values
+```typescript
+  safeNumCompare(a: number, b: number): number;
+  ```
+* Allow composing comparison chain of several comparators
+that delegate comparison by the chain to the next comparators if current comparator returns 0 
+```typescript
+  safeComparatorPipe(...comparators: Array<() => number>): number;
+  ```
+* ```typescript
+  sortByAlphabet: <T extends object>(a: T, b: T, field: keyof T) => number;
+  ```
+* ```typescript
+  sortByDate: (a: { [field: string]: any }, b: { [field: string]: any }, field: string) => number
+  ```
+* ```typescript
+  stringifyHttpLikeParams<T extends {}>(params: T): { [param: string]: string | string[] }
+  ```
+* ```typescript
+  transformArrayInput<T>(array: unknown): T[]
+  ```

package/fesm2022/rt-tools-ui-kit.mjs

@@ -1,6 +1,6 @@
 import { NgStyle, NgClass, NgComponentOutlet, NgTemplateOutlet, AsyncPipe, DOCUMENT, TitleCasePipe } from '@angular/common';
 import * as i0 from '@angular/core';
-import { inject, HostBinding, ChangeDetectionStrategy, Component, Injectable, Directive, contentChild, TemplateRef, input, booleanAttribute, output, viewChild, signal, computed, numberAttribute, InjectionToken, Injector, ViewEncapsulation, model, DestroyRef, effect, HostListener, ElementRef, forwardRef, ChangeDetectorRef, untracked, ViewContainerRef, afterNextRender } from '@angular/core';
+import { inject, HostBinding, ChangeDetectionStrategy, Component, Injectable, Directive, contentChild, TemplateRef, input, booleanAttribute, effect, output, viewChild, signal, computed, numberAttribute, InjectionToken, Injector, ViewEncapsulation, model, DestroyRef, HostListener, ElementRef, forwardRef, ChangeDetectorRef, untracked, ViewContainerRef, afterNextRender } from '@angular/core';
 import * as i1 from '@angular/forms';
 import { FormControl, Validators, ReactiveFormsModule, FormBuilder, FormsModule, NG_VALUE_ACCESSOR, NG_VALIDATORS } from '@angular/forms';
 import * as i5 from '@angular/material/button';
@@ -12,13 +12,13 @@ import * as i3 from '@angular/material/input';
 import { MatInputModule, MatInput, MatFormField as MatFormField$1, MatLabel } from '@angular/material/input';
 import * as i4 from '@angular/material/select';
 import { MatSelectModule, MatSelect } from '@angular/material/select';
-import { BlockDirective, ElemDirective, ModDirective, WINDOW, IDBStorageService, PlatformService, LOCAL_STORAGE } from '@rt-tools/core';
-import { checkIsMatchingValues, SanitizePipe, RtIconOutlinedDirective, RtHideTooltipDirective, transformArrayInput, RtScrollToElementDirective, RtNavigationDirective, transformStringInput, isString, isNumber, areArraysEqual, EmptyToDashPipe, LIST_SORT_ORDER_ENUM, FILTER_OPERATOR_TYPE_ENUM, FILTER_OPERATORS, isDate, BreakpointService, DeviceDetectorService, OSTypes, RtScrollDirective, BreakStringPipe, EntityToStringPipe, OVERLAY_POSITIONS, areArraysEqualUnordered, checkIsEntityInArrayByKey, sortByAlphabet, RtEscapeKeyDirective, POSITION_ENUM } from '@rt-tools/utils';
+import { checkIsMatchingValues, BlockDirective, ElemDirective, SanitizePipe, ModDirective, RtIconOutlinedDirective, RtScrollToElementDirective, RtNavigationDirective, WINDOW, IDBStorageService, EmptyToDashPipe, PlatformService, BreakpointService, DeviceDetectorService, OSTypes, RtScrollDirective, BreakStringPipe, EntityToStringPipe, OVERLAY_POSITIONS, RtEscapeKeyDirective, POSITION_ENUM, LOCAL_STORAGE } from '@rt-tools/core';
 import { ReplaySubject, share, Subject, merge, of, noop } from 'rxjs';
 import { filter, map, delay, take, tap, switchMap, debounceTime, distinctUntilChanged } from 'rxjs/operators';
 import { MatListItem, MatNavList, MatListItemIcon, MatListItemTitle } from '@angular/material/list';
 import * as i1$2 from '@angular/material/sidenav';
 import { MatDrawer, MatSidenavModule } from '@angular/material/sidenav';
+import { transformArrayInput, transformStringInput, isString, isNumber, areArraysEqual, LIST_SORT_ORDER_ENUM, FILTER_OPERATOR_TYPE_ENUM, FILTER_OPERATORS, isDate, areArraysEqualUnordered, checkIsEntityInArrayByKey, sortByAlphabet } from '@rt-tools/utils';
 import * as i1$1 from '@angular/material/expansion';
 import { MatExpansionModule } from '@angular/material/expansion';
 import * as i1$5 from '@angular/material/tooltip';
@@ -208,6 +208,57 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.5", ngImpor
                             read: TemplateRef,
                         }, isSignal: true }] }] } });
 
+class RtHideTooltipDirective {
+    #matTooltip;
+    /** Set tooltip state by 'isTooltipShown' */
+    constructor() {
+        this.#matTooltip = inject(MatTooltip);
+        /** Current HTMLElement */
+        this.element = input.required({ ...(ngDevMode ? { debugName: "element" } : /* istanbul ignore next */ {}), alias: 'rtHideTooltipDirective' });
+        /** Indicates is tooltip shown */
+        this.isTooltipShown = input.required({ ...(ngDevMode ? { debugName: "isTooltipShown" } : /* istanbul ignore next */ {}), transform: booleanAttribute });
+        effect(() => {
+            if (this.isTooltipShown()) {
+                this.#setTooltipState();
+            }
+            else {
+                this.#matTooltip.disabled = true;
+            }
+        });
+    }
+    ngAfterViewInit() {
+        const element = this.element();
+        /** Set tooltip state when HTMLElement changed */
+        if (element) {
+            const observer = new MutationObserver(() => {
+                if (this.isTooltipShown()) {
+                    this.#setTooltipState();
+                }
+            });
+            observer.observe(element, {
+                childList: true,
+                characterData: true,
+                subtree: true,
+            });
+            if (this.isTooltipShown()) {
+                this.#setTooltipState();
+            }
+        }
+    }
+    /** Set tooltip state by container and content width */
+    #setTooltipState() {
+        this.#matTooltip.disabled = this.element()?.offsetWidth === this.element()?.scrollWidth;
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.0.5", ngImport: i0, type: RtHideTooltipDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive }); }
+    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "17.1.0", version: "22.0.5", type: RtHideTooltipDirective, isStandalone: true, selector: "[rtHideTooltipDirective]", inputs: { element: { classPropertyName: "element", publicName: "rtHideTooltipDirective", isSignal: true, isRequired: true, transformFunction: null }, isTooltipShown: { classPropertyName: "isTooltipShown", publicName: "isTooltipShown", isSignal: true, isRequired: true, transformFunction: null } }, ngImport: i0 }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.5", ngImport: i0, type: RtHideTooltipDirective, decorators: [{
+            type: Directive,
+            args: [{
+                    selector: '[rtHideTooltipDirective]',
+                }]
+        }], ctorParameters: () => [], propDecorators: { element: [{ type: i0.Input, args: [{ isSignal: true, alias: "rtHideTooltipDirective", required: true }] }], isTooltipShown: [{ type: i0.Input, args: [{ isSignal: true, alias: "isTooltipShown", required: true }] }] } });
+
 class RtuiSideMenuSubItemComponent {
     constructor() {
         this.menuRef = inject(RtuiSideMenuComponent);
@@ -5138,5 +5189,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.0.5", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { ASIDE_BUTTONS_ENUM, ASIDE_REF, AsideRef, DEFAULT_PAGE_MODEL, DEFAULT_PAGE_SIZE, INFO_BADGE_SIZE_ENUM, INFO_BADGE_TYPE_ENUM, MODAL_WINDOW_SIZE_ENUM, RTUI_TABLE_COMPONENT_TOKEN, RTUI_TABLE_STOP_ROW_CLICK_ATTRIBUTE, RT_ACCENT_ROLE_ENUM, RT_COLOR_SCHEME_STORAGE_KEY, RT_DARK_CLASS, RT_DEFAULT_SCHEME, RT_SCHEME_ATTRIBUTE, RT_THEME_ATTRIBUTE, RT_THEME_AUTO_CLASS, RT_THEME_ENUM, RT_THEME_STORAGE_KEY, RT_UI_CONFIG, RtActionBarService, RtAsideService, RtDynamicListSelectorsDirective, RtModalService, RtPopoverDirective, RtSnackBarService, RtTableConfigService, RtTableSelectorsDirective, RtThemeDirective, RtThemeService, RtuiActionBarComponent, RtuiActionBarContainerComponent, RtuiAsideContainerComponent, RtuiAsideContainerHeaderDirective, RtuiButtonComponent, RtuiClearButtonComponent, RtuiCustomTableCellsDirective, RtuiDynamicInputAdditionalControlDirective, RtuiDynamicInputComponent, RtuiDynamicListComponent, RtuiDynamicListCustomTableCellsDirective, RtuiDynamicListRowActionsDirective, RtuiDynamicListRowAdditionalActionsDirective, RtuiDynamicListToolbarActionsDirective, RtuiDynamicListToolbarSelectorsDirective, RtuiDynamicSelectorAdditionalControlDirective, RtuiDynamicSelectorComponent, RtuiDynamicSelectorItemAdditionalControlDirective, RtuiDynamicSelectorItemTitleDirective, RtuiDynamicSelectorItemTitleProjectionDirective, RtuiDynamicSelectorListActionsComponent, RtuiDynamicSelectorPlaceholderComponent, RtuiDynamicSelectorSelectedListComponent, RtuiFileUploadComponent, RtuiHeaderCenterDirective, RtuiHeaderComponent, RtuiHeaderLeftDirective, RtuiHeaderRightDirective, RtuiIconComponent, RtuiImageUploadComponent, RtuiInfoBadgeComponent, RtuiModalComponent, RtuiMultiButtonComponent, RtuiMultiSelectorPopupComponent, RtuiPaginationComponent, RtuiScrollableContainerComponent, RtuiScrollableContainerContentDirective, RtuiScrollableContainerFooterDirective, RtuiScrollableContainerHeaderDirective, RtuiSideMenuComponent, RtuiSideMenuFooterDirective, RtuiSideMenuHeaderDirective, RtuiSnackBarComponent, RtuiSpinnerComponent, RtuiStopTableRowClickDirective, RtuiTableAdditionalRowActionsDirective, RtuiTableComponent, RtuiTableRowActionsDirective, RtuiTableRowClickDirective, RtuiToggleComponent, RtuiToolbarCenterDirective, RtuiToolbarComponent, RtuiToolbarLeftDirective, RtuiToolbarRightDirective, TABLE_COLUMN_FILTER_TYPES_ENUM, TABLE_COLUMN_TYPES_ENUM, TEXT_CELL_COLOR_ENUM, TOGGLE_SIZE_TYPE_ENUM, darkenHexColor, ddServices, getColorBasedOnBackground, progressDecreaseAnimation, progressIncreaseAnimation, provideRtUi };
+export { ASIDE_BUTTONS_ENUM, ASIDE_REF, AsideRef, DEFAULT_PAGE_MODEL, DEFAULT_PAGE_SIZE, INFO_BADGE_SIZE_ENUM, INFO_BADGE_TYPE_ENUM, MODAL_WINDOW_SIZE_ENUM, RTUI_TABLE_COMPONENT_TOKEN, RTUI_TABLE_STOP_ROW_CLICK_ATTRIBUTE, RT_ACCENT_ROLE_ENUM, RT_COLOR_SCHEME_STORAGE_KEY, RT_DARK_CLASS, RT_DEFAULT_SCHEME, RT_SCHEME_ATTRIBUTE, RT_THEME_ATTRIBUTE, RT_THEME_AUTO_CLASS, RT_THEME_ENUM, RT_THEME_STORAGE_KEY, RT_UI_CONFIG, RtActionBarService, RtAsideService, RtDynamicListSelectorsDirective, RtHideTooltipDirective, RtModalService, RtPopoverDirective, RtSnackBarService, RtTableConfigService, RtTableSelectorsDirective, RtThemeDirective, RtThemeService, RtuiActionBarComponent, RtuiActionBarContainerComponent, RtuiAsideContainerComponent, RtuiAsideContainerHeaderDirective, RtuiButtonComponent, RtuiClearButtonComponent, RtuiCustomTableCellsDirective, RtuiDynamicInputAdditionalControlDirective, RtuiDynamicInputComponent, RtuiDynamicListComponent, RtuiDynamicListCustomTableCellsDirective, RtuiDynamicListRowActionsDirective, RtuiDynamicListRowAdditionalActionsDirective, RtuiDynamicListToolbarActionsDirective, RtuiDynamicListToolbarSelectorsDirective, RtuiDynamicSelectorAdditionalControlDirective, RtuiDynamicSelectorComponent, RtuiDynamicSelectorItemAdditionalControlDirective, RtuiDynamicSelectorItemTitleDirective, RtuiDynamicSelectorItemTitleProjectionDirective, RtuiDynamicSelectorListActionsComponent, RtuiDynamicSelectorPlaceholderComponent, RtuiDynamicSelectorSelectedListComponent, RtuiFileUploadComponent, RtuiHeaderCenterDirective, RtuiHeaderComponent, RtuiHeaderLeftDirective, RtuiHeaderRightDirective, RtuiIconComponent, RtuiImageUploadComponent, RtuiInfoBadgeComponent, RtuiModalComponent, RtuiMultiButtonComponent, RtuiMultiSelectorPopupComponent, RtuiPaginationComponent, RtuiScrollableContainerComponent, RtuiScrollableContainerContentDirective, RtuiScrollableContainerFooterDirective, RtuiScrollableContainerHeaderDirective, RtuiSideMenuComponent, RtuiSideMenuFooterDirective, RtuiSideMenuHeaderDirective, RtuiSnackBarComponent, RtuiSpinnerComponent, RtuiStopTableRowClickDirective, RtuiTableAdditionalRowActionsDirective, RtuiTableComponent, RtuiTableRowActionsDirective, RtuiTableRowClickDirective, RtuiToggleComponent, RtuiToolbarCenterDirective, RtuiToolbarComponent, RtuiToolbarLeftDirective, RtuiToolbarRightDirective, TABLE_COLUMN_FILTER_TYPES_ENUM, TABLE_COLUMN_TYPES_ENUM, TEXT_CELL_COLOR_ENUM, TOGGLE_SIZE_TYPE_ENUM, darkenHexColor, ddServices, getColorBasedOnBackground, progressDecreaseAnimation, progressIncreaseAnimation, provideRtUi };
 //# sourceMappingURL=rt-tools-ui-kit.mjs.map