@payfit/unity-components
Version:
37 lines (36 loc) • 2.25 kB
TypeScript
import { VariantProps } from '@payfit/unity-themes';
import { PropsWithChildren } from 'react';
export declare const funnelPage: import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, string[], {} | {}, undefined, import('tailwind-variants').TVReturnType<unknown, undefined, string[], unknown, unknown, undefined>>;
export type FunnelPageProps = PropsWithChildren<VariantProps<typeof funnelPage>>;
/**
* The `FunnelPage` component represents the main content area of the funnel layout.
* It provides the primary content container with proper accessibility attributes
* and responsive sizing that adapts based on whether a sidebar is present.
* @param {FunnelPageProps} props - The props for the `FunnelPage` component
* @example
* ```tsx
* import { FunnelPage } from '@payfit/unity-components'
*
* function Example() {
* return (
* <FunnelPage>
* <div>Main content here</div>
* </FunnelPage>
* )
* }
* ```
* @remarks
* - Automatically receives accessibility attributes from `FunnelLayout` context
* - Adapts width based on sidebar presence
* - Provides proper semantic structure with main element
* - Automatically sets DataDog's session replay privacy to `data-dd-privacy="mask-user-input"`
* @see {@link FunnelPageProps} 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--docs unity-components.payfit.io}
*/
declare const FunnelPage: import('react').ForwardRefExoticComponent<VariantProps<import('tailwind-variants').TVReturnType<{} | {} | {}, undefined, string[], {} | {}, undefined, import('tailwind-variants').TVReturnType<unknown, undefined, string[], unknown, unknown, undefined>>> & {
children?: import('react').ReactNode | undefined;
} & import('react').RefAttributes<HTMLElement>>;
export { FunnelPage };