@carbon/ibm-products
Version:
Carbon for IBM Products
96 lines • 3.09 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 React, { ReactNode } from 'react';
/**
* ----------------
* TearsheetBody
* ----------------
*/
export interface TearsheetBodyProps {
/** Optional static content for the body */
children?: ReactNode;
/** Optional class name applied to the body container */
className?: string;
}
declare const TearsheetBody: React.ForwardRefExoticComponent<TearsheetBodyProps & React.RefAttributes<HTMLDivElement>>;
export interface MainContentProps {
children: ReactNode;
className?: string;
/**
* When `true`, the content takes full width with no padding.
*/
isFlush?: boolean;
}
/**
* ----------------
* MainContent
* ----------------
*/
export declare const MainContent: React.ForwardRefExoticComponent<MainContentProps & React.RefAttributes<HTMLDivElement>>;
/**
* ----------------
* SummaryContent
* ----------------
*/
export interface SummaryContentProps {
children: ReactNode;
className?: string;
/**
* On mobile screens the summary panel is hidden by default. Toggle this prop
* to open/close it.
*/
summaryPanelOpen?: boolean;
/**
* Handler called when the summary panel close button is activated.
*/
onSummaryPanelClose?(): void;
/**
* When `true`, the content takes full width with no padding.
*/
isFlush?: boolean;
/**
* Optional ref to the trigger button that opened the panel. Focus returns
* here when the panel closes.
*/
summaryPanelTriggerRef?: React.RefObject<HTMLElement | null>;
/**
* Accessible label for the summary panel. Defaults to "Summary panel".
*/
summaryPanelAriaLabel?: string;
}
export declare const SummaryContent: React.ForwardRefExoticComponent<SummaryContentProps & React.RefAttributes<HTMLDivElement>>;
/**
* ----------------
* Influencer
* ----------------
*/
export interface InfluencerProps {
children: ReactNode;
className?: string;
/**
* In mobile screens right side details section wont be visible by default. This prop can be toggled to open/close right panel in this case.
*/
influencerPanelOpen?: boolean;
/**
* Specify a handler for closing the side panel.
* This handler closes the modal, e.g. changing `open` prop.
*/
onInfluencerPanelClose?(): void;
/** this can be set take full width without any padding */
isFlush?: boolean;
/**
* Optional ref to the trigger button that opened the panel. Focus will return here when panel closes.
*/
influencerPanelTriggerRef?: React.RefObject<HTMLElement>;
/**
* Optional aria-label for the influencer panel. Defaults to "Influencer panel".
*/
influencerPanelAriaLabel?: string;
}
export declare const Influencer: React.ForwardRefExoticComponent<InfluencerProps & React.RefAttributes<HTMLDivElement>>;
export default TearsheetBody;
//# sourceMappingURL=TearsheetBody.d.ts.map