doc(Empty/Flex/Grid): update document.

Author: jaywcjlove

packages/core/src/Empty/README.md

@@ -129,10 +129,27 @@ class Demo extends Component {
 
 ## Props
 
-| 参数 | 说明 | 类型 | 默认值 |
-|------|------|-----|------|
-| `label` | 设置提示文本 | String | `暂无数据` |
-| `children` | 不光提示文本，还有更多内容，`label` 将不起作用 | ReactNode | - |
-| `labelStyle` | 设置提示文本样式 | TextProps['style'] | - |
-| `size` | 图标大小 | Number | `64` |
-| `xml` | 传递 SVG xml 字符串，自定义图标，设为 `null` 将不展示图标。 | String | - |
+```ts
+export interface EmptyProps extends FlexProps {
+  /**
+   * 设置提示文本
+   */
+  label?: string;
+  /**
+   * 设置提示音样式
+   */
+  labelStyle?: TextProps['style'];
+  /**
+   * 设置 图标尺寸
+   */
+  size?: number;
+  /**
+   * 传递 SVG xml 字符串，自定义图标，设为 `null` 将不展示图标。
+   */
+  xml?: string;
+  /**
+   * 不光提示文本，还有更多内容，`label` 将不起作用
+   */
+  children?: React.ReactNode;
+}
+```

packages/core/src/Empty/index.tsx

@@ -17,7 +17,7 @@ const iconStr = `
 
 export interface EmptyProps extends FlexProps {
   /**
-   * 设置提示语
+   * 设置提示文本
    */
   label?: string;
   /**
@@ -29,11 +29,11 @@ export interface EmptyProps extends FlexProps {
    */
   size?: number;
   /**
-   * 替换默认的图标 这里是 SVG string
+   * 传递 SVG xml 字符串，自定义图标，设为 `null` 将不展示图标。
    */
   xml?: string;
   /**
-   * 空提示更多内容
+   * 不光提示文本，还有更多内容，`label` 将不起作用
    */
   children?: React.ReactNode;
 }

packages/core/src/Flex/README.md

@@ -76,11 +76,20 @@ export interface FlexProps extends ViewProps {
    * @default row
    */
   direction?: FlexStyle['flexDirection'];
-  /** 子元素在主轴上的对齐方式 */
+  /**
+   * 子元素在主轴上的对齐方式
+   * @default start
+   */
   justify?: 'start' | 'end' | 'center' | 'between' | 'around';
-  /** 子元素在交叉轴上的对齐方式 */
+  /**
+   * 子元素在交叉轴上的对齐方式
+   * @default start
+   */
   align?: 'start' | 'end' | 'center' | 'stretch' | 'baseline';
-  /** 子元素的换行方式 */
+  /**
+   * 子元素的换行方式
+   * @default nowrap
+   */
   wrap?: 'wrap' | 'nowrap' | 'wrap-reverse';
 }
 ```

packages/core/src/Flex/index.tsx

@@ -9,11 +9,20 @@ export interface FlexProps extends ViewProps {
    * @default row
    */
   direction?: FlexStyle['flexDirection'];
-  /** 子元素在主轴上的对齐方式 */
+  /**
+   * 子元素在主轴上的对齐方式
+   * @default start
+   */
   justify?: 'start' | 'end' | 'center' | 'between' | 'around';
-  /** 子元素在交叉轴上的对齐方式 */
+  /**
+   * 子元素在交叉轴上的对齐方式
+   * @default start
+   */
   align?: 'start' | 'end' | 'center' | 'stretch' | 'baseline';
-  /** 子元素的换行方式 */
+  /**
+   * 子元素的换行方式
+   * @default nowrap
+   */
   wrap?: 'wrap' | 'nowrap' | 'wrap-reverse';
 }
 

packages/core/src/Grid/README.md

@@ -59,13 +59,32 @@ function Demo() {
 
 ## Props
 
-| 参数 | 说明 | 类型 | 默认值 |
-|------|------|-----|------|
-| `data` | 传入的菜单数据，`icon` 可以是 `ReactNode` 或者 `uri` | Array<{icon?: React.ReactNode; text?: React.ReactNode;}> | `[]` |
-| `columns` | 列数 | Number | `4` |
-| `hasLine` | 是否有间隔线 | boolean | `true` |
-| `itemStyle` | 单元格样式 | ViewStyle | - |
-| `iconStyle` | 图片样式，可设置图片/图标尺寸 | ImageStyle & TextStyle & ViewStyle | - |
-| `textStyle` | 单元格文本样式 | TextStyle & ViewStyle | - |
-| `renderItem` | 自定义单元格 | (data, index, rowNum): void | - |
-| `onPress` | 点击宫格回调函数 | (data, index, rowNum): void | - |
+```ts
+export interface GridProps extends ViewProps {
+  /**
+   * 传入的菜单数据，`icon` 可以是 `ReactNode` 或者 `uri`
+   * @default []
+   */
+  data?: ItemData[];
+  /**
+   * 列数
+   * @default 4
+   */
+  columns?: number;
+  /**
+   * 是否有间隔线
+   * @default true
+   */
+  hasLine?: boolean;
+  /** 单元格样式 */
+  itemStyle?: StyleProp<ViewStyle>;
+  /** 单元格文本样式 */
+  textStyle?: StyleProp<TextStyle & ViewStyle>;
+  /** 图片样式，可设置图片/图标尺寸 */
+  iconStyle?: StyleProp<ImageStyle & TextStyle & ViewStyle>;
+  /** 自定义单元格 */
+  renderItem?: (data: ItemData, index: number, row: number) => React.ReactNode;
+  /** 点击宫格回调函数 */
+  onPress?: (data: ItemData, index: number, row: number, event: GestureResponderEvent) => void;
+}
+```

packages/core/src/Grid/index.tsx

@@ -44,13 +44,30 @@ interface ItemData {
 }
 
 export interface GridProps extends ViewProps {
+  /**
+   * 传入的菜单数据，`icon` 可以是 `ReactNode` 或者 `uri`
+   * @default []
+   */
   data?: ItemData[];
+  /**
+   * 列数
+   * @default 4
+   */
   columns?: number;
+  /**
+   * 是否有间隔线
+   * @default true
+   */
   hasLine?: boolean;
+  /** 单元格样式 */
   itemStyle?: StyleProp<ViewStyle>;
+  /** 单元格文本样式 */
   textStyle?: StyleProp<TextStyle & ViewStyle>;
+  /** 图片样式，可设置图片/图标尺寸 */
   iconStyle?: StyleProp<ImageStyle & TextStyle & ViewStyle>;
+  /** 自定义单元格 */
   renderItem?: (data: ItemData, index: number, row: number) => React.ReactNode;
+  /** 点击宫格回调函数 */
   onPress?: (data: ItemData, index: number, row: number, event: GestureResponderEvent) => void;
 }