@momo-kits/stepper 0.77.4 → 0.77.5-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@momo-kits/stepper",
-    "version": "0.77.4",
+    "version": "0.77.5-beta.01",
     "private": false,
     "main": "index.tsx",
     "dependencies": {},

package/types.ts

@@ -1,34 +1,135 @@
 import {ViewStyle} from 'react-native';
 
+/**
+ * Properties for the StepperButton component, which represents the individual
+ * increment and decrement buttons in a stepper control.
+ */
 export type StepperButtonProps = {
+  /**
+   * Optional. If `true`, the button is disabled and not interactive.
+   * Defaults to `false` if not provided.
+   */
   disabled?: boolean;
+
+  /**
+   * Determines the button's function in the stepper, either increment ('+') or decrement ('-').
+   */
   sign?: '+' | '-';
+
+  /**
+   * Optional. Specifies the size of the button. If not provided, a default size is used.
+   */
   size?: 'large' | 'small';
+
+  /**
+   * A callback function that is triggered when the button is pressed.
+   */
   onPress: () => void;
 };
 
+/**
+ * Properties for the StepperValue component, which displays the current value
+ * within a stepper control and allows for direct input.
+ */
 export type StepperValueProps = {
+  /**
+   * The current numeric value displayed by the stepper.
+   */
   value: number;
+
+  /**
+   * Optional. If `true`, the value display is disabled and not interactive.
+   * Defaults to `false` if not provided.
+   */
   disabled?: boolean;
+
+  /**
+   * Optional. Specifies the size of the value display. If not provided, a default size is used.
+   */
   size?: 'large' | 'small';
+
+  /**
+   * Optional. If `true`, the value display is editable, and users can input values directly.
+   * Defaults to `false` if not provided.
+   */
   editable?: boolean;
+
+  /**
+   * Optional. A callback function that is triggered when the value changes, receiving the new value as a parameter.
+   */
   onValueChange?: (value: string) => void;
 };
 
+/**
+ * General properties for the Stepper component, which combines the buttons and value display
+ * to provide a full feature numeric stepper control.
+ */
 export type StepperProps = {
+  /**
+   * The initial value when the stepper is first rendered.
+   */
   defaultValue: number;
+
+  /**
+   * Optional. The minimum allowable value for the stepper. If not provided, there is no minimum.
+   */
   min?: number;
+
+  /**
+   * Optional. The maximum allowable value for the stepper. If not provided, there is no maximum.
+   */
   max?: number;
+
+  /**
+   * Optional. Specifies whether the entire stepper control or specific parts are disabled.
+   * Can be a single boolean (to disable all) or an array of booleans (to control individual components).
+   */
   disabled?: boolean | boolean[];
+
+  /**
+   * Optional. The step increment used for each button press. Defaults to 1 if not provided.
+   */
   step?: number;
+
+  /**
+   * Optional. Specifies the size of the stepper components. If not provided, a default size is used.
+   */
   size?: 'large' | 'small';
+
+  /**
+   * Optional. If `true`, the value display is editable, and users can input values directly.
+   * Defaults to `false` if not provided.
+   */
   editable?: boolean;
+
+  /**
+   * Optional. A callback function that is triggered when the stepper's value changes, receiving the new value as a parameter.
+   */
   onValueChange?: (value: number) => void;
+
+  /**
+   * Optional. Custom styles to apply to the Stepper component. Can be used to adjust the visual presentation or layout.
+   */
   style?: ViewStyle | ViewStyle[];
 };
 
+/**
+ * Specifies the disabled state for each part of the Stepper component, allowing
+ * individual parts to be disabled as needed.
+ */
 export type DisabledStatus = {
+  /**
+   * If `true`, the increment (plus) button is disabled.
+   */
   plus: boolean;
+
+  /**
+   * If `true`, the decrement (minus) button is disabled.
+   */
   minus: boolean;
+
+  /**
+   * If `true`, the value display (number) is disabled, preventing direct input.
+   */
   number: boolean;
 };