@carbon/ibm-products
Version:
Carbon for IBM Products
66 lines • 2.47 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 {
/**
* Provide the optional content for header section and will be render after header titles and before progress indicator.
* People can make use of this if they want to have custom header.
*/
children?: React.ReactNode;
/**
* The accessibility title for the close icon (if shown).
*
* **Note:** This prop is only required if a close icon is shown, i.e. if
* there are a no navigation actions and/or hideCloseButton is false.
*/
closeIconDescription?: string;
/**
* Enable a close icon ('x') in the header area of the tearsheet. By default,
* (when this prop is omitted, or undefined or null) a tearsheet does not
* display a close icon if there are navigation actions ("transactional
* tearsheet") and displays one if there are no navigation actions ("passive
* tearsheet"), and that behavior can be overridden if required by setting
* this prop to either true or false.
*/
hideCloseButton?: boolean;
className?: string;
/**
* Default header collapse/expand while scrolling the main content can be disabled by setting this
*/
disableHeaderCollapse?: boolean;
}
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 IconButtonProps {
collapseText?: string;
expandText?: string;
className?: string;
}
export declare const TearsheetScrollButton: React.ForwardRefExoticComponent<TearsheetScrollButtonProps & React.RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=TearsheetHeader.d.ts.map