@breadstone/mosaik-elements-foundation 0.0.135 → 0.0.137

package/Controls/Components/Grouping/BannerGroup/BannerGroupElement.d.ts

@@ -0,0 +1,228 @@
+import { type ISlottable } from '../../../Behaviors/Slottable';
+import { CustomElement } from '../../Abstracts/CustomElement';
+import type { IBannerGroupElementProps } from './IBannerGroupElementProps';
+import { type IEventEmitter, type IEventDetail } from '@breadstone/mosaik-elements';
+import { BannerGroupDismissBehavior } from '../../../Types/BannerGroupDismissBehavior';
+import { BannerGroupStacking } from '../../../Types/BannerGroupStacking';
+/** Change event detail for {@link BannerGroupElement}. */
+export interface IBannerGroupChangeEventDetail extends IEventDetail {
+    index: number;
+    previousIndex: number;
+    length: number;
+}
+declare const BannerGroupElement_base: (abstract new (...args: Array<any>) => import("../../../Behaviors/Themeable").IThemeableProps) & (abstract new (...args: Array<any>) => import("../../../Behaviors/Orientable").IOrientableProps) & (abstract new (...args: Array<any>) => import("../../../Behaviors/Disableable").IDisableableProps) & (abstract new (...args: Array<any>) => import("../../../Behaviors/Appearanceable").IAppearanceableProps) & (abstract new (...args: Array<any>) => import("../../../Behaviors/Variantable").IVariantableProps) & (abstract new (...args: Array<any>) => import("../../../Behaviors/Slottable").ISlottableProps & ISlottable) & typeof CustomElement & import("../../../Behaviors/Themeable").IThemeableCtor;
+/**
+ * BannerGroup - A container component for managing and presenting multiple `Banner` instances.
+ *
+ * @description
+ * The `BannerGroup` component arranges several `<mosaik-banner>` elements either as a stack or a simple paged
+ * (carousel‑like) sequence. When `maxLength` equals `1`, only a single banner is shown and keyboard navigation
+ * allows users to move between items. When `maxLength` is greater than `1`, banners are presented in a stacked
+ * layout. Looping navigation can be enabled via the `loop` property. (Persistence, dismissal strategies and depth
+ * stacking enhancements can be incorporated in future iterations.)
+ *
+ * @name BannerGroup
+ * @element mosaik-banner-group
+ * @category Notifications
+ *
+ * @fires change - Fired when the active index changes.
+ *
+ * @slot - The default slot for banner items.
+ * @slot prev - Slot for a custom previous control.
+ * @slot next - Slot for a custom next control.
+ *
+ * @csspart root - The root wrapper part.
+ * @csspart viewport - The viewport that contains the banners.
+ * @csspart control-prev - The previous control wrapper.
+ * @csspart control-next - The next control wrapper.
+ *
+ * @cssprop {unknown} --banner-group-gap - Gap between stacked banners.
+ * @cssprop {unknown} --banner-group-transition-duration - Transition duration for paging.
+ *
+ * @dependency {BannerElement} - The Banner element.
+ *
+ * @example
+ * ```html
+ * <mosaik-banner-group max-visible="1" loop>
+ *   <mosaik-banner header="Update 1"></mosaik-banner>
+ *   <mosaik-banner header="Update 2"></mosaik-banner>
+ *   <mosaik-banner header="Update 3"></mosaik-banner>
+ * </mosaik-banner-group>
+ * ```
+ *
+ * @public
+ */
+export declare class BannerGroupElement extends BannerGroupElement_base implements IBannerGroupElementProps, ISlottable {
+    private readonly _change;
+    private readonly _keyboardController;
+    private _eventSubscriptions;
+    private _index;
+    private _loop;
+    private _maxLength;
+    private _dismissBehavior;
+    private _stacking;
+    private _reverse;
+    private _previousIndex;
+    /**
+     * @public
+     */
+    constructor();
+    /**
+     * Returns the `{@link is}` property.
+     * The `{@link is}` property represents the natural name of this element.
+     *
+     * @public
+     * @static
+     * @readonly
+     */
+    static get is(): string;
+    /**
+     * Gets or sets the `index` property representing the current active (start) index.
+     *
+     * @public
+     * @attr
+     */
+    get index(): number;
+    set index(value: number);
+    /**
+     * Gets or sets the `loop` property enabling circular navigation.
+     *
+     * @public
+     * @attr
+     */
+    get loop(): boolean;
+    set loop(value: boolean);
+    /**
+     * Gets or sets the `maxLength` property (1 = pager/carousel mode).
+     *
+     * @public
+     * @attr
+     */
+    get maxLength(): number;
+    set maxLength(value: number);
+    /**
+     * Gets or sets the `dismissBehavior` property defining how dismissed banners are handled.
+     * (Future extension point.)
+     *
+     * @public
+     * @attr
+     */
+    get dismissBehavior(): BannerGroupDismissBehavior;
+    set dismissBehavior(value: BannerGroupDismissBehavior);
+    /**
+     * Gets or sets the `stacking` property controlling vertical or depth stacking.
+     *
+     * @public
+     * @attr
+     */
+    get stacking(): BannerGroupStacking;
+    set stacking(value: BannerGroupStacking);
+    /**
+     * Gets or sets the `reverse` property displaying newest banners first when true.
+     *
+     * @public
+     * @attr
+     */
+    get reverse(): boolean;
+    set reverse(value: boolean);
+    /**
+     * Returns the total number of banners.
+     *
+     * @public
+     * @readonly
+     */
+    get length(): number;
+    /**
+     * Returns whether previous navigation is possible.
+     *
+     * @public
+     * @readonly
+     */
+    get canPrev(): boolean;
+    /**
+     * Returns whether next navigation is possible.
+     *
+     * @public
+     * @readonly
+     */
+    get canNext(): boolean;
+    /**
+     * Fired when the active index changes.
+     *
+     * @public
+     */
+    get change(): IEventEmitter<IBannerGroupChangeEventDetail>;
+    /**
+     * @protected
+     * @override
+     */
+    onSlotChanges(): void;
+    /**
+     * @public
+     * @override
+     */
+    connectedCallback(): void;
+    /**
+     * Navigates to the previous banner.
+     *
+     * @public
+     */
+    previous(): void;
+    /**
+     * Navigates to the next banner.
+     *
+     * @public
+     */
+    next(): void;
+    /**
+     * Navigates to the first banner.
+     *
+     * @public
+     */
+    first(): void;
+    /**
+     * Navigates to the last banner.
+     *
+     * @public
+     */
+    last(): void;
+    /**
+     * Navigates to a specific index.
+     *
+     * @public
+     */
+    goTo(i: number): void;
+    protected onIndexPropertyChanged(): void;
+    protected onMaxLengthPropertyChanged(): void;
+    protected onReversePropertyChanged(): void;
+    protected onStackingPropertyChanged(): void;
+    protected onOrientationPropertyChanged(): void;
+    protected onDirPropertyChanged(): void;
+    protected onDisabledPropertyChanged(_prev?: boolean, next?: boolean): void;
+    private navigate;
+    private emitChange;
+    private clearSubscriptions;
+    /**
+     * Updates banner visibility, ordering and (optional) depth stacking transforms.
+     *
+     * @private
+     */
+    private updateLayout;
+    /**
+     * Attaches a one‑time transition end handler to a leaving banner (pager mode) to finalize its hidden state.
+     * @private
+     */
+    private attachLeavingTransitionHandler;
+}
+/** @public */
+export declare namespace BannerGroupElement {
+    type Props = IBannerGroupElementProps;
+}
+/** @public */
+declare global {
+    interface HTMLElementTagNameMap {
+        'mosaik-banner-group': BannerGroupElement;
+    }
+}
+export {};
+//# sourceMappingURL=BannerGroupElement.d.ts.map

