@rt-tools/ui-kit-v2 0.23.3 → 0.24.0

package/types/rt-tools-ui-kit-v2-tree.d.ts

@@ -0,0 +1,282 @@
+import * as i0 from "@angular/core";
+import { InputSignal, InputSignalWithTransform, ModelSignal, OutputEmitterRef, Signal, TemplateRef } from "@angular/core";
+import { IRtIcon, TRtKitLabelMap } from "@rt-tools/ui-kit-v2/core";
+import { IRtSelect } from "@rt-tools/ui-kit-v2/select";
+import { IRtSideMenu } from "@rt-tools/ui-kit-v2/side-menu";
+import { IRtTag } from "@rt-tools/ui-kit-v2/tag";
+/**
+ * Модель `<rt-tree>`: один корневой неймспейс с префиксом `I`. Узел повторяет опцию выбора из
+ * списка, чтобы дерево считал тот же модуль, что считает его у `rt-select` и `rt-multiselect`.
+ */
+export declare namespace IRtTree {
+  /** Узел дерева: опция выбора из списка с необязательным описанием и детьми того же вида. */
+  interface Node<TValue> extends IRtSelect.Option<TValue> {
+    /** Вторая строка под подписью. */
+    description?: string;
+    /** Метки под подписью: поиск отмечает в них найденное так же, как в подписи. */
+    badges?: ReadonlyArray<Badge>;
+    children?: ReadonlyArray<Node<TValue>>;
+  }
+  /** Метка узла: текст и цвет палитры `rt-tag`. */
+  interface Badge {
+    text: string;
+    severity?: IRtTag.Severity;
+  }
+  /**
+   * Чем узел отмечается: флажками (выбор нескольких), радио (выбор одного) или ничем — тогда
+   * клик только выбирает узел наружу через `picked`.
+   */
+  type Mode = 'multiple' | 'single' | 'none';
+  /** Отметка строки: выбрано всё, часть или ничего. У листа части не бывает. */
+  type Mark = IRtSelect.TBranchState;
+  /** Видимая строка дерева: та же, что у выбора из списка, с узлом дерева внутри. */
+  interface Row<TValue> extends IRtSelect.Row<TValue> {
+    readonly option: Node<TValue>;
+  }
+  /** Подпись и описание строки, разрезанные по найденному слову. */
+  interface LabelParts {
+    readonly label: ReadonlyArray<IRtSideMenu.TitlePart>;
+    readonly description: ReadonlyArray<IRtSideMenu.TitlePart>;
+    readonly badges: ReadonlyArray<ReadonlyArray<IRtSideMenu.TitlePart>>;
+  }
+  /** Отметка строки, радио ли она и сколько выбрано под группой; `null` — числа нет. */
+  interface RowState {
+    readonly mark: Mark;
+    readonly radio: boolean;
+    readonly count: number | null;
+  }
+  /** Контекст разметки приложения в конце строки. */
+  interface NodeContext<TValue> {
+    $implicit: Node<TValue>;
+  }
+}
+/**
+ * Разметка приложения в конце каждой строки `rt-tree`. Узел строки приходит в контексте как
+ * `$implicit`: дерево не заводит вход под каждый такой элемент.
+ */
+export declare class RtTreeNodeEndDirective<TValue> {
+  readonly templateRef: TemplateRef<IRtTree.NodeContext<TValue>>;
+  static ɵfac: i0.ɵɵFactoryDeclaration<RtTreeNodeEndDirective<any>, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<RtTreeNodeEndDirective<any>, "ng-template[rtTreeNodeEnd]", never, {}, {}, never, never, true, never>;
+}
+/**
+ * Разметка приложения под подписью строки, в одной линии с метками узла. Узел строки приходит в
+ * контексте как `$implicit`.
+ */
+export declare class RtTreeNodeMetaDirective<TValue> {
+  readonly templateRef: TemplateRef<IRtTree.NodeContext<TValue>>;
+  static ɵfac: i0.ɵɵFactoryDeclaration<RtTreeNodeMetaDirective<any>, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<RtTreeNodeMetaDirective<any>, "ng-template[rtTreeNodeMeta]", never, {}, {}, never, never, true, never>;
+}
+/** Видимая строка с тем, что разметке нужно о ней знать. */
+interface IRtTreeView<TValue> {
+  readonly row: IRtTree.Row<TValue>;
+  readonly mark: IRtTree.Mark;
+  /** Рисуется ли у строки флажок или радио: у групп без отметок его нет. */
+  readonly marked: boolean;
+  /** Радио вместо флажка. */
+  readonly radio: boolean;
+  /** Строка выключена: свой `disabled` у узла или выключено всё дерево. */
+  readonly disabled: boolean;
+  /** Число выбранного под группой в конце строки; `null` — числа нет. */
+  readonly count: number | null;
+  readonly parts: IRtTree.LabelParts;
+  readonly highlighted: boolean;
+}
+/**
+ * Дерево выбора, стоящее на странице само по себе.
+ *
+ * Строки, листья, отметки ветвей, отбор по слову и боковые стрелки считает модуль дерева выбора
+ * из списка — тот же, что у `rt-select` и `rt-multiselect`. Выбор живёт в `value`; узлы не
+ * меняются. Раскрытые ветки и подсвеченная строка — состояние самого дерева.
+ *
+ * Клавиатура идёт через `handleKeydown`: его зовёт и само дерево с фокуса на себе, и приложение
+ * со своего поля поиска. Ответ — взята ли клавиша: чужую дерево не трогает.
+ */
+export declare class RtTreeComponent<TValue> {
+  #private;
+  protected readonly t: Signal<TRtKitLabelMap>;
+  protected readonly nodeEnd: Signal<RtTreeNodeEndDirective<TValue> | undefined>;
+  protected readonly nodeMeta: Signal<RtTreeNodeMetaDirective<TValue> | undefined>;
+  /** Разметка в конце строки: вход раньше директивы — обёртка вроде селектора отдаёт её входом. */
+  protected readonly endTemplate: Signal<TemplateRef<IRtTree.NodeContext<TValue>> | null>;
+  /** Разметка под подписью: вход раньше директивы. */
+  protected readonly metaTemplate: Signal<TemplateRef<IRtTree.NodeContext<TValue>> | null>;
+  /** Раскрытые ветки: до первого действия человека — ветки над выбранным. */
+  protected readonly openBranches: Signal<ReadonlySet<TValue>>;
+  protected readonly rows: Signal<ReadonlyArray<IRtTree.Row<TValue>>>;
+  protected readonly views: Signal<ReadonlyArray<IRtTreeView<TValue>>>;
+  protected readonly selectAllMark: Signal<IRtTree.Mark>;
+  protected readonly isSelectAllShown: Signal<boolean>;
+  /** Отметка «выбрать всё» встаёт над отметкой первой строки; у строки без отметки — над стрелкой. */
+  protected readonly isSelectAllUnderMark: Signal<boolean>;
+  /** Первая строка — лист: там, где у листа нет места под стрелку, его нет и у «выбрать всё». */
+  protected readonly isSelectAllOverLeaf: Signal<boolean>;
+  protected readonly emptyText: Signal<string>;
+  readonly nodes: InputSignal<ReadonlyArray<IRtTree.Node<TValue>>>;
+  readonly value: ModelSignal<ReadonlyArray<TValue>>;
+  readonly mode: InputSignal<IRtTree.Mode>;
+  readonly cascade: InputSignalWithTransform<boolean, unknown>;
+  readonly searchTerm: InputSignal<string>;
+  readonly showSelectAll: InputSignalWithTransform<boolean, unknown>;
+  readonly ariaLabel: InputSignal<string | null>;
+  /** Отметки у групп. Без них клик, пробел и Enter по группе раскрывают и сворачивают её. */
+  readonly branchMarks: InputSignalWithTransform<boolean, unknown>;
+  /** Клик без Ctrl и Cmd выбирает узел один; с Ctrl или Cmd добавляет к выбору. Только для флажков. */
+  readonly exclusive: InputSignalWithTransform<boolean, unknown>;
+  /** Скрывает ли слово поиска строки. Без отбора строки отбирает приложение, а слово только отмечено. */
+  readonly filter: InputSignalWithTransform<boolean, unknown>;
+  /** Выключенное дерево не меняет выбор ни кликом, ни клавишей, ни «выбрать всё»; ветки раскрываются стрелкой. */
+  /** Значок кита над подписью пустого дерева. Без него пустое дерево — одна подпись. */
+  readonly emptyIcon: InputSignal<IRtIcon.Name | null>;
+  /**
+   * Разметка в конце каждой строки, отданная входом. Нужна компоненту, который оборачивает дерево и
+   * не может положить в него директиву `rtTreeNodeEnd`; вход сильнее директивы.
+   */
+  readonly nodeEndTemplate: InputSignal<TemplateRef<IRtTree.NodeContext<TValue>> | null>;
+  /** Разметка под подписью каждой строки, отданная входом; вход сильнее директивы `rtTreeNodeMeta`. */
+  readonly nodeMetaTemplate: InputSignal<TemplateRef<IRtTree.NodeContext<TValue>> | null>;
+  readonly disabled: InputSignalWithTransform<boolean, unknown>;
+  readonly picked: OutputEmitterRef<IRtTree.Node<TValue>>;
+  /**
+   * Клавиша для дерева. Отвечает, взята ли она: не взятая идёт дальше нетронутой, поэтому
+   * приложение может отдавать сюда каждую клавишу своего поля поиска.
+   */
+  handleKeydown(event: KeyboardEvent): boolean;
+  expandAll(): void;
+  collapseAll(): void;
+  clearHighlight(): void;
+  protected onRowClick(row: IRtTree.Row<TValue>, event: MouseEvent): void;
+  protected onToggleClick(event: Event, value: TValue): void;
+  protected onSelectAll(): void;
+  /**
+   * Отметка строки, её вид и число выбранного под ней. Дерево числа не рисует; наследник со своими
+   * правилами выбора считает всё это по ним.
+   */
+  protected rowState(row: IRtTree.Row<TValue>, value: ReadonlyArray<TValue>, cascade: boolean): IRtTree.RowState;
+  protected selectAllMarkOf(rows: ReadonlyArray<IRtTree.Row<TValue>>, value: ReadonlyArray<TValue>): IRtTree.Mark;
+  protected selectAllChoice(rows: ReadonlyArray<IRtTree.Row<TValue>>, value: ReadonlyArray<TValue>): ReadonlyArray<TValue>;
+  /** Выбор после действия над узлом: в исключающем режиме без Ctrl и Cmd узел остаётся один. */
+  protected nextChoice(node: IRtTree.Node<TValue>, additive: boolean): ReadonlyArray<TValue>;
+  static ɵfac: i0.ɵɵFactoryDeclaration<RtTreeComponent<any>, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<RtTreeComponent<any>, "rt-tree", never, {
+    "nodes": {
+      "alias": "nodes";
+      "required": true;
+      "isSignal": true;
+    };
+    "value": {
+      "alias": "value";
+      "required": false;
+      "isSignal": true;
+    };
+    "mode": {
+      "alias": "mode";
+      "required": false;
+      "isSignal": true;
+    };
+    "cascade": {
+      "alias": "cascade";
+      "required": false;
+      "isSignal": true;
+    };
+    "searchTerm": {
+      "alias": "searchTerm";
+      "required": false;
+      "isSignal": true;
+    };
+    "showSelectAll": {
+      "alias": "showSelectAll";
+      "required": false;
+      "isSignal": true;
+    };
+    "ariaLabel": {
+      "alias": "ariaLabel";
+      "required": false;
+      "isSignal": true;
+    };
+    "branchMarks": {
+      "alias": "branchMarks";
+      "required": false;
+      "isSignal": true;
+    };
+    "exclusive": {
+      "alias": "exclusive";
+      "required": false;
+      "isSignal": true;
+    };
+    "filter": {
+      "alias": "filter";
+      "required": false;
+      "isSignal": true;
+    };
+    "emptyIcon": {
+      "alias": "emptyIcon";
+      "required": false;
+      "isSignal": true;
+    };
+    "nodeEndTemplate": {
+      "alias": "nodeEndTemplate";
+      "required": false;
+      "isSignal": true;
+    };
+    "nodeMetaTemplate": {
+      "alias": "nodeMetaTemplate";
+      "required": false;
+      "isSignal": true;
+    };
+    "disabled": {
+      "alias": "disabled";
+      "required": false;
+      "isSignal": true;
+    };
+  }, {
+    "value": "valueChange";
+    "picked": "picked";
+  }, ["nodeEnd", "nodeMeta"], never, true, never>;
+}
+/**
+ * Расчёт выбора `rt-tree` — чистые функции над неизменяемыми узлами.
+ *
+ * Строки, листья и отметки ветвей считает модуль дерева выбора из списка: здесь только то, чего у
+ * выбора из списка нет — режим отметок, выключенный каскад и «выбрать всё». Узлы не меняются
+ * никогда: каждая функция отвечает новым массивом выбора.
+ */
+type TNode<TValue> = IRtTree.Node<TValue>;
+/**
+ * Отметка строки. В каскаде ветка отмечена по своим листьям; без каскада и у листа — по тому,
+ * лежит ли в выборе сам узел.
+ */
+export declare function rtTreeMark<TValue>(node: TNode<TValue>, value: ReadonlyArray<TValue>, cascade: boolean): IRtTree.Mark;
+/**
+ * Выбор после клика по узлу. Выключенный узел выбор не меняет. Одиночный режим держит один узел и
+ * не снимает его повторным кликом. В каскаде ветка добавляет свои включённые листья или снимает
+ * их, когда выбраны все; выключенные листья остаются как были.
+ */
+export declare function rtTreeChoose<TValue>(node: TNode<TValue>, value: ReadonlyArray<TValue>, mode: IRtTree.Mode, cascade: boolean): ReadonlyArray<TValue>;
+/**
+ * Включённые листья видимых строк. Раскрытая ветка отдаёт листья своими строками ниже, свёрнутая —
+ * всеми листьями под собой: они видимы через неё.
+ */
+export declare function rtTreeVisibleLeaves<TValue>(rows: ReadonlyArray<IRtTree.Row<TValue>>): ReadonlyArray<TValue>;
+/** Отметка «выбрать всё» по включённым листьям видимых строк. */
+export declare function rtTreeSelectAllMark<TValue>(rows: ReadonlyArray<IRtTree.Row<TValue>>, value: ReadonlyArray<TValue>): IRtTree.Mark;
+/**
+ * Выбор после клика по «выбрать всё»: включённые листья видимых строк добавляются, а когда выбраны
+ * все — снимаются. Выключенные листья `rtTreeLeaves` не отдаёт, поэтому их состояние не меняется.
+ */
+export declare function rtTreeSelectAll<TValue>(rows: ReadonlyArray<IRtTree.Row<TValue>>, value: ReadonlyArray<TValue>): ReadonlyArray<TValue>;
+/**
+ * Подпись, описание и метки узла, разрезанные по каждому слову запроса тем же резом, что у поиска
+ * меню: приложение делит поиск по пробелам, и найденное слово видно там, где оно нашлось.
+ */
+export declare function rtTreeLabelParts<TValue>(node: TNode<TValue>, term: string): IRtTree.LabelParts;
+/** Что остаётся от выбора перед кликом без Ctrl и Cmd: то, что покрывает сам узел, и выключенные узлы. */
+export declare function rtTreeAloneBase<TValue>(nodes: ReadonlyArray<TNode<TValue>>, node: TNode<TValue>, value: ReadonlyArray<TValue>): ReadonlyArray<TValue>;
+/**
+ * Выбор после клика без Ctrl и Cmd в режиме, где клик выбирает один узел. Из выбора остаётся только
+ * то, что покрывает сам узел, и выключенные узлы; дальше клик работает как обычно — поэтому
+ * повторный клик по единственному выбранному снимает его.
+ */
+export declare function rtTreeChooseAlone<TValue>(nodes: ReadonlyArray<TNode<TValue>>, node: TNode<TValue>, value: ReadonlyArray<TValue>, cascade: boolean): ReadonlyArray<TValue>;
+export {};

