@ambuj.bhaskar/react-component-library 0.8.3 → 0.9.0

package/dist/index.d.ts

@@ -288,6 +288,38 @@ declare type SpinnerProps = {
 
 declare type SVGprops = React.ComponentProps<"svg">;
 
+/**
+ * A simple switch component.
+ *
+ * @remarks
+ * This component is a simple on/off switch.
+ *
+ * @param {SwitchProps} props - The props for the switch component.
+ * @param {boolean} [props.value=false] - Whether the switch is checked or not.
+ * @param {boolean} [props.disabled=false] - Whether the switch is disabled or not.
+ * @param {ReactNode} [props.checkedChildren] - The content of the switch when checked.
+ * @param {ReactNode} [props.unCheckedChildren] - The content of the switch when unchecked.
+ * @param {boolean} [props.loading] - Whether the switch is in loading state.
+ * @param {string} [props.uncheckedBackgroundColor] - Background color when unchecked.
+ * @param {string} [props.checkedBackgroundColor] - Background color when checked.
+ * @param {string} [props.disabledBackgroundColor] - Background color when disabled.
+ *
+ * @returns {React.ReactElement} - The switch component.
+ */
+export declare const Switch: React.FC<SwitchProps>;
+
+declare type SwitchProps = {
+    value?: boolean;
+    disabled?: boolean;
+    checkedChildren?: ReactNode;
+    unCheckedChildren?: ReactNode;
+    onChange?: (checked: boolean) => void;
+    loading?: boolean;
+    uncheckedBackgroundColor?: Color;
+    checkedBackgroundColor?: Color;
+    disabledBackgroundColor?: Color;
+};
+
 declare type TextSize = "xs" | "s" | "m" | "l" | "xl";
 
 declare type Theme = Partial<{