@momo-kits/step 0.103.2-rc.24 → 0.103.2-rc.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/types.ts +27 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@momo-kits/step",
3
- "version": "0.103.2-rc.24",
3
+ "version": "0.103.2-rc.26",
4
4
  "private": false,
5
5
  "main": "index.tsx",
6
6
  "dependencies": {},
package/types.ts CHANGED
@@ -30,14 +30,29 @@ export type StepsProps = {
30
30
  */
31
31
  activeIndex: number;
32
32
 
33
+ /**
34
+ * Optional. If `true`, the step numbers are displayed within the step icons.
35
+ */
33
36
  useNumber?: boolean;
34
37
 
38
+ /**
39
+ * Optional. Specifies the alignment of the steps within the component.
40
+ */
35
41
  align?: Align;
36
42
 
43
+ /**
44
+ * Optional. If `true`, the step descriptions are displayed below the step titles.
45
+ */
37
46
  customIcon?: string;
38
47
 
48
+ /**
49
+ * Optional. If `true`, the step descriptions are displayed below the step titles.
50
+ */
39
51
  onPress?: (item: Step, index: number) => void;
40
52
 
53
+ /**
54
+ * Optional. If `true`, the user won't be able to interact with the Steps component.
55
+ */
41
56
  disabled?: boolean;
42
57
  };
43
58
 
@@ -107,10 +122,19 @@ export type StepIconProps = {
107
122
  */
108
123
  style?: ViewStyle;
109
124
 
125
+ /**
126
+ * Optional. If `true`, the step number is displayed within the step icon.
127
+ */
110
128
  useNumber?: boolean;
111
129
 
130
+ /**
131
+ * Optional. The number to display within the step icon.
132
+ */
112
133
  index: number;
113
134
 
135
+ /**
136
+ * Optional. If `true`, the step icon is marked as active.
137
+ */
114
138
  isActive?: boolean;
115
139
 
116
140
  /**
@@ -119,6 +143,9 @@ export type StepIconProps = {
119
143
  customIcon?: string;
120
144
  };
121
145
 
146
+ /**
147
+ * Properties for the ProgressInfo component, which displays a progress bar
148
+ */
122
149
  export type ProgressInfoProps = {
123
150
  steps: Step[];
124
151
  horizontal?: boolean;