package/Controls/Components/Grouping/BannerGroup/BannerGroupElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BannerGroupElement.d.ts","sourceRoot":"","sources":["../../../../../src/Controls/Components/Grouping/BannerGroup/BannerGroupElement.ts"],"names":[],"mappings":"AAMA,OAAO,EAAa,KAAK,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAK1E,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAG9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAK3E,OAAO,EAA2B,KAAK,aAAa,EAAE,KAAK,YAAY,EAAmC,MAAM,6BAA6B,CAAC;AAI9I,OAAO,EAAE,0BAA0B,EAAE,MAAM,2CAA2C,CAAC;AACvF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AAKzE,0DAA0D;AAC1D,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAClB;;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAYa,kBACT,SAAQ,uBACR,YAAW,wBAAwB,EAAE,UAAU;IAI/C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+C;IACvE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAqB;IACzD,OAAO,CAAC,mBAAmB,CAAoC;IAC/D,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,cAAc,CAAS;IAK/B;;OAEG;;IAkBH;;;;;;;OAOG;IACH,WAAkB,EAAE,IAAI,MAAM,CAAkC;IAEhE;;;;;OAKG;IACH,IACW,KAAK,IAAI,MAAM,CAAwB;IAClD,IAAW,KAAK,CAAC,KAAK,EAAE,MAAM,EAU7B;IAED;;;;;OAKG;IACH,IAIW,IAAI,IAAI,OAAO,CAAuB;IACjD,IAAW,IAAI,CAAC,KAAK,EAAE,OAAO,EAK7B;IAED;;;;;OAKG;IACH,IACW,SAAS,IAAI,MAAM,CAA4B;IAC1D,IAAW,SAAS,CAAC,KAAK,EAAE,MAAM,EAKjC;IAED;;;;;;OAMG;IACH,IACW,eAAe,IAAI,0BAA0B,CAAkC;IAC1F,IAAW,eAAe,CAAC,KAAK,EAAE,0BAA0B,EAK3D;IAED;;;;;OAKG;IACH,IACW,QAAQ,IAAI,mBAAmB,CAA2B;IACrE,IAAW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,EAK7C;IAED;;;;;OAKG;IACH,IAIW,OAAO,IAAI,OAAO,CAA0B;IACvD,IAAW,OAAO,CAAC,KAAK,EAAE,OAAO,EAKhC;IAED;;;;;OAKG;IACH,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;;;;OAKG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;;;OAIG;IACH,IACW,MAAM,IAAI,aAAa,CAAC,6BAA6B,CAAC,CAEhE;IAID;;;OAGG;IACa,aAAa,IAAI,IAAI;IAOrC;;;OAGG;IACa,iBAAiB,IAAI,IAAI;IAWzC;;;;OAIG;IACI,QAAQ,IAAI,IAAI;IAIvB;;;;OAIG;IACI,IAAI,IAAI,IAAI;IAInB;;;;OAIG;IACI,KAAK,IAAI,IAAI;IAIpB;;;;OAIG;IACI,IAAI,IAAI,IAAI;IAInB;;;;OAIG;IACI,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAK5B,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAKxC,SAAS,CAAC,0BAA0B,IAAI,IAAI;IAK5C,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAK1C,SAAS,CAAC,yBAAyB,IAAI,IAAI;IAK3C,SAAS,CAAC,4BAA4B,IAAI,IAAI;IAmB9C,SAAS,CAAC,oBAAoB,IAAI,IAAI;IAMtC,SAAS,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI;IAO1E,OAAO,CAAC,QAAQ;IAchB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,kBAAkB;IAK1B;;;;OAIG;IACH,OAAO,CAAC,YAAY;IA2EpB;;;OAGG;IACH,OAAO,CAAC,8BAA8B;CAgBzC;AAED,cAAc;AACd,yBAAiB,kBAAkB,CAAC;IAAE,KAAY,KAAK,GAAG,wBAAwB,CAAC;CAAE;AAErF,cAAc;AACd,OAAO,CAAC,MAAM,CAAC;IAAE,UAAU,qBAAqB;QAAG,qBAAqB,EAAE,kBAAkB,CAAA;KAAE;CAAE"}