@payfit/unity-components
Version:
36 lines (35 loc) • 2.75 kB
TypeScript
import { VariantProps } from '@payfit/unity-themes';
import { PropsWithChildren } from 'react';
export declare const funnelPageContent: import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, "uy:flex-1 uy:px-300 uy:my-400 uy:md:px-400 uy:group-has-[[data-unity-component=\"FunnelPageHeader\"]]/funnelpage:mt-0", {} | {}, undefined, import('tailwind-variants').TVReturnType<unknown, undefined, "uy:flex-1 uy:px-300 uy:my-400 uy:md:px-400 uy:group-has-[[data-unity-component=\"FunnelPageHeader\"]]/funnelpage:mt-0", unknown, unknown, undefined>>;
export type FunnelPageContentProps = PropsWithChildren<VariantProps<typeof funnelPageContent>>;
/**
* The `FunnelPageContent` component provides the main content area of a funnel page.
* It creates a flexible content container with responsive padding that adapts to different screen sizes.
* @param {FunnelPageContentProps} props - The props for the `FunnelPageContent` component
* @example
* ```tsx
* import { FunnelPageContent } from '@payfit/unity-components'
*
* function Example() {
* return (
* <FunnelPageContent>
* <div>Main content here</div>
* </FunnelPageContent>
* )
* }
* ```
* @remarks
* - Automatically adjusts top margin when FunnelPageHeader is present
* - Provides consistent padding across different screen sizes
* - Uses semantic section element for proper document structure
* - Automatically sets DataDog's session replay privacy to `data-dd-privacy="mask"`
* @see {@link FunnelPageContentProps} for all available props
* @see Source code in {@link https://github.com/PayFit/hr-apps/blob/master/libs/shared/unity/components/src/components/funnel-layout/parts GitHub}
* @see Design specs {@link https://www.figma.com/design/poaMyU7abAgL9VRhx4ygyy/Unity-DS-%3E-Components-Library?node-id=10802-11500&m=dev Figma}
* @see Design docs in {@link https://www.payfit.design/24f360409/p/88f9fc-funnel/b/24ca6f Payfit.design}
* @see Developer docs in {@link https://unity-components.payfit.io/?path=/docs/layout-funnellayout-funnelpage-funnelpagecontent--docs unity-components.payfit.io}
*/
declare const FunnelPageContent: import('react').ForwardRefExoticComponent<VariantProps<import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, "uy:flex-1 uy:px-300 uy:my-400 uy:md:px-400 uy:group-has-[[data-unity-component=\"FunnelPageHeader\"]]/funnelpage:mt-0", {} | {}, undefined, import('tailwind-variants').TVReturnType<unknown, undefined, "uy:flex-1 uy:px-300 uy:my-400 uy:md:px-400 uy:group-has-[[data-unity-component=\"FunnelPageHeader\"]]/funnelpage:mt-0", unknown, unknown, undefined>>> & {
children?: import('react').ReactNode | undefined;
} & import('react').RefAttributes<HTMLElement>>;
export { FunnelPageContent };