@nextui-org/theme 0.0.0-canary-20240429052129

package/dist/components/menu.d.ts

@@ -0,0 +1,512 @@
+import * as tailwind_variants_dist_config from 'tailwind-variants/dist/config';
+import * as tailwind_variants from 'tailwind-variants';
+import { VariantProps } from 'tailwind-variants';
+
+/**
+ * Menu wrapper **Tailwind Variants** component
+ *
+ * const classNames = menu({...})
+
+ */
+declare const menu: tailwind_variants.TVReturnType<{
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            list?: tailwind_variants.ClassValue;
+            emptyContent?: tailwind_variants.ClassValue;
+        };
+    };
+} | {
+    [x: string]: {
+        [x: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            list?: tailwind_variants.ClassValue;
+            emptyContent?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}, {
+    base: string;
+    list: string;
+    emptyContent: string[];
+}, undefined, tailwind_variants_dist_config.TVConfig<unknown, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            list?: tailwind_variants.ClassValue;
+            emptyContent?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}>, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            list?: tailwind_variants.ClassValue;
+            emptyContent?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}, {
+    base: string;
+    list: string;
+    emptyContent: string[];
+}, tailwind_variants.TVReturnType<unknown, {
+    base: string;
+    list: string;
+    emptyContent: string[];
+}, undefined, tailwind_variants_dist_config.TVConfig<unknown, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            list?: tailwind_variants.ClassValue;
+            emptyContent?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}>, unknown, unknown, undefined>>;
+/**
+ * MenuItem wrapper **Tailwind Variants** component
+ *
+ * const {base, heading, indicator, trigger, leftIndicator, title, subtitle, content } = menuItem({...})
+ *
+ * @example
+ * <div className={base())} data-focus-visible={boolean} data-hover={boolean}>
+ *   <div className={heading())}>
+ *    <button className={trigger())}>
+ *      <div className={leftIndicator()}>
+ *         // content
+ *      </div>
+ *      <div className={titleWrapper()}>
+ *        <h3 className={title())}>Title</h3>
+ *        <span className={subtitle())}>Subtitle</span>
+ *      </div>
+ *      <span className={indicator())}>Indicator</span>
+ *    </button>
+ *  </div>
+ *  <div className={content())}>Content</div>
+ * </div>
+ */
+declare const menuItem: tailwind_variants.TVReturnType<{
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}, {
+    base: string[];
+    wrapper: string;
+    title: string;
+    description: string[];
+    selectedIcon: string[];
+    shortcut: string[];
+}, undefined, tailwind_variants_dist_config.TVConfig<{
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}, {
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}>, {
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}, {
+    base: string[];
+    wrapper: string;
+    title: string;
+    description: string[];
+    selectedIcon: string[];
+    shortcut: string[];
+}, tailwind_variants.TVReturnType<{
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}, {
+    base: string[];
+    wrapper: string;
+    title: string;
+    description: string[];
+    selectedIcon: string[];
+    shortcut: string[];
+}, undefined, tailwind_variants_dist_config.TVConfig<{
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}, {
+    variant: {
+        solid: {
+            base: string;
+        };
+        bordered: {
+            base: string;
+        };
+        light: {
+            base: string;
+        };
+        faded: {
+            base: string[];
+        };
+        flat: {
+            base: string;
+        };
+        shadow: {
+            base: string;
+        };
+    };
+    color: {
+        default: {};
+        primary: {};
+        secondary: {};
+        success: {};
+        warning: {};
+        danger: {};
+    };
+    showDivider: {
+        true: {
+            base: string[];
+        };
+        false: {};
+    };
+    isDisabled: {
+        true: {
+            base: string;
+        };
+    };
+    disableAnimation: {
+        true: {};
+        false: {
+            base: string;
+        };
+    };
+}>, unknown, unknown, undefined>>;
+/**
+ * Menu section wrapper **Tailwind Variants** component
+ *
+ * const { base, section, heading } = menuSection({...})
+ *
+ * @example
+ * <div className={base()}>
+ *  <button className={trigger()} aria-expanded="true/false">your trigger</button>
+ *  <div className={section()}>
+ *    // menu content
+ *    <span className={arrow()} data-placement="top/bottom/left/right..." /> // arrow
+ *  </div>
+ * </div>
+ */
+declare const menuSection: tailwind_variants.TVReturnType<{
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            divider?: tailwind_variants.ClassValue;
+            group?: tailwind_variants.ClassValue;
+            heading?: tailwind_variants.ClassValue;
+        };
+    };
+} | {
+    [x: string]: {
+        [x: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            divider?: tailwind_variants.ClassValue;
+            group?: tailwind_variants.ClassValue;
+            heading?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}, {
+    base: string;
+    heading: string;
+    group: string;
+    divider: string;
+}, undefined, tailwind_variants_dist_config.TVConfig<unknown, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            divider?: tailwind_variants.ClassValue;
+            group?: tailwind_variants.ClassValue;
+            heading?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}>, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            divider?: tailwind_variants.ClassValue;
+            group?: tailwind_variants.ClassValue;
+            heading?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}, {
+    base: string;
+    heading: string;
+    group: string;
+    divider: string;
+}, tailwind_variants.TVReturnType<unknown, {
+    base: string;
+    heading: string;
+    group: string;
+    divider: string;
+}, undefined, tailwind_variants_dist_config.TVConfig<unknown, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            base?: tailwind_variants.ClassValue;
+            divider?: tailwind_variants.ClassValue;
+            group?: tailwind_variants.ClassValue;
+            heading?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}>, unknown, unknown, undefined>>;
+type MenuVariantProps = VariantProps<typeof menu>;
+type MenuSlots = keyof ReturnType<typeof menu>;
+type MenuSectionVariantProps = VariantProps<typeof menuSection>;
+type MenuSectionSlots = keyof ReturnType<typeof menuSection>;
+type MenuItemVariantProps = VariantProps<typeof menuItem>;
+type MenuItemSlots = keyof ReturnType<typeof menuItem>;
+
+export { MenuItemSlots, MenuItemVariantProps, MenuSectionSlots, MenuSectionVariantProps, MenuSlots, MenuVariantProps, menu, menuItem, menuSection };