@cute-widgets/base 20.0.1

package/expansion/index.d.ts

@@ -0,0 +1,308 @@
+import * as i0 from '@angular/core';
+import { TemplateRef, AfterContentInit, OnChanges, OnDestroy, EventEmitter, SimpleChanges, ElementRef, InjectionToken, AfterViewInit, QueryList } from '@angular/core';
+import { CdkAccordion, CdkAccordionItem } from '@angular/cdk/accordion';
+import { FocusableOption, FocusOrigin } from '@angular/cdk/a11y';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { TemplatePortal } from '@angular/cdk/portal';
+import { Subject } from 'rxjs';
+import { Expandable } from '@cute-widgets/base/abstract';
+import * as i1 from '@angular/common';
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/** CuteAccordion's display modes. */
+type CuteAccordionDisplayMode = 'default' | 'flush';
+/** CuteAccordion's toggle positions. */
+type CuteAccordionTogglePosition = 'before' | 'after';
+/**
+ * Base interface for a `CuteAccordion`.
+ * @docs-private
+ */
+interface CuteAccordionBase extends CdkAccordion {
+    /** Whether the expansion indicator should be hidden. */
+    hideToggle: boolean;
+    /** Display mode used for all expansion panels in the accordion. */
+    displayMode: CuteAccordionDisplayMode;
+    /** The position of the expansion indicator. */
+    togglePosition: CuteAccordionTogglePosition;
+    /** Handles keyboard events coming in from the panel headers. */
+    _handleHeaderKeydown: (event: KeyboardEvent) => void;
+    /** Handles focus events on the panel headers. */
+    _handleHeaderFocus: (header: any) => void;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/**
+ * Base interface for a `CuteExpansionPanel`.
+ */
+interface CuteExpansionPanelBase extends CdkAccordionItem {
+    /** Whether the toggle indicator should be hidden. */
+    hideToggle: boolean;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/**
+ * Expansion panel content that will be rendered lazily
+ * after the panel is opened for the first time.
+ */
+declare class CuteExpansionPanelContent {
+    _template: TemplateRef<any>;
+    _expansionPanel: CuteExpansionPanelBase | null;
+    constructor(...args: unknown[]);
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionPanelContent, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteExpansionPanelContent, "ng-template[cuteExpansionPanelContent]", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+/** CuteExpansionPanel's states. */
+type CuteExpansionPanelState = 'expanded' | 'collapsed';
+/**
+ * Object that can be used to override the default options
+ * for all the expansion panels in a module.
+ */
+interface CuteExpansionPanelDefaultOptions {
+    /** Height of the header while the panel is expanded. */
+    expandedHeight: string;
+    /** Height of the header while the panel is collapsed. */
+    collapsedHeight: string;
+    /** Whether the toggle indicator should be hidden. */
+    hideToggle: boolean;
+}
+/**
+ * Injection token that can be used to configure the default
+ * options for the expansion panel component.
+ */
+declare const CUTE_EXPANSION_PANEL_DEFAULT_OPTIONS: InjectionToken<CuteExpansionPanelDefaultOptions>;
+/**
+ * This component can be used as a single element to show expandable content, or as one of
+ * multiple children of an element with the CuteAccordion directive attached.
+ */
+declare class CuteExpansionPanel extends CdkAccordionItem implements CuteExpansionPanelBase, Expandable, AfterContentInit, OnChanges, OnDestroy {
+    private _viewContainerRef;
+    private readonly _animationsDisabled;
+    private _document;
+    private _ngZone;
+    private _elementRef;
+    private _renderer;
+    private _cleanupTransitionEnd;
+    /** Whether the toggle indicator should be hidden. */
+    get hideToggle(): boolean;
+    set hideToggle(value: BooleanInput);
+    private _hideToggle;
+    /** The position of the expansion indicator. */
+    get togglePosition(): CuteAccordionTogglePosition;
+    set togglePosition(value: CuteAccordionTogglePosition);
+    private _togglePosition;
+    /** An event emitted after the body's expansion animation happens. */
+    readonly afterExpand: EventEmitter<void>;
+    /** An event emitted after the body's collapse animation happens. */
+    readonly afterCollapse: EventEmitter<void>;
+    /** Stream that emits for changes in `@Input` properties. */
+    readonly _inputChanges: Subject<SimpleChanges>;
+    /** Optionally defined accordion the expansion panel belongs to. */
+    readonly accordion: CuteAccordionBase;
+    /** Content that will be rendered lazily. */
+    _lazyContent: CuteExpansionPanelContent | undefined;
+    /** Element containing the panel's user-provided content. */
+    _body: ElementRef<HTMLElement> | undefined;
+    /** Element wrapping the panel body. */
+    protected _bodyWrapper: ElementRef<HTMLElement> | undefined;
+    /** Portal holding the user's content. */
+    protected _portal: TemplatePortal | null;
+    /** ID for the associated header element. Used for a11y labelling. */
+    _headerId: string;
+    _contentId: string;
+    constructor(...args: unknown[]);
+    /** Determines whether the expansion panel should have spacing between it and its siblings. */
+    _hasSpacing(): boolean;
+    /** Gets the expanded state string. */
+    _getExpandedState(): CuteExpansionPanelState;
+    /** Toggles the expanded state of the expansion panel. */
+    toggle(): void;
+    /** Sets the expanded state of the expansion panel to false. */
+    close(): void;
+    /** Sets the expanded state of the expansion panel to true. */
+    open(): void;
+    ngAfterContentInit(): void;
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    /** Checks whether the expansion panel's content contains the currently focused element. */
+    _containsFocus(): boolean;
+    private _transitionEndListener;
+    protected _setupAnimationEvents(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionPanel, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CuteExpansionPanel, "cute-expansion-panel", ["cuteExpansionPanel"], { "hideToggle": { "alias": "hideToggle"; "required": false; }; "togglePosition": { "alias": "togglePosition"; "required": false; }; }, { "afterExpand": "afterExpand"; "afterCollapse": "afterCollapse"; }, ["_lazyContent"], ["cute-expansion-panel-header", "*", "cute-action-row"], true, never>;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+declare class CuteExpansionPanelHeader implements AfterViewInit, OnDestroy, FocusableOption {
+    readonly panel: CuteExpansionPanel;
+    private _element;
+    private _focusMonitor;
+    private _changeDetectorRef;
+    private _parentChangeSubscription;
+    constructor(...args: unknown[]);
+    /** Height of the header while the panel is expanded. */
+    expandedHeight: string | undefined;
+    /** Height of the header while the panel is collapsed. */
+    collapsedHeight: string | undefined;
+    /** Tab index of the header. */
+    tabIndex: number;
+    /** Whether the associated panel is disabled. Implemented as a part of `FocusableOption`. */
+    get disabled(): boolean;
+    /** Toggles the expanded state of the panel. */
+    protected _toggle(): void;
+    /** Gets whether the panel is expanded. */
+    protected _isExpanded(): boolean;
+    /** Gets the expanded state string of the panel. */
+    protected _getExpandedState(): string;
+    /** Gets the panel id. */
+    protected _getPanelId(): string;
+    /** Gets the toggle position for the header. */
+    protected _getTogglePosition(): CuteAccordionTogglePosition;
+    /** Gets whether the expanded indicator should be shown. */
+    protected _showToggle(): boolean;
+    /**
+     * Gets the current height of the header. Null if no custom height has been
+     * specified, and if the default height from the stylesheet should be used.
+     */
+    protected _getHeaderHeight(): string | null;
+    /** Handle keydown event calling to toggle() if appropriate. */
+    protected _keydown(event: KeyboardEvent): void;
+    /**
+     * Focuses the panel header. Implemented as a part of `FocusableOption`.
+     * @param origin Origin of the action that triggered the focus.
+     * @param options FocusOptions
+     */
+    focus(origin?: FocusOrigin, options?: FocusOptions): void;
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionPanelHeader, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CuteExpansionPanelHeader, "cute-expansion-panel-header", ["cuteExpansionPanelHeader"], { "tabIndex": { "alias": "tabIndex"; "required": false; }; "expandedHeight": { "alias": "expandedHeight"; "required": false; }; "collapsedHeight": { "alias": "collapsedHeight"; "required": false; }; }, {}, never, ["cute-panel-title", "cute-panel-description", "*"], true, never>;
+    static ngAcceptInputType_tabIndex: unknown;
+}
+/**
+ * Description element of a `<cute-expansion-panel-header>`.
+ */
+declare class CuteExpansionPanelDescription {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionPanelDescription, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteExpansionPanelDescription, "cute-panel-description", never, {}, {}, never, never, true, never>;
+}
+/**
+ * Title element of a `<cute-expansion-panel-header>`.
+ */
+declare class CuteExpansionPanelTitle {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionPanelTitle, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteExpansionPanelTitle, "cute-panel-title", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * @license Apache-2.0
+ *
+ * Copyright (c) 2025 CuteWidgets Team. All Rights Reserved.
+ *
+ * You may not use this file except in compliance with the License
+ * that can be found at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This code is a modification of the `@angular/material` original
+ * code licensed under MIT-style License (https://angular.dev/license).
+ */
+
+declare class CuteAccordion extends CdkAccordion implements CuteAccordionBase, AfterContentInit, OnDestroy {
+    private _keyManager;
+    /** Headers belonging to this accordion. */
+    private _ownHeaders;
+    /** All headers inside the accordion. Includes headers inside nested accordions. */
+    _headers: QueryList<CuteExpansionPanelHeader> | undefined;
+    /** Whether the expansion indicator should be hidden. */
+    hideToggle: boolean;
+    /**
+     * Display mode used for all expansion panels in the accordion. Currently two display
+     * modes exist:
+     *  default - a gutter-like spacing is placed around any expanded panel, placing the expanded
+     *     panel at a different elevation from the rest of the accordion.
+     *  flush - removes some borders and rounded corners to render expansion panels edge-to-edge with their parent container.
+     */
+    displayMode: CuteAccordionDisplayMode;
+    /** The position of the expansion indicator. */
+    togglePosition: CuteAccordionTogglePosition;
+    ngAfterContentInit(): void;
+    /** Handles keyboard events coming in from the panel headers. */
+    _handleHeaderKeydown(event: KeyboardEvent): void;
+    _handleHeaderFocus(header: CuteExpansionPanelHeader): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteAccordion, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteAccordion, "cute-accordion", ["cuteAccordion"], { "hideToggle": { "alias": "hideToggle"; "required": false; }; "displayMode": { "alias": "displayMode"; "required": false; }; "togglePosition": { "alias": "togglePosition"; "required": false; }; }, {}, ["_headers"], never, true, never>;
+    static ngAcceptInputType_hideToggle: unknown;
+}
+
+/**
+ * Actions of a `<cute-expansion-panel>`.
+ */
+declare class CuteExpansionPanelActionRow {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionPanelActionRow, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CuteExpansionPanelActionRow, "cute-action-row", never, {}, {}, never, never, true, never>;
+}
+
+declare class CuteExpansionModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<CuteExpansionModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CuteExpansionModule, never, [typeof i1.CommonModule, typeof CuteAccordion, typeof CuteExpansionPanel, typeof CuteExpansionPanelContent, typeof CuteExpansionPanelHeader, typeof CuteExpansionPanelActionRow, typeof CuteExpansionPanelTitle, typeof CuteExpansionPanelDescription], [typeof CuteAccordion, typeof CuteExpansionPanel, typeof CuteExpansionPanelContent, typeof CuteExpansionPanelHeader, typeof CuteExpansionPanelActionRow, typeof CuteExpansionPanelTitle, typeof CuteExpansionPanelDescription]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<CuteExpansionModule>;
+}
+
+export { CUTE_EXPANSION_PANEL_DEFAULT_OPTIONS, CuteAccordion, CuteExpansionModule, CuteExpansionPanel, CuteExpansionPanelActionRow, CuteExpansionPanelContent, CuteExpansionPanelDescription, CuteExpansionPanelHeader, CuteExpansionPanelTitle };
+export type { CuteExpansionPanelDefaultOptions, CuteExpansionPanelState };