@ambuj.bhaskar/react-component-library 0.6.0 → 0.6.1

package/dist/index.d.ts

@@ -5,36 +5,32 @@ import * as React_2 from 'react';
 import { ReactNode } from 'react';
 
 /**
- * Button component props.
- /**
- * @typedef {Object} ButtonProps
- * @property {string} [variant="primary"] - Variant of the button, affects styling.
- * @property {string} [background="rgb(255, 204, 0)"] - Background color of the button.
- * @property {string} [border="#292929"] - Border color of the button.
- * @property {string} [container="hugging"] - Container type for button sizing.
- * @property {string} [width="13.5rem"] - Width of the button.
- * @property {string} [height="m"] - Height of the button.
- * @property {string} [padding="m"] - Padding inside the button.
- * @property {string} [gap="0.25rem"] - Gap between elements inside the button.
- * @property {string} [placement="center"] - Placement of the content inside the button.
- * @property {boolean} [disabled=false] - If true, the button is disabled.
- * @property {boolean} [loading=false] - If true, the button shows a loading state.
- * @property {string} [text=null] - Text to display inside the button.
- * @property {string} [textSize="s"] - Size of the text inside the button.
- * @property {string} [textColor="#292929"] - Color of the text inside the button.
- * @property {Object.<string, string>} [textColorStates=null] - Color states for the text.
- * @property {IconName} [icon=null] - Icon to display inside the button.
- * @property {string} [iconSize="s"] - Size of the icon inside the button.
- * @property {string} [iconColor="#292929"] - Color of the icon inside the button.
- * @property {string} [iconPosition="before"] - Position of the icon relative to the text.
- * @property {Object.<string, string>} [iconColorStates=null] - Color states for the icon.
- * @property {string} [className=null] - Additional class names for styling.
- * @property {...React.ComponentPropsWithoutRef<'button'>} [props=null] - Other button props
+ * The Button component.
+ *
+ * @param {ButtonProps} props - The props object.
+ * @prop {string} [variant=primary] - The variant of the button.
+ * @prop {string} [background=rgb(255, 204, 0)] - The background color of the button.
+ * @prop {string} [border=#292929] - The border color of the button.
+ * @prop {string} [container=hugging] - The container type of the button.
+ * @prop {string} [width=13.5rem] - The width of the button.
+ * @prop {string} [size=m] - The size of the button.
+ * @prop {string} [gap=0.25rem] - The gap between elements inside the button.
+ * @prop {string} [placement=center] - The placement of the content inside the button.
+ * @prop {boolean} [disabled=false] - If true, the button is disabled.
+ * @prop {boolean} [loading=false] - If true, the button shows a loading state.
+ * @prop {string} [text=null] - The text to display inside the button.
+ * @prop {string} [textSize] - The size of the text inside the button.
+ * @prop {string} [textColor=#292929] - The color of the text inside the button.
+ * @prop {object} [textColorStates=null] - Overrides the behaviour of color on default, hover, active states, which is intially set by the variant.
+ * @prop {IconName} [icon=null] - The icon to display inside the button.
+ * @prop {string} [iconSize] - The size of the icon inside the button.
+ * @prop {string} [iconColor=#292929] - The color of the icon inside the button.
+ * @prop {string} [iconPosition=before] - The position of the icon relative to the text.
+ * @prop {object} [iconColorStates=null] - Overrides the behaviour of color on default, hover, active states, which is intially set by the variant.
+ * @prop {string} [className=null] - Additional class names for styling.
  */
 export declare const Button: React.FC<ButtonProps>;
 
-declare type ButtonHeight = "s" | "m" | "l";
-
 declare type ButtonProps = HTMLButtonProps & {
     variant?: "primary" | "secondary" | "tertiary" | "nav";
     background?: Color;
@@ -42,9 +38,8 @@ declare type ButtonProps = HTMLButtonProps & {
     border?: Color;
     borderStates?: ColorStatesType;
     container?: "fixed" | "hugging";
-    padding?: Padding;
+    size?: Size;
     width?: CSSstring;
-    height?: ButtonHeight;
     gap?: CSSstring;
     placement?: JustifyContent;
     loading?: boolean;
@@ -54,7 +49,7 @@ declare type ButtonProps = HTMLButtonProps & {
     textColor?: Color;
     textColorStates?: ColorStatesType;
     icon?: IconName;
-    iconSize?: "s" | "m" | "l";
+    iconSize?: IconProps["size"];
     iconColor?: Color;
     iconPosition?: IconPositionType;
     iconColorStates?: ColorStatesType;
@@ -202,8 +197,6 @@ declare type Option_2 = {
     value: string;
 };
 
-declare type Padding = "s" | "m" | "l";
-
 /**
  * A single select component.
  *
@@ -235,6 +228,8 @@ declare type SelectProps = {
     suffixIcon?: ReactNode | boolean;
 };
 
+declare type Size = "s" | "m" | "l";
+
 /**
  * Spinner component props.
  *
@@ -253,4 +248,15 @@ declare type SVGprops = React.ComponentProps<"svg">;
 
 declare type TextSize = "xs" | "s" | "m" | "l" | "xl";
 
+declare type Theme = {
+    [key: string]: string | Theme;
+};
+
+export declare const ThemeProvider: ({ theme, children }: ThemeProviderProps) => JSX_2.Element;
+
+declare interface ThemeProviderProps {
+    theme: Theme;
+    children: ReactNode;
+}
+
 export { }