package/types/rt-tools-ui-kit-v2-welcome-dialog.d.ts

@@ -1,13 +1,12 @@
-import * as i0 from '@angular/core';
-import { Signal } from '@angular/core';
-import { TRtKitLabelMap } from '@rt-tools/ui-kit-v2/core';
-
-declare namespace IRtWelcomeDialog {
-    /** Payload модалки: настраиваемый текст приветствия + подпись CTA-кнопки. */
-    interface Data {
-        message: string;
-        ctaLabel?: string;
-    }
+import * as i0 from "@angular/core";
+import { Signal } from "@angular/core";
+import { TRtKitLabelMap } from "@rt-tools/ui-kit-v2/core";
+export declare namespace IRtWelcomeDialog {
+  /** Payload модалки: настраиваемый текст приветствия + подпись CTA-кнопки. */
+  interface Data {
+    message: string;
+    ctaLabel?: string;
+  }
 }
 /**
  * Welcome-модалка первого входа: показывает настраиваемый текст приветствия роли.
@@ -17,17 +16,15 @@ declare namespace IRtWelcomeDialog {
  * заголовком, остальные — параграфами описания. Без `rt-dialog-header` —
  * единственное действие закрытия — CTA-кнопка.
  */
-declare class RtWelcomeDialogComponent {
-    #private;
-    protected readonly t: Signal<TRtKitLabelMap>;
-    protected readonly title: string;
-    protected readonly paragraphs: string[];
-    /** Своя подпись важнее умолчания: роль знает, куда ведёт кнопка */
-    protected readonly ctaLabel: Signal<string>;
-    constructor();
-    protected onClose(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RtWelcomeDialogComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<RtWelcomeDialogComponent, "rt-welcome-dialog", never, {}, {}, never, never, true, never>;
-}
-
-export { IRtWelcomeDialog, RtWelcomeDialogComponent };
+export declare class RtWelcomeDialogComponent {
+  #private;
+  protected readonly t: Signal<TRtKitLabelMap>;
+  protected readonly title: string;
+  protected readonly paragraphs: string[];
+  /** Своя подпись важнее умолчания: роль знает, куда ведёт кнопка */
+  protected readonly ctaLabel: Signal<string>;
+  constructor();
+  protected onClose(): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<RtWelcomeDialogComponent, never>;
+  static ɵcmp: i0.ɵɵComponentDeclaration<RtWelcomeDialogComponent, "rt-welcome-dialog", never, {}, {}, never, never, true, never>;
+}