@yuuvis/client-framework 2.14.0 → 2.16.0

package/split-view/lib/split-view.component.d.ts

@@ -1,27 +1,54 @@
 import { AfterViewInit } from '@angular/core';
-import { SplitComponent, SplitDirection } from 'angular-split';
+import { SplitAreaSize, SplitComponent, SplitDirection } from 'angular-split';
 import { SplitAreaDirective } from './split-area.directive';
 import { SplitViewLayoutSettings, SplitViewOutputData } from './split-view.interface';
 import * as i0 from "@angular/core";
 /**
  * Component for creating a split view with resizable areas.
  *
+ * Each area is defined using the `yuvSplitArea` directive on an `ng-template`.
+ * Areas can be resized by dragging the gutter between them.
+ *
+ * ### Basic usage
+ * ```html
+ * <yuv-split-view>
+ *   <ng-template yuvSplitArea [size]="20">Aside</ng-template>
+ *   <ng-template yuvSplitArea [size]="80">Main</ng-template>
+ * </yuv-split-view>
+ * ```
+ *
+ * ### Collapsible areas
+ * Areas can be shown, hidden, or toggled programmatically. Use a template
+ * reference variable to call the visibility methods from the template:
+ *
  * ```html
- *   <yuv-split-view>
- *     <ng-template yuvSplitArea [size]="20">Aside area</ng-template>
- *     <ng-template yuvSplitArea [size]="80">Main area</ng-template>
- *   </yuv-split-view>
+ * <yuv-split-view #sv>
+ *   <ng-template yuvSplitArea [size]="25">
+ *     <button (click)="sv.hideArea(0)">Collapse</button>
+ *     Left pane
+ *   </ng-template>
+ *   <ng-template yuvSplitArea [size]="75">
+ *     <button (click)="sv.showArea(0)">Expand left</button>
+ *     Main pane
+ *   </ng-template>
+ * </yuv-split-view>
  * ```
- * If you set a `layoutSettingsID` it will be used to store the state of
- * the split view (area sizes and visibility) in localStorage everytime it
- * changes. The component will then also load and apply that state once the
- * component is loaded.
  *
+ * ### Persisting layout state
+ * Set `layoutSettingsID` to persist area sizes and visibility to
+ * localStorage. The saved state is automatically restored on init.
+ *
+ * ```html
+ * <yuv-split-view [layoutSettingsID]="'my-layout'">
+ *   ...
+ * </yuv-split-view>
+ * ```
  */
 export declare class SplitViewComponent implements AfterViewInit {
     #private;
     splitAreas: import("@angular/core").Signal<readonly SplitAreaDirective[]>;
     asSplitComponent: import("@angular/core").Signal<SplitComponent>;
+    splitAreaSizes: SplitAreaSize[];
     /**
      * The split views direction. Could be 'horizontal' or 'vertical'. Defaults to 'horizontal'.
      */
@@ -32,6 +59,9 @@ export declare class SplitViewComponent implements AfterViewInit {
      * Size of the gutter in Pixel (defaults to 16).
      */
     gutterSize: import("@angular/core").InputSignal<number>;
+    /**
+     * If true, the gutter can only be moved in steps of 1%.
+     */
     restrictMove: import("@angular/core").InputSignal<boolean>;
     /**
      * Disable the dragging feature (remove cursor/image on gutters).
@@ -70,6 +100,58 @@ export declare class SplitViewComponent implements AfterViewInit {
     dragging: import("@angular/core").WritableSignal<boolean>;
     onDragStart(e: SplitViewOutputData): void;
     onDragEnd(e: SplitViewOutputData): void;
+    /**
+     * Show a previously hidden split area, restoring it to its last known size.
+     *
+     * ```html
+     * <button (click)="sv.showArea(0)">Show left pane</button>
+     * ```
+     * @param index Zero-based index of the split area to show
+     */
+    showArea(index: number): void;
+    /**
+     * Hide a split area by collapsing it to zero width/height. The adjacent
+     * areas will expand to fill the freed space.
+     *
+     * ```html
+     * <button (click)="sv.hideArea(0)">Hide left pane</button>
+     * ```
+     * @param index Zero-based index of the split area to hide
+     */
+    hideArea(index: number): void;
+    /**
+     * Toggle the visibility of a split area. If the area is currently visible
+     * it will be collapsed; if it is hidden it will be restored.
+     *
+     * ```html
+     * <button (click)="sv.toggleArea(0)">Toggle left pane</button>
+     * ```
+     * @param index Zero-based index of the split area to toggle
+     */
+    toggleArea(index: number): void;
+    /**
+     * Returns whether a split area is currently visible. Useful for
+     * conditionally rendering expand/collapse buttons in the template.
+     *
+     * ```html
+     * @if (!sv.isAreaVisible(0)) {
+     *   <button (click)="sv.showArea(0)">Expand left</button>
+     * }
+     * ```
+     * @param index Zero-based index of the split area to check
+     * @returns `true` if the area is visible, `false` if hidden
+     */
+    isAreaVisible(index: number): boolean;
+    /** @deprecated Use `showArea()` / `hideArea()` instead */
+    splitAreaSetVisibility(index: number, visible: boolean): void;
+    /** @deprecated Use `toggleArea()` instead */
+    splitAreaToggleVisibility(index: number): void;
+    /**
+     * Programmatically apply layout settings (area sizes, visibility, disabled state).
+     * This is called automatically on init when `layoutSettingsID` is set, but can
+     * also be used to restore a specific layout configuration at any time.
+     * @param settings The layout settings to apply
+     */
     applyLayoutSettings(settings: SplitViewLayoutSettings): void;
     ngAfterViewInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SplitViewComponent, never>;

package/widget-grid/lib/widget-grid-workspaces/widget-grid-workspaces.interface.d.ts

@@ -10,7 +10,7 @@ export interface WidgetGridWorkspace {
 }
 export interface WidgetGridWorkspaceConfig {
     currentWorkspace?: string;
-    workspaces: Array<WidgetGridWorkspace>;
+    workspaces: WidgetGridWorkspace[];
 }
 export interface WidgetGridWorkspaceOptions {
     gridConfig?: Partial<WidgetGridConfig>;

package/widget-grid/lib/widget-grid.component.d.ts

@@ -7,7 +7,7 @@ export declare class YuvWidgetGridComponent {
     gridsterItems: import("@angular/core").Signal<GridsterItemComponent>;
     widgetPicker: import("@angular/core").Signal<TemplateRef<any>>;
     options: GridsterConfig;
-    gridConfig: import("@angular/core").InputSignal<WidgetGridConfig | undefined>;
+    gridConfig: import("@angular/core").InputSignal<Partial<WidgetGridConfig> | undefined>;
     _editMode: import("@angular/core").WritableSignal<boolean>;
     /**
      * Whether or not to enable edit mode. In edit mode controls

package/widget-grid/lib/widget-grid.interface.d.ts

@@ -1,6 +1,6 @@
 import { InputSignal, OutputEmitterRef, Type } from '@angular/core';
 import { FormControlStatus } from '@angular/forms';
-import { GridsterItem } from 'angular-gridster2';
+import { GridsterItem, GridType } from 'angular-gridster2';
 import { AttributesMap } from 'ng-dynamic-component';
 export interface GridWidget<T> {
     id: string;
@@ -43,6 +43,7 @@ export interface WidgetGridConfig {
     gap?: number;
     newItemWidth?: number;
     newItemHeight?: number;
+    gridType: GridType;
 }
 export interface WidgetPickerOptions {
     pickerData?: WidgetPickerData;