@payfit/unity-components
Version:
60 lines (59 loc) • 2.38 kB
TypeScript
import { VariantProps } from '@payfit/unity-themes';
import { PropsWithChildren } from 'react';
export declare const sidePanelHeader: import('tailwind-variants').TVReturnType<{
[key: string]: {
[key: string]: import('tailwind-merge').ClassNameValue | {
content?: import('tailwind-merge').ClassNameValue;
base?: import('tailwind-merge').ClassNameValue;
heading?: import('tailwind-merge').ClassNameValue;
};
};
} | {
[x: string]: {
[x: string]: import('tailwind-merge').ClassNameValue | {
content?: import('tailwind-merge').ClassNameValue;
base?: import('tailwind-merge').ClassNameValue;
heading?: import('tailwind-merge').ClassNameValue;
};
};
} | {}, {
base: string[];
content: string[];
heading: string[];
}, undefined, {
[key: string]: {
[key: string]: import('tailwind-merge').ClassNameValue | {
content?: import('tailwind-merge').ClassNameValue;
base?: import('tailwind-merge').ClassNameValue;
heading?: import('tailwind-merge').ClassNameValue;
};
};
} | {}, {
base: string[];
content: string[];
heading: string[];
}, import('tailwind-variants').TVReturnType<unknown, {
base: string[];
content: string[];
heading: string[];
}, undefined, unknown, unknown, undefined>>;
export interface SidePanelHeaderProps extends PropsWithChildren<VariantProps<typeof sidePanelHeader>> {
className?: string;
}
/**
* The `SidePanelHeader` component renders the header section of a side panel.
* It includes a title and close button, and on mobile it displays a drag handle for bottom sheet interaction.
* @component
* @param {SidePanelHeaderProps} props - The props for the `SidePanelHeader` component
* @example
* ```tsx
* import { SidePanelHeader } from '@payfit/unity-components'
*
* <SidePanelHeader>Title of the panel</SidePanelHeader>
* ```
* @see {@link SidePanelHeaderProps} for all available props
* @remarks
* [API Docs](https://unity-components.payfit.io/?path=/docs/feedback-sidepanel--docs) • [Design Docs](https://www.payfit.design/24f360409/p/21bfe4-side-panel)
*/
declare const SidePanelHeader: import('react').ForwardRefExoticComponent<SidePanelHeaderProps & import('react').RefAttributes<HTMLDivElement>>;
export { SidePanelHeader };