@c15t/react
Version:
Developer-first CMP for React: cookie banner, consent manager, preferences centre. GDPR ready with minimal setup and rich customization
47 lines • 1.47 kB
TypeScript
import { type HTMLAttributes } from 'react';
import type { ExtendThemeKeys } from '../../../types/theme';
/**
* Props for the description text component of the CookieBanner.
* Extends standard HTML div attributes.
*
* @public
*/
export interface BoxProps extends Omit<HTMLAttributes<HTMLDivElement>, 'style'>, ExtendThemeKeys {
asChild?: boolean;
}
/**
* Renders the descriptive text content within a CookieBanner.
*
* @remarks
* This component is responsible for displaying the explanatory text that:
* - Informs users about the site's cookie usage
* - Explains what cookies are used for
* - Provides context for the cookie consent choices
*
* The component automatically inherits styles from the CookieBanner context
* and can be customized through className and style props.
*
* @example
* Basic usage:
* ```tsx
* <CookieBanner.Description>
* We use cookies to enhance your browsing experience and analyze site traffic.
* </CookieBanner.Description>
* ```
*
* @example
* With custom styling:
* ```tsx
* <CookieBanner.Description
* className="text-gray-600"
* style={{ maxWidth: '500px' }}
* >
* By using our site, you acknowledge that you have read and understand our
* Cookie Policy and Privacy Policy.
* </CookieBanner.Description>
* ```
*
* @public
*/
export declare const Box: import("react").ForwardRefExoticComponent<BoxProps & import("react").RefAttributes<HTMLDivElement>>;
//# sourceMappingURL=box.d.ts.map