@nextui-org/theme/dist/components/snippet.d.ts

The default theme for NextUI components

import * as tailwind_variants from 'tailwind-variants';
import { VariantProps } from 'tailwind-variants';
import * as tailwind_variants_dist_config from 'tailwind-variants/dist/config';

/**
 * Snippet wrapper **Tailwind Variants** component
 *
 * const {base, content, pre, copy} = snippet({...})
 *
 * @example
 * <div className={base())}>
 *   <pre className={pre()}>
 *      // code snippet
 *      <div className={content()}>...</div>
 *   </pre>
 *   <button className={copy()}>
 *    <svg>
 *    // copy icon / check icon
 *    </svg>
 *  </button>
 * </div>
 */
declare const snippet: tailwind_variants.TVReturnType<{
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}, {
    base: string;
    pre: string;
    content: string;
    symbol: string;
    copyButton: string[];
    copyIcon: string[];
    checkIcon: string[];
}, undefined, tailwind_variants_dist_config.TVConfig<{
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}, {
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}>, {
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}, {
    base: string;
    pre: string;
    content: string;
    symbol: string;
    copyButton: string[];
    copyIcon: string[];
    checkIcon: string[];
}, tailwind_variants.TVReturnType<{
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}, {
    base: string;
    pre: string;
    content: string;
    symbol: string;
    copyButton: string[];
    copyIcon: string[];
    checkIcon: string[];
}, undefined, tailwind_variants_dist_config.TVConfig<{
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}, {
    variant: {
        flat: "";
        solid: "";
        bordered: "border-medium bg-transparent";
        shadow: "";
    };
    color: {
        default: {};
        primary: {};
        secondary: {};
        success: {};
        warning: {};
        danger: {};
    };
    size: {
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    radius: {
        none: {
            base: string;
        };
        sm: {
            base: string;
        };
        md: {
            base: string;
        };
        lg: {
            base: string;
        };
    };
    fullWidth: {
        true: {
            base: string;
        };
    };
    disableAnimation: {
        true: {};
        false: {
            copyIcon: string;
            checkIcon: string;
        };
    };
}>, unknown, unknown, undefined>>;
type SnippetVariantProps = VariantProps<typeof snippet>;
type SnippetSlots = keyof ReturnType<typeof snippet>;

export { SnippetSlots, SnippetVariantProps, snippet };