dgz-ui
Version:
Custom ui library using React.js, Shadcn/ui, TailwindCSS, Typescript
43 lines • 2.3 kB
TypeScript
import { VariantProps } from 'class-variance-authority';
import { Separator } from '../separator';
/**
* Variants for the ButtonGroup component.
* Defines styles for horizontal and vertical orientations.
*/
declare const buttonGroupVariants: (props?: ({
orientation?: "horizontal" | "vertical" | null | undefined;
} & import('class-variance-authority/types').ClassProp) | undefined) => string;
/**
* A container component that groups buttons together.
* Supports horizontal (default) and vertical orientations.
*
* @param {object} props - The component props.
* @param {string} [props.className] - Additional class names to apply.
* @param {"horizontal" | "vertical"} [props.orientation] - The orientation of the button group.
* @returns {JSX.Element} The rendered ButtonGroup component.
*/
declare function ButtonGroup({ className, orientation, ...props }: React.ComponentProps<'div'> & VariantProps<typeof buttonGroupVariants>): import("react/jsx-runtime").JSX.Element;
/**
* A text component designed to be used within a ButtonGroup.
* It provides consistent styling for text elements alongside buttons.
*
* @param {object} props - The component props.
* @param {string} [props.className] - Additional class names to apply.
* @param {boolean} [props.asChild=false] - Whether to render as a child element.
* @returns {JSX.Element} The rendered ButtonGroupText component.
*/
declare function ButtonGroupText({ className, asChild, ...props }: React.ComponentProps<'div'> & {
asChild?: boolean;
}): import("react/jsx-runtime").JSX.Element;
/**
* A separator component for use within a ButtonGroup.
* It provides a visual divider between items in the group.
*
* @param {object} props - The component props.
* @param {string} [props.className] - Additional class names to apply.
* @param {"horizontal" | "vertical"} [props.orientation="vertical"] - The orientation of the separator. Defaults to "vertical".
* @returns {JSX.Element} The rendered ButtonGroupSeparator component.
*/
declare function ButtonGroupSeparator({ className, orientation, ...props }: React.ComponentProps<typeof Separator>): import("react/jsx-runtime").JSX.Element;
export { ButtonGroup, ButtonGroupSeparator, ButtonGroupText, buttonGroupVariants, };
//# sourceMappingURL=button-group.d.ts.map