@nextui-org/theme 0.0.0-canary-20240429052129

package/dist/components/avatar.d.ts

@@ -0,0 +1,572 @@
+import * as tailwind_variants from 'tailwind-variants';
+import { VariantProps } from 'tailwind-variants';
+import * as tailwind_variants_dist_config from 'tailwind-variants/dist/config';
+
+/**
+ * Avatar wrapper **Tailwind Variants** component
+ *
+ * const {base, img, icon, name } = avatar({...})
+ *
+ * @example
+ * <div className={base())} data-hover={true/false} data-focus={true/false} data-focus-visible={true/false}>
+ *    <img className={img()} src="https://picsum.photos/200/300" alt="your avatar" />
+ *    <div role="img" aria-label="your name" className={name()}>your name</div>
+ *    <span role="img" aria-label="your icon" className={icon()}>your icon</span>
+ * </div>
+ */
+declare const avatar: tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}, {
+    base: string[];
+    img: string[];
+    fallback: string[];
+    name: string[];
+    icon: string[];
+}, undefined, tailwind_variants_dist_config.TVConfig<{
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}, {
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}>, {
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}, {
+    base: string[];
+    img: string[];
+    fallback: string[];
+    name: string[];
+    icon: string[];
+}, tailwind_variants.TVReturnType<{
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}, {
+    base: string[];
+    img: string[];
+    fallback: string[];
+    name: string[];
+    icon: string[];
+}, undefined, tailwind_variants_dist_config.TVConfig<{
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}, {
+    size: {
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+    };
+    color: {
+        default: {
+            base: string;
+        };
+        primary: {
+            base: string;
+        };
+        secondary: {
+            base: string;
+        };
+        success: {
+            base: string;
+        };
+        warning: {
+            base: string;
+        };
+        danger: {
+            base: string;
+        };
+    };
+    radius: {
+        none: {
+            base: string;
+        };
+        sm: {
+            base: string;
+        };
+        md: {
+            base: string;
+        };
+        lg: {
+            base: string;
+        };
+        full: {
+            base: string;
+        };
+    };
+    isBordered: {
+        true: {
+            base: string;
+        };
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    isInGroup: {
+        true: {
+            base: string[];
+        };
+    };
+    isInGridGroup: {
+        true: {
+            base: string;
+        };
+    };
+}>, unknown, unknown, undefined>>;
+/**
+ * AvatarGroup wrapper **Tailwind Variants** component
+ *
+ * const classNames = avatarGroup({...})
+ *
+ * @example
+ * <div role="group" className={classNames())}>
+ *   // avatar elements
+ * </div>
+ */
+declare const avatarGroup: tailwind_variants.TVReturnType<{
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}, {
+    base: string;
+    count: string;
+}, undefined, tailwind_variants_dist_config.TVConfig<{
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}, {
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}>, {
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}, {
+    base: string;
+    count: string;
+}, tailwind_variants.TVReturnType<{
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}, {
+    base: string;
+    count: string;
+}, undefined, tailwind_variants_dist_config.TVConfig<{
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}, {
+    isGrid: {
+        true: "inline-grid grid-cols-4 gap-3";
+    };
+}>, unknown, unknown, undefined>>;
+type AvatarGroupVariantProps = VariantProps<typeof avatarGroup>;
+type AvatarGroupSlots = keyof ReturnType<typeof avatarGroup>;
+type AvatarVariantProps = VariantProps<typeof avatar>;
+type AvatarSlots = keyof ReturnType<typeof avatar>;
+
+export { AvatarGroupSlots, AvatarGroupVariantProps, AvatarSlots, AvatarVariantProps, avatar, avatarGroup };