@ruc-lib/widget 3.2.0 → 4.0.0

package/interface/widget.d.ts

@@ -1,92 +0,0 @@
-import { Type } from "@angular/core";
-/**
- * Defines the input properties for the main `ruclib-widget` component.
- */
-export interface WidgetConfig {
-    /**
-     * The theme color to be applied to interactive elements like icons.
-     * @example 'primary', 'accent', 'warn'
-     * @optional
-     */
-    color?: string;
-    /**
-     * An array of configuration objects, each defining a single widget.
-     * @optional
-     */
-    widgetData?: WidgetConfigData[];
-}
-/**
- * Defines the configuration for a single widget within the container.
- */
-export interface WidgetConfigData {
-    /** A unique identifier for the widget. */
-    id: string;
-    /**
-     * The title to be displayed in the widget's header.
-     * @optional
-     */
-    title?: string;
-    /**
-     * The description or main text content, used when `contentType` is 'text'.
-     * @optional
-     */
-    description?: string;
-    /**
-     * If true, a close icon is displayed in the header to allow the user to remove the widget.
-     * @optional
-     */
-    showCloseIcon?: boolean;
-    /**
-     * If true, the widget is visually faded and cannot be interacted with (dragged, resized, etc.).
-     * @optional
-     */
-    disabled?: boolean;
-    /**
-     * The CSS width of the widget.
-     * @example '300px', '50%', '33vw'
-     * @optional
-     */
-    width?: string;
-    /**
-     * The CSS height of the widget.
-     * @example '200px', 'auto', '50vh'
-     * @optional
-     */
-    height?: string;
-    /**
-     * If true, the widget can be dragged around the container.
-     * @optional
-     */
-    draggable?: boolean;
-    /**
-     * If true, the widget can be resized by the user (requires a resizing library implementation).
-     * @optional
-     */
-    resizable?: boolean;
-    /**
-     * The type of content the widget will display.
-     * @optional
-     */
-    contentType?: 'text' | 'html' | 'component' | 'chart' | 'video' | 'audio';
-    /**
-     * The data for the content. The structure depends on the `contentType`.
-     * For 'component', it should be an object: `{ component: YourComponent, inputs: { ... } }`.
-     * @optional
-     */
-    contentData?: any | {
-        component: Type<any>;
-        inputs?: {
-            [key: string]: any;
-        };
-    };
-    /** The CSS `top` position for absolute positioning. @example '20px', '5%' @optional */
-    top?: string;
-    /** The CSS `left` position for absolute positioning. @example '20px', '5%' @optional */
-    left?: string;
-    /** The name of a Material icon to display in the header. @optional */
-    headerIcon?: string;
-    /** Internal state flag to indicate if the widget is being actively dragged or resized. @optional */
-    isActive?: boolean;
-    /** The CSS `background-color` for the widget. @example '#ffffff', 'rgba(0,0,0,0.1)' @optional */
-    backgroundColor?: string;
-}

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

@@ -1,77 +0,0 @@
-import { EventEmitter, ElementRef, AfterViewInit, ChangeDetectorRef } from '@angular/core';
-import { WidgetConfig, WidgetConfigData } from '../../interface/widget';
-import { CdkDragStart, CdkDragEnd } from '@angular/cdk/drag-drop';
-import * as i0 from "@angular/core";
-/**
- * A component that renders a collection of draggable and configurable widgets within a host container.
- * It manages the layout, interaction, and dynamic content of each widget.
- */
-export declare class RuclibWidgetComponent implements AfterViewInit {
-    private cdr;
-    /**
-     * The main configuration object for the widget container.
-     * It includes the array of widget data and global settings.
-     * @see WidgetConfig interface for detailed properties.
-     */
-    rucInputData: WidgetConfig;
-    /**
-     * An optional custom theme class to be applied to the widget host container.
-     * @example 'dark-theme', 'custom-theme-one'
-     */
-    customTheme: string | undefined;
-    /**
-     * An event emitter that fires when a widget's close icon is clicked.
-     * It emits the unique ID of the widget to be closed.
-     */
-    widgetClose: EventEmitter<string>;
-    /**
-     * An event emitter that fires when a widget is dragged and dropped.
-     * It emits the entire updated array of widget configurations, allowing the parent to save the new layout.
-     */
-    layoutChanged: EventEmitter<WidgetConfigData[]>;
-    /**
-     * @param cdr The ChangeDetectorRef to manually trigger change detection when needed.
-     */
-    constructor(cdr: ChangeDetectorRef);
-    /** A reference to the host container element, used to define the drag boundary. */
-    widgetsHostContainerRef: ElementRef<HTMLElement>;
-    /** The HTML element that serves as the boundary for all drag operations. */
-    dragBoundaryElement: HTMLElement;
-    /**
-     * After the view initializes, this hook captures the host container's native element
-     * and sets it as the boundary for dragging widgets.
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Handles the click event on a widget's close button.
-     * @param widgetId The ID of the widget to be closed.
-     */
-    onCloseClick(widgetId: string): void;
-    /**
-     * Handles the start of a drag operation for a widget.
-     * Sets the widget's isActive state to true for visual feedback.
-     * @param widget The WidgetConfigData object being dragged.
-     * @param event The CdkDragStart event.
-     */
-    onDragStarted(widget: WidgetConfigData, event: CdkDragStart): void;
-    /**
-     * Handles the end of a drag operation.
-     * It calculates the new top/left position, updates the widget's configuration,
-     * and emits the `layoutChanged` event with the new layout data.
-     * @param widget The WidgetConfigData object that was dragged.
-     * @param event The CdkDragEnd event.
-     */
-    onDragEnded(widget: WidgetConfigData, event: CdkDragEnd): void;
-    /**
-     * Retrieves the color for UI elements like icons from the input data.
-     * @returns The color string (e.g., 'primary', 'accent') or 'primary' as a default.
-     */
-    getColor(): string;
-    /**
-     * A safe getter for the widget data array from the main input configuration.
-     * @returns The array of widget configurations, or an empty array if not defined.
-     */
-    getWidgetData(): WidgetConfigData[] | any;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RuclibWidgetComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<RuclibWidgetComponent, "uxp-ruclib-widget", never, { "rucInputData": "rucInputData"; "customTheme": "customTheme"; }, { "widgetClose": "widgetClose"; "layoutChanged": "layoutChanged"; }, never, never, false, never>;
-}

