@rarui/styles 1.17.0-rc.5 → 1.17.0

package/dist/index.d.ts

@@ -15,9 +15,13 @@ export interface ThemeProviderContextProps {
 	currentTheme: Theme;
 }
 export declare const useTheme: () => ThemeProviderContextProps;
-declare const styles: {
+declare const avatarStyles: {
 	container: string;
 	avatar: import("@vanilla-extract/recipes").RuntimeFn<{
+		/**
+		 * Specifies the size of the Avatar component.
+		 * @default medium
+		 */
 		size: {
 			small: {
 				width: "20px";
@@ -61,7 +65,7 @@ declare const styles: {
 		};
 	}>;
 };
-export type AvatarVariants = RecipeVariants<typeof styles.avatar>;
+export type AvatarVariants = RecipeVariants<typeof avatarStyles.avatar>;
 export declare const avatar: {
 	classnames: {
 		container: string;
@@ -110,8 +114,12 @@ export declare const avatar: {
 		}>;
 	};
 };
-declare const styles$1: {
+declare const badgeStyles: {
 	badge: import("@vanilla-extract/recipes").RuntimeFn<{
+		/**
+		 * Determines the visual style of the badge, influencing its color scheme and appearance.
+		 * @defaiult brand
+		 */
 		appearance: {
 			brand: {
 				backgroundColor: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
@@ -149,6 +157,10 @@ declare const styles$1: {
 				color: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
 			};
 		};
+		/**
+		 * Specifies the size of the badge, controlling its dimensions.
+		 * @defaiult medium
+		 */
 		size: {
 			large: {
 				padding: `0 var(--${string})` | `0 var(--${string}, ${string})` | `0 var(--${string}, ${number})`;
@@ -173,6 +185,10 @@ declare const styles$1: {
 				width: "0.5rem";
 			};
 		};
+		/**
+		 * Defines the visual variant of the badge, affecting its background style.
+		 * @defaiult solid
+		 */
 		variant: {
 			solid: {};
 			outlined: {
@@ -183,7 +199,7 @@ declare const styles$1: {
 		};
 	}>;
 };
-export type BadgeVariants = RecipeVariants<typeof styles$1.badge>;
+export type BadgeVariants = RecipeVariants<typeof badgeStyles.badge>;
 export declare const badge: {
 	classnames: {
 		badge: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -7024,7 +7040,7 @@ export declare const box: {
 		}
 	]>;
 };
-declare const styles$2: {
+declare const styles: {
 	button: import("@vanilla-extract/recipes").RuntimeFn<{
 		full: {
 			true: {
@@ -7105,7 +7121,7 @@ declare const styles$2: {
 	}>;
 	overlay: string;
 };
-export type ButtonVariants = RecipeVariants<typeof styles$2.button>;
+export type ButtonVariants = RecipeVariants<typeof styles.button>;
 export declare const button: {
 	classnames: {
 		button: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -7274,7 +7290,7 @@ declare const checkbox$1: {
 		overlay: string;
 	};
 };
-declare const styles$3: {
+declare const styles$1: {
 	chip: import("@vanilla-extract/recipes").RuntimeFn<{
 		pill: {
 			true: {
@@ -7310,7 +7326,7 @@ declare const paddingProperties: {
 	medium: string;
 	small: string;
 };
-export type ChipVariants = RecipeVariants<typeof styles$3.chip>;
+export type ChipVariants = RecipeVariants<typeof styles$1.chip>;
 export interface ChipSprinkle {
 	/**
 	 * The padding properties are used to generate space around an chip's content area.
@@ -7700,7 +7716,7 @@ export declare const icon: {
 		}
 	]>;
 };
-declare const styles$4: {
+declare const styles$2: {
 	iconButton: import("@vanilla-extract/recipes").RuntimeFn<{
 		appearance: {
 			brand: {
@@ -7770,7 +7786,7 @@ declare const styles$4: {
 	}>;
 	overlay: string;
 };
-export type IconButtonVariants = RecipeVariants<typeof styles$4.iconButton>;
+export type IconButtonVariants = RecipeVariants<typeof styles$2.iconButton>;
 export declare const iconButton: {
 	classnames: {
 		iconButton: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -7843,7 +7859,7 @@ export declare const iconButton: {
 		overlay: string;
 	};
 };
-declare const styles$5: {
+declare const styles$3: {
 	container: import("@vanilla-extract/recipes").RuntimeFn<{
 		appearance: {
 			success: {
@@ -7932,7 +7948,7 @@ declare const styles$5: {
 		};
 	}>;
 };
-export type InputVariants = RecipeVariants<typeof styles$5.container> & RecipeVariants<typeof styles$5.input>;
+export type InputVariants = RecipeVariants<typeof styles$3.container> & RecipeVariants<typeof styles$3.input>;
 export declare const input: {
 	classnames: {
 		container: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -8024,7 +8040,7 @@ export declare const input: {
 		}>;
 	};
 };
-declare const styles$6: {
+declare const styles$4: {
 	label: import("@vanilla-extract/recipes").RuntimeFn<{
 		hidden: {
 			true: {
@@ -8040,7 +8056,7 @@ declare const styles$6: {
 		};
 	}>;
 };
-export type LabelVariants = RecipeVariants<typeof styles$6.label>;
+export type LabelVariants = RecipeVariants<typeof styles$4.label>;
 export declare const label: {
 	classnames: {
 		label: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -8059,7 +8075,7 @@ export declare const label: {
 		}>;
 	};
 };
-declare const styles$7: {
+declare const styles$5: {
 	link: import("@vanilla-extract/recipes").RuntimeFn<{
 		appearance: {
 			brand: {
@@ -8091,7 +8107,7 @@ declare const styles$7: {
 		};
 	}>;
 };
-export type LinkVariants = RecipeVariants<typeof styles$7.link>;
+export type LinkVariants = RecipeVariants<typeof styles$5.link>;
 export declare const link: {
 	classnames: {
 		link: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -8126,7 +8142,7 @@ export declare const link: {
 		}>;
 	};
 };
-declare const styles$8: {
+declare const styles$6: {
 	radioButton: import("@vanilla-extract/recipes").RuntimeFn<{
 		size: {
 			small: {
@@ -8184,7 +8200,7 @@ declare const styles$8: {
 	input: string;
 	container: string;
 };
-export type RadioButtonVariants = RecipeVariants<typeof styles$8.radioButton>;
+export type RadioButtonVariants = RecipeVariants<typeof styles$6.radioButton>;
 export declare const radioButton: {
 	classnames: {
 		radioButton: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -8363,7 +8379,7 @@ export declare const skeleton: {
 		}
 	]>;
 };
-declare const styles$9: {
+declare const styles$7: {
 	status: import("@vanilla-extract/recipes").RuntimeFn<{
 		appearance: {
 			success: {
@@ -8416,7 +8432,7 @@ declare const styles$9: {
 		};
 	}>;
 };
-export type StatusVariants = RecipeVariants<typeof styles$9.status>;
+export type StatusVariants = RecipeVariants<typeof styles$7.status>;
 declare const status$1: {
 	classnames: {
 		status: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -9056,8 +9072,12 @@ export declare const title: {
 		}
 	]>;
 };
-declare const styles$10: {
+declare const bannerStyles: {
 	banner: import("@vanilla-extract/recipes").RuntimeFn<{
+		/**
+		 * Specifies the visual appearance of the banner message, influencing its color and style.
+		 * @default brand
+		 */
 		appearance: {
 			brand: {
 				backgroundColor: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
@@ -9084,6 +9104,10 @@ declare const styles$10: {
 				color: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
 			};
 		};
+		/**
+		 * Determines whether the banner message should float above the content. This can be useful for ensuring the message remains visible even as the user scrolls.
+		 * @default false
+		 */
 		floating: {
 			true: {
 				borderRadius: `var(--${string})` | `var(--${string}, ${string})` | `var(--${string}, ${number})`;
@@ -9091,7 +9115,7 @@ declare const styles$10: {
 		};
 	}>;
 };
-export type BannerVariants = RecipeVariants<typeof styles$10.banner>;
+export type BannerVariants = RecipeVariants<typeof bannerStyles.banner>;
 export declare const banner: {
 	classnames: {
 		banner: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -9129,7 +9153,7 @@ export declare const banner: {
 		}>;
 	};
 };
-declare const styles$11: {
+declare const styles$8: {
 	toast: import("@vanilla-extract/recipes").RuntimeFn<{
 		placement: {
 			topRight: {};
@@ -9258,7 +9282,7 @@ declare const styles$11: {
 		};
 	}>;
 };
-export type ToastVariants = RecipeVariants<typeof styles$11.toast>;
+export type ToastVariants = RecipeVariants<typeof styles$8.toast>;
 export declare const toast: {
 	classnames: {
 		toast: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -9390,7 +9414,7 @@ export declare const toast: {
 		}>;
 	};
 };
-declare const styles$12: {
+declare const styles$9: {
 	toggle: import("@vanilla-extract/recipes").RuntimeFn<{
 		size: {
 			large: {
@@ -9459,7 +9483,7 @@ declare const styles$12: {
 		};
 	}>;
 };
-export type ToggleVariants = RecipeVariants<typeof styles$12.toggle>;
+export type ToggleVariants = RecipeVariants<typeof styles$9.toggle>;
 export declare const toggle: {
 	classnames: {
 		toggle: import("@vanilla-extract/recipes").RuntimeFn<{
@@ -9531,7 +9555,7 @@ export declare const toggle: {
 		}>;
 	};
 };
-declare const styles$13: {
+declare const styles$10: {
 	tooltip: import("@vanilla-extract/recipes").RuntimeFn<{
 		inverted: {
 			true: {
@@ -9564,7 +9588,7 @@ declare const styles$13: {
 	}>;
 	container: string;
 };
-export type TooltipVariants = RecipeVariants<typeof styles$13.tooltip>;
+export type TooltipVariants = RecipeVariants<typeof styles$10.tooltip>;
 export declare const tooltip: {
 	classnames: {
 		tooltip: import("@vanilla-extract/recipes").RuntimeFn<{