@carbon/ibm-products-web-components 0.30.0-rc.0 → 0.30.0

package/lib/components/page-header/page-header-breadcrumb.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+/**
+ * Page header Breadcrumb Bar.
+ * @element c4p-page-header-breadcrumb
+ */
+declare class CDSPageHeaderBreadcrumb extends LitElement {
+    /**
+     * Specify if breadcrumb bar has bottom border.
+     */
+    border: boolean;
+    /**
+     * Set to `true` if the breadcrumb bar is sitting within a grid
+     * (ie. when used in tandem with page-header-hero-image)
+     */
+    withinGrid: boolean;
+    /**
+     * Set to `true` if page actions should be flush (no padding)
+     */
+    pageActionsFlush: boolean;
+    /**
+     * Set to `true` if content actions should be flush (no padding)
+     */
+    contentActionsFlush: boolean;
+    context: any;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeaderBreadcrumb;

package/lib/components/page-header/page-header-content-text.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+/**
+ * Page header Content Text.
+ * @element c4p-page-header-content-text
+ */
+declare class CDSPageHeaderContentText extends LitElement {
+    /**
+     * Subtitle text of the page-header-content
+     */
+    subtitle: string;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeaderContentText;

package/lib/components/page-header/page-header-content.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+import '@carbon/web-components/es/components/tooltip/index.js';
+/**
+ * Page header content.
+ * @element c4p-page-header-content
+ */
+declare class CDSPageHeaderContent extends LitElement {
+    /**
+     * Set to `true` if there are contextual actions
+     */
+    private _hasContextualActions;
+    /**
+     * Handles `slotchange` event.
+     */
+    protected _handleSlotChange({ target }: Event): void;
+    /**
+     * Title text of the page-header-content
+     */
+    title: string;
+    /**
+     * Set to `true` if the tag text has ellipsis applied
+     */
+    _hasEllipsisApplied: boolean;
+    /**
+     * Set to `true` if the breadcrumb bar is sitting within a grid
+     * (ie. when used in tandem with page-header-hero-image)
+     */
+    withinGrid: boolean;
+    context: any;
+    updated(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeaderContent;

package/lib/components/page-header/page-header-hero-image.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+/**
+ * Page header Hero Image.
+ * @element c4p-page-header-hero-image
+ */
+declare class CDSPageHeaderHeroImage extends LitElement {
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeaderHeroImage;

package/lib/components/page-header/page-header-scroller.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import '@carbon/web-components/es/components/button/index.js';
+import CDSButton from '@carbon/web-components/es/components/button/button';
+/**
+ * Page header Scroller button
+ * @element c4p-page-header-scroller
+ */
+export declare class PageHeaderScroller extends CDSButton {
+    /**
+     * Specify how the trigger should align with the tooltip
+     */
+    align: string;
+    /**
+     * Specify whether a auto align functionality should be applied
+     */
+    autoalign: boolean;
+    /**
+     * Determines whether the tooltip should close when inner content is activated (click, Enter or Space)
+     */
+    closeOnActivation: boolean;
+    /**
+     * Specify the collapse text for the scroller button
+     */
+    collapseText: string;
+    /**
+     * Specify whether the tooltip should be open when it first renders
+     */
+    defaultOpen: boolean;
+    /**
+     * Specify the duration in milliseconds to delay before displaying the tooltip
+     */
+    enterDelayMs: number;
+    /**
+     * Specify the expand text for the scroller button
+     */
+    expandText: string;
+    /**
+     * Specify the duration in milliseconds to delay before hiding the tooltip
+     */
+    leaveDelayMs: number;
+    /**
+     * Specify the size of the Button. Defaults to `md`.
+     */
+    size: string;
+    context: any;
+    protected _renderTooltipContent(): import("lit-html").TemplateResult<1>;
+    private _handleScroller;
+    render(): import("lit-html").TemplateResult<1>;
+}

package/lib/components/page-header/page-header-tabs.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+/**
+ * Page header Tabs Bar.
+ * @element c4p-page-header-tabs
+ */
+declare class CDSPageHeaderTabs extends LitElement {
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeaderTabs;

package/lib/components/page-header/page-header-title-breadcrumb.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import CDSBreadcrumbItem from '@carbon/web-components/es/components/breadcrumb/breadcrumb-item';
+/**
+ * Page header Title Breadcrumb
+ * @element c4p-page-header-title-breadcrumb
+ */
+declare class CDSPageHeaderTitleBreadcrumb extends CDSBreadcrumbItem {
+    context: any;
+    constructor();
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeaderTitleBreadcrumb;

package/lib/components/page-header/page-header.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { LitElement } from 'lit';
+export interface pageHeaderContextType {
+    breadcrumbOffset?: number;
+    headerOffset?: number;
+    fullyCollapsed?: boolean;
+    titleClipped?: boolean;
+    contentActionsClipped?: boolean;
+    root?: CDSPageHeader | null;
+    withContent?: boolean;
+}
+/**
+ * Page header.
+ * @element c4p-page-header
+ */
+declare class CDSPageHeader extends LitElement {
+    context: pageHeaderContextType;
+    private resizeObserver;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: any;
+}
+export default CDSPageHeader;

package/lib/components/page-header/page-header.test.d.ts

@@ -0,0 +1 @@
+import './index';

package/lib/components/page-header/utils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2025, 2025
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * ----------
+ * Utilities
+ * ----------
+ */
+export declare const getHeaderOffset: (el: HTMLElement) => number;
+/**
+ * Determines if the given target is scrollable
+ *
+ * @param {HTMLElement} target
+ * @returns {boolean}
+ */
+export declare const scrollable: (target: HTMLElement) => boolean;
+/**
+ * Recursively looks for the scrollable ancestor
+ */
+export declare const scrollableAncestorInner: (target: HTMLElement) => any;
+/**
+ * Walks up the parent nodes to identify the first scrollable ancestor
+ *
+ * @param {HTMLElement} target
+ * @returns {HTMLElement}
+ */
+export declare const scrollableAncestor: (target: HTMLElement) => any;

package/lib/components/side-panel/_story-assets/index.d.ts

@@ -0,0 +1,8 @@
+import '@carbon/web-components/es/components/breadcrumb/index.js';
+import '@carbon/web-components/es/components/notification/index.js';
+export declare const getContent: (index: any) => import("lit-html").TemplateResult<1> | null;
+export declare const getSubTitle: (index: any) => import("lit-html").TemplateResult<1> | null;
+export declare const getActionToolbarItems: (index: any) => import("lit-html").TemplateResult<1> | null;
+export declare const getActionItems: (index: any) => import("lit-html").TemplateResult<1> | null;
+export declare const getSlug: (index: any) => import("lit-html").TemplateResult<1> | null;
+export declare const getCustomHeaderComponents: (index: any) => import("lit-html").TemplateResult<1> | null;

package/lib/components/side-panel/defs.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Modal size.
+ */
+export declare enum SIDE_PANEL_SIZE {
+    /**
+     * Extra small size.
+     */
+    EXTRA_SMALL = "xs",
+    /**
+     * Small size.
+     */
+    SMALL = "sm",
+    /**
+     * Medium size.
+     */
+    MEDIUM = "md",
+    /**
+     * Large size.
+     */
+    LARGE = "lg",
+    /**
+     * 2X-Large size.
+     */
+    EXTRA_EXTRA_LARGE = "2xl"
+}
+export declare enum SIDE_PANEL_PLACEMENT {
+    /** right / default */
+    RIGHT = "right",
+    /** left  */
+    LEFT = "left"
+}

package/lib/components/side-panel/defs.js

@@ -0,0 +1,51 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+'use strict';
+
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * Modal size.
+ */
+exports.SIDE_PANEL_SIZE = void 0;
+(function (SIDE_PANEL_SIZE) {
+    /**
+     * Extra small size.
+     */
+    SIDE_PANEL_SIZE["EXTRA_SMALL"] = "xs";
+    /**
+     * Small size.
+     */
+    SIDE_PANEL_SIZE["SMALL"] = "sm";
+    /**
+     * Medium size.
+     */
+    SIDE_PANEL_SIZE["MEDIUM"] = "md";
+    /**
+     * Large size.
+     */
+    SIDE_PANEL_SIZE["LARGE"] = "lg";
+    /**
+     * 2X-Large size.
+     */
+    SIDE_PANEL_SIZE["EXTRA_EXTRA_LARGE"] = "2xl";
+})(exports.SIDE_PANEL_SIZE || (exports.SIDE_PANEL_SIZE = {}));
+exports.SIDE_PANEL_PLACEMENT = void 0;
+(function (SIDE_PANEL_PLACEMENT) {
+    /** right / default */
+    SIDE_PANEL_PLACEMENT["RIGHT"] = "right";
+    /** left  */
+    SIDE_PANEL_PLACEMENT["LEFT"] = "left";
+})(exports.SIDE_PANEL_PLACEMENT || (exports.SIDE_PANEL_PLACEMENT = {}));
+//# sourceMappingURL=defs.js.map

package/lib/components/side-panel/defs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defs.js","sources":["../../../src/components/side-panel/defs.ts"],"sourcesContent":[null],"names":["SIDE_PANEL_SIZE","SIDE_PANEL_PLACEMENT"],"mappings":";;;;;;;;;AAAA;;;;;;;AAOG;AAEH;;AAEG;AACSA;AAAZ,CAAA,UAAY,eAAe,EAAA;AACzB;;AAEG;AACH,IAAA,eAAA,CAAA,aAAA,CAAA,GAAA,IAAkB;AAElB;;AAEG;AACH,IAAA,eAAA,CAAA,OAAA,CAAA,GAAA,IAAY;AAEZ;;AAEG;AACH,IAAA,eAAA,CAAA,QAAA,CAAA,GAAA,IAAa;AAEb;;AAEG;AACH,IAAA,eAAA,CAAA,OAAA,CAAA,GAAA,IAAY;AAEZ;;AAEG;AACH,IAAA,eAAA,CAAA,mBAAA,CAAA,GAAA,KAAyB;AAC3B,CAAC,EAzBWA,uBAAe,KAAfA,uBAAe,GAyB1B,EAAA,CAAA,CAAA;AAEWC;AAAZ,CAAA,UAAY,oBAAoB,EAAA;;AAE9B,IAAA,oBAAA,CAAA,OAAA,CAAA,GAAA,OAAe;;AAGf,IAAA,oBAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACf,CAAC,EANWA,4BAAoB,KAApBA,4BAAoB,GAM/B,EAAA,CAAA,CAAA;;"}

package/lib/components/side-panel/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ *
+ * Copyright IBM Corp. 2023, 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import './side-panel';