package/lib/ruclib-widget-item/ruclib-widget-item.component.d.ts

@@ -1,60 +0,0 @@
-import { ViewContainerRef, OnChanges, SimpleChanges, OnDestroy, ChangeDetectorRef, AfterViewInit } from '@angular/core';
-import { DomSanitizer } from '@angular/platform-browser';
-import { WidgetConfigData } from '../../interface/widget';
-import * as i0 from "@angular/core";
-/**
- * Represents a single item within a widget.
- * This component is responsible for rendering the content of a widget, which can be
- * simple text, HTML, a video, or a dynamically loaded Angular component.
- */
-export declare class RuclibWidgetItemComponent implements OnChanges, OnDestroy, AfterViewInit {
-    private cdr;
-    private sanitizer;
-    /**
-     * The configuration object for this specific widget item.
-     * It determines the type of content to render and provides the necessary data.
-     */
-    widgetConfig: WidgetConfigData;
-    /**
-     * A reference to the view container where a dynamic component will be injected.
-     * This is used when `widgetConfig.contentType` is 'component'.
-     */
-    widgetComponentHost: ViewContainerRef;
-    /**
-     * A reference to the dynamically created component instance.
-     * This is used to manage the lifecycle of the injected component.
-     */
-    private dynamicComponentRef;
-    /**
-     * @param cdr The ChangeDetectorRef to manually trigger change detection.
-     * @param sanitizer The DomSanitizer service to prevent XSS attacks by sanitizing HTML.
-     */
-    constructor(cdr: ChangeDetectorRef, sanitizer: DomSanitizer);
-    /**
-     * A lifecycle hook that responds when Angular sets or resets data-bound input properties.
-     * It checks for changes in `widgetConfig` and reloads the content accordingly.
-     * @param changes An object of the changed properties.
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * A lifecycle hook that is called after Angular has fully initialized a component's view.
-     * It ensures that if the initial content type is 'component', it gets loaded.
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Loads a dynamic component into the `widgetComponentHost` view container.
-     * It reads the component type and any input data from the `widgetConfig`.
-     */
-    private loadDynamicContent;
-    /**
-     * Clears any dynamically loaded component from the view container and destroys its instance.
-     */
-    private clearDynamicContent;
-    /**
-     * A lifecycle hook that cleans up the component before it's destroyed.
-     * Ensures that any dynamically created components are properly destroyed to avoid memory leaks.
-     */
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RuclibWidgetItemComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<RuclibWidgetItemComponent, "uxp-ruclib-widget-item", never, { "widgetConfig": "widgetConfig"; }, {}, never, never, false, never>;
-}

package/lib/ruclib-widget.module.d.ts

@@ -1,13 +0,0 @@
-import * as i0 from "@angular/core";
-import * as i1 from "./ruclib-widget/ruclib-widget.component";
-import * as i2 from "../pipes/safe-html.pipe";
-import * as i3 from "./ruclib-widget-item/ruclib-widget-item.component";
-import * as i4 from "@angular/common";
-import * as i5 from "@angular/material/icon";
-import * as i6 from "@angular/material/button";
-import * as i7 from "@angular/cdk/drag-drop";
-export declare class RuclibWidgetModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<RuclibWidgetModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<RuclibWidgetModule, [typeof i1.RuclibWidgetComponent, typeof i2.SafeHtmlPipe, typeof i3.RuclibWidgetItemComponent], [typeof i4.CommonModule, typeof i5.MatIconModule, typeof i6.MatButtonModule, typeof i7.DragDropModule], [typeof i1.RuclibWidgetComponent]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<RuclibWidgetModule>;
-}

package/model/default-values.d.ts

@@ -1,2 +0,0 @@
-import { WidgetConfig } from "../interface/widget";
-export declare const defaultValues: WidgetConfig;

package/pipes/safe-html.pipe.d.ts

@@ -1,24 +0,0 @@
-import { PipeTransform } from '@angular/core';
-import { DomSanitizer } from '@angular/platform-browser';
-import * as i0 from "@angular/core";
-/**
- * @Pipe SafeHtmlPipe
- * @name safeHtml
- * @description A pipe that bypasses Angular's built-in security and sanitizes HTML content,
- * allowing it to be safely rendered in the DOM. Use with caution and only with trusted HTML sources.
- */
-export declare class SafeHtmlPipe implements PipeTransform {
-    private sanitizer;
-    /**
-     * @param sanitizer - An instance of DomSanitizer used to bypass security.
-     */
-    constructor(sanitizer: DomSanitizer);
-    /**
-     * Transforms a string containing HTML into a SafeHtml object that can be bound to [innerHTML].
-     * @param value - The HTML string to sanitize.
-     * @returns A SafeHtml object, which Angular trusts as safe HTML.
-     */
-    transform(value: any): any;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SafeHtmlPipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<SafeHtmlPipe, "safeHtml", false>;
-}