@momo-kits/chip 0.77.5 → 0.77.7

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@momo-kits/chip",
-    "version": "0.77.5",
+    "version": "0.77.7",
     "private": false,
     "main": "index.tsx",
     "dependencies": {},

package/types.ts

@@ -1,13 +1,55 @@
 import {ViewStyle} from 'react-native';
 
+/**
+ * Props for the Chip component. A Chip is a compact element that represents an input, attribute, or action.
+ */
 export type ChipProps = {
+  /**
+   * The text to be displayed on the chip. This is typically a brief piece of information like a tag.
+   */
   label: string;
+
+  /**
+   * Optional. The name of the icon to be displayed on the left side of the chip's label.
+   * If not provided, no icon is rendered on the left.
+   */
   iconLeft?: string;
+
+  /**
+   * Optional. The name of the icon to be displayed on the right side of the chip's label.
+   * If not provided, no icon is rendered on the right.
+   */
   iconRight?: string;
+
+  /**
+   * Optional. Indicates whether the chip is selected. A selected chip may have a different style or icon.
+   * Defaults to `false` if not provided.
+   */
   selected?: boolean;
+
+  /**
+   * Optional. Custom styles to apply to the Chip component. Can be a single style or an array of styles.
+   */
   style?: ViewStyle | ViewStyle[];
+
+  /**
+   * Optional. A callback function triggered when the chip is pressed. This makes the chip act as a touchable element.
+   */
   onPress?: () => void;
+
+  /**
+   * Optional. Specifies the size of the chip, influencing its padding and font size. Can be 'small' or 'large'.
+   * If not provided, a standard size is used.
+   */
   size?: 'small' | 'large';
+
+  /**
+   * Optional. Specifies the color of the left icon. If not provided, a default icon color may be used.
+   */
   iconLeftColor?: string;
+
+  /**
+   * Optional. Specifies the color of the right icon. If not provided, a default icon color may be used.
+   */
   iconRightColor?: string;
 };