@spicainternational/ngx-sds-components 5.12.2 → 5.13.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spicainternational/ngx-sds-components",
-  "version": "5.12.2",
+  "version": "5.13.0-beta.0",
   "description": "Spica design system angular components.",
   "peerDependencies": {
     "@angular/common": ">=13.3.0",

package/src/lib/side-bar/side-bar.component.d.ts

@@ -1,17 +1,75 @@
-import { OnInit } from '@angular/core';
-import { IconDefinition } from '@fortawesome/pro-regular-svg-icons';
+import { OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
+import { IconDefinition } from '@fortawesome/pro-solid-svg-icons';
 import * as i0 from "@angular/core";
-export declare class SdsSideBarComponent implements OnInit {
+export declare class SdsSideBarComponent implements OnInit, OnChanges, OnDestroy {
+    /**
+     * Define when the hide panel button is shown.
+     * Default is 'auto' which will only show the button when the users hovers over the panel.
+     * 'always' will always show the button.
+     *
+     * @type {('always' | 'auto')}
+     * @memberof SdsSideBarComponent
+     */
+    showCloseButton: 'always' | 'auto';
+    /**
+     * Pull out mode will show the side bar as user hovers over the left side of the screen
+     * When side bar is in pull out mode it will be rendered over the main contents.
+     *
+     * @type {boolean}
+     * @memberof SdsSideBarComponent
+     */
+    enablePullOutMode: boolean;
+    /**
+     * Define the width of the side bar in rem.
+     *
+     * @type {number}
+     * @memberof SdsSideBarComponent
+     */
+    widthRem: number;
+    /**
+     * Product name defines the color scheme of the side bar.
+     * Default is 'all-hours'.
+     * Options: 'all-hours', 'door-cloud', 'my-hours', 'time-and-space'
+     *
+     * @type {string}
+     * @memberof SdsSideBarComponent
+     */
+    product: 'all-hours' | 'door-cloud' | 'my-hours' | 'time-and-space';
+    /**
+     * Define the width of the screen that triggers hiding of the side bar.
+     * Note that the width is checked at the component creation and not when the screen is resized.
+     * If user resizes the screen he must manually hide the side bar.
+     *
+     * @type {(number | undefined)}
+     * @memberof SdsSideBarComponent
+     */
+    autoHideScreenWidth: number | undefined;
+    /**
+     * Define the hint of the hide button.
+     *
+     * @type {string}
+     * @memberof SdsSideBarComponent
+     */
+    closeButtonHint?: string;
+    /**
+     * Define the hint of the show button.
+     *
+     * @type {string}
+     * @memberof SdsSideBarComponent
+     */
+    openButtonHint?: string;
     showSideBar: boolean;
-    product: string;
-    isMainSideBar: boolean;
-    showSideBarToggleButton: boolean;
-    hideSideBarText?: string;
-    showSideBarText?: string;
+    pullOutSideBar: boolean;
     caretIcon: IconDefinition;
+    autoHideActive: boolean;
+    private screenWidth;
+    private componentInitialized;
+    private _checkAutoHide$;
     constructor();
+    ngOnDestroy(): void;
+    ngOnChanges(changes: SimpleChanges): void;
     ngOnInit(): void;
     toggleSideBar(state?: boolean): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SdsSideBarComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SdsSideBarComponent, "sds-side-bar", never, { "product": "product"; "isMainSideBar": "isMainSideBar"; "showSideBarToggleButton": "showSideBarToggleButton"; "hideSideBarText": "hideSideBarText"; "showSideBarText": "showSideBarText"; }, {}, never, ["*"]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SdsSideBarComponent, "sds-side-bar", never, { "showCloseButton": "showCloseButton"; "enablePullOutMode": "enablePullOutMode"; "widthRem": "widthRem"; "product": "product"; "autoHideScreenWidth": "autoHideScreenWidth"; "closeButtonHint": "closeButtonHint"; "openButtonHint": "openButtonHint"; }, {}, never, ["*"]>;
 }