dgz-ui/dist/types/ui/sheet/sheet.d.ts

Custom ui library using React.js, Shadcn/ui, TailwindCSS, Typescript

import * as SheetPrimitive from '@radix-ui/react-dialog';
import * as React from 'react';
/**
 * Sheet - Drawer-style dialog built on Radix Dialog primitives.
 *
 * @param {React.ComponentProps<typeof SheetPrimitive.Root>} props - Props for the component.
 */
declare function Sheet({ ...props }: React.ComponentProps<typeof SheetPrimitive.Root>): import("react/jsx-runtime").JSX.Element;
/**
 * SheetTrigger - Element that opens the Sheet when interacted with.
 *
 * @param {React.ComponentProps<typeof SheetPrimitive.Trigger>} props - Props for the component.
 */
declare function SheetTrigger({ ...props }: React.ComponentProps<typeof SheetPrimitive.Trigger>): import("react/jsx-runtime").JSX.Element;
/**
 * SheetClose - Element that closes the Sheet.
 *
 * @param {React.ComponentProps<typeof SheetPrimitive.Close>} props - Props for the component.
 */
declare function SheetClose({ ...props }: React.ComponentProps<typeof SheetPrimitive.Close>): import("react/jsx-runtime").JSX.Element;
/**
 * SheetContent - The sliding panel content. Configurable side.
 *
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the sheet content.
 * @param {React.ReactNode} [props.children] - The content to be rendered inside the sheet.
 * @param {'top' | 'right' | 'bottom' | 'left'} [props.side='right'] - The side of the screen where the sheet will appear.
 */
declare function SheetContent({ className, children, side, ...props }: React.ComponentProps<typeof SheetPrimitive.Content> & {
    side?: 'top' | 'right' | 'bottom' | 'left';
}): import("react/jsx-runtime").JSX.Element;
/**
 * SheetHeader - Header area inside the Sheet.
 *
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the sheet header.
 */
declare function SheetHeader({ className, ...props }: React.ComponentProps<'div'>): import("react/jsx-runtime").JSX.Element;
/**
 * SheetFooter - Footer area inside the Sheet.
 *
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the sheet footer.
 */
declare function SheetFooter({ className, ...props }: React.ComponentProps<'div'>): import("react/jsx-runtime").JSX.Element;
/**
 * SheetTitle - Accessible title for the Sheet.
 *
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the sheet title.
 */
declare function SheetTitle({ className, ...props }: React.ComponentProps<typeof SheetPrimitive.Title>): import("react/jsx-runtime").JSX.Element;
/**
 * SheetDescription - Additional descriptive text for the Sheet.
 *
 * @param {object} props - The properties for the component.
 * @param {string} [props.className] - Additional classes for the sheet description.
 */
declare function SheetDescription({ className, ...props }: React.ComponentProps<typeof SheetPrimitive.Description>): import("react/jsx-runtime").JSX.Element;
export { Sheet, SheetClose, SheetContent, SheetDescription, SheetFooter, SheetHeader, SheetTitle, SheetTrigger, };
//# sourceMappingURL=sheet.d.ts.map