@carbon/ibm-products
Version:
Carbon for IBM Products
67 lines • 2.3 kB
TypeScript
/**
* Copyright IBM Corp. 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 { IconButtonProps } from '@carbon/react';
import React, { ReactNode } from 'react';
/**
* ----------------
* TearsheetHeader
* ----------------
*/
export interface TearsheetHeaderProps {
/**
* Optional content rendered inside the header section, after titles and
* before any progress indicator.
*/
children?: React.ReactNode;
/**
* The accessibility label for the close icon (required when the close button
* is visible).
*/
closeIconDescription?: string;
/**
* Override whether the close button is shown. When omitted, a close button
* is shown for passive tearsheets (no navigation actions) and hidden for
* transactional ones.
*/
hideCloseButton?: boolean;
className?: string;
/**
* Set to `true` to disable the default header collapse/expand behavior
* that is triggered by scrolling the main content.
*/
disableHeaderCollapse?: boolean;
/**
* Callback fired whenever the header's fully-collapsed state changes.
* Receives `true` when the header is fully collapsed, `false` when expanded.
*/
onHeaderCollapse?: (collapsed: boolean) => void;
}
declare const TearsheetHeader: React.ForwardRefExoticComponent<TearsheetHeaderProps & React.RefAttributes<HTMLDivElement>>;
export default TearsheetHeader;
/**
* ----------------
* TearsheetNavigationBar
* ----------------
*/
export interface TearsheetNavigationBarProps {
children: ReactNode;
scroller?: React.ReactNode;
className?: string;
}
export declare const TearsheetNavigationBar: React.ForwardRefExoticComponent<TearsheetNavigationBarProps & React.RefAttributes<HTMLDivElement>>;
/**
* ----------------
* TearsheetScrollButton
* ----------------
*/
export interface TearsheetScrollButtonProps extends Omit<IconButtonProps, 'label' | 'children'> {
collapseText?: string;
expandText?: string;
className?: string;
}
export declare const TearsheetScrollButton: React.ForwardRefExoticComponent<TearsheetScrollButtonProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=TearsheetHeader.d.ts.map