Merge pull request #485 from hy916/dev

fix:修改文档和添加测试用例

Author: ChenlingasMx

packages/core/src/Avatar/README.md

@@ -30,28 +30,11 @@ export default Demo
 
 继承 [View](https://facebook.github.io/react-native/docs/view#props) 组件。
 
-```ts
-import { ViewProps } from 'react-native';
-
-export interface AvatarProps extends ViewProps {
-  /** React Native `Image` 组件 Props */
-  imageProps?: ImageProps;
-  /** 图像源（远程URL或本地文件资源）。 */
-  src?: string | number;
-  /**
-   * 尺寸
-   * @default 40
-   */
-  size?: number;
-  /**
-   * 设置圆角
-   * @default 3
-   */
-  rounded?: number;
-  /**
-   * 指定头像的形状
-   * @default square
-   */
-  shape?: 'circle' | 'square';
-}
-```
+
+| 参数 | 说明 | 类型 | 默认值 |
+|------|------|-----|------|
+| `imageProps` | React Native `Image` 组件 Props | obj | - |
+| `src` | 图像源（远程URL或本地文件资源） | `string|number` | - |
+| `size` | 尺寸 | number | - |
+| `rounded` | 设置圆角 | number | - |
+| `shape` |指定头像的形状 | `circle｜square` | - |

packages/core/src/Rating/README.md

@@ -97,34 +97,15 @@ export default Demo
 
 ### Props
 
-```ts
-import { TabsItemIconTypes } from '@uiw/react-native'
-
-export type icoType = [TabsItemIconTypes, TabsItemIconTypes]
-export interface RatingProps {
-  /**  默认选中几个 */
-  defaultRating?: number;
-  /** 总数*/
-  resultRating?: number;
-  /** icon 大小 */
-  size?: number;
-  /** icon 颜色 */
-  color?: string;
-  /** actived 激活 unactived 未激活 */
-  icon?: {
-    actived?: TabsItemIconTypes,
-    unactived?: TabsItemIconTypes
-  };
-  /**
-   * void
-   * @param score type: number 选中几个
-   */
-  onPress?: (score: number) => void;
-    /** 自定义每项的提示信息 */
-  tooltips?: string[];
-  /** 自定义提示信息样式 */
-  tooltipsStyle?: StyleProp<TextStyle>;
-    /** 只读模式 */
-  disabled: boolean
-}
-```
+
+| 参数 | 说明 | 类型 | 默认值 |
+|------|------|-----|------|
+| `defaultRating` | 默认选中几个 | number | - |
+| `resultRating` | 总数 | number | - |
+| `size` | icon 大小 | number | - |
+| `color` | icon 颜色 | string | - |
+| `icon` | `actived` 激活 `unactived` 未激活 | obj | - |
+| `onPress` | 选中事件 | fn | - |
+| `tooltips` | 自定义每项的提示信息 | arr | - |
+| `resultRating` | 只读模式 | boolean | - |
+ 

packages/core/src/SwipeAction/README.md

@@ -41,6 +41,66 @@ import React,{ useRef } from 'react';
 import {SwipeAction} from '@uiw/react-native';
 import { View,Text } from 'react-native'
 
+function Demo() {
+  const ref = useRef()
+  const right = [
+    {
+      text: '查看',
+      color: 'orange',
+      x: 250,
+    },
+    {
+      text: '删除',
+      color: 'red',
+      x: 250,
+    },
+  ];
+  return (
+    <SwipeAction ref={ref} buttonWidth={60} right={right}>
+      <View><Text>滑动</Text></View>
+    </SwipeAction>
+  );
+}
+export default Demo;
+```
+
+### 禁用
+
+```jsx
+import React,{ useRef } from 'react';
+import {SwipeAction} from '@uiw/react-native';
+import { View,Text } from 'react-native'
+
+function Demo() {
+  const ref = useRef()
+  const right = [
+    {
+      text: '查看',
+      color: 'orange',
+      x: 250,
+    },
+    {
+      text: '删除',
+      color: 'red',
+      x: 250,
+    },
+  ];
+  return (
+    <SwipeAction ref={ref} buttonWidth={60} right={right}>
+      <View><Text>滑动</Text></View>
+    </SwipeAction>
+  );
+}
+export default Demo;
+```
+
+### 禁用
+
+```jsx
+import React,{ useRef } from 'react';
+import {SwipeAction} from '@uiw/react-native';
+import { View,Text } from 'react-native'
+
 function Demo() {
   const ref = useRef()
   const right = [

test-ci/src/__tests__/noticeBar.tsx

@@ -0,0 +1,73 @@
+import 'react-native';
+import React from 'react';
+import NoticeBar from '../lib/NoticeBar';
+import Marquee from '../lib/NoticeBar/Marquee'
+import { Text, Image } from 'react-native';
+import { render, fireEvent } from '@testing-library/react-native';
+import { keys, toObject } from '../utils';
+
+const MODES: keys = {
+  closable: '×',
+  link: '∟'
+}
+
+describe('NoticeBar', () => {
+  describe.each`
+    mode
+    ${'closable'}
+    ${'link'}
+  `('$mode', ({ mode }) => {
+    it(`should display mode ${mode} noticeBar`, () => {
+      const { getByText } = render(<NoticeBar mode={mode} />);
+      expect(getByText(MODES[mode])).toBeTruthy();
+    });
+  });
+
+  it('icon', () => {
+    const source = {
+      uri: 'https://zos.alipayobjects.com/rmsportal/bRnouywfdRsCcLU.png'
+    }
+    const customIcon = (
+      <Image
+        source={source}
+        style={{ width: 12, height: 12 }}
+      />
+    )
+    const { UNSAFE_getByType } = render(<NoticeBar icon={customIcon} />);
+    const component = UNSAFE_getByType(Image);
+    expect(component.props.source).toMatchObject(source);
+  });
+
+  it('marqueeProps', () => {
+    const { UNSAFE_getByType } = render(<NoticeBar marqueeProps={{ style: { fontSize: 12 } }} />);
+    const component = UNSAFE_getByType(Marquee);
+    expect(component.props.style).toMatchObject({ fontSize: 12 });
+  });
+
+  // it('onPress', () => {
+  //   const fn = jest.fn();
+  //   const { getByTestId } = render(<NoticeBar onPress={fn}>onPress</NoticeBar>);
+  //   const component = getByTestId('RNE__NoticeBar__wrap');
+  //   fireEvent(component, 'press');
+  //   expect(fn).toHaveBeenCalled();
+  // });
+
+  // it('action', () => {
+  //   const { getByText } = render(<NoticeBar action={<Text>去看看</Text>} />);
+  //   expect(getByText('去看看')).toBeTruthy();
+  // });
+
+  // it('style', () => {
+  //   const { getByTestId } = render(<NoticeBar style={{ height: 50 }} />);
+  //   const component = getByTestId('RNE__NoticeBar__wrap');
+  //   const styles = toObject(component.props.style);
+  //   expect(styles.height).toBe(50);
+  // });
+
+  // it('textStyle', () => {
+  //   const { getByTestId } = render(<NoticeBar textStyle={{ fontSize: 20 }} />);
+  //   const component = getByTestId('RNE__NoticeBar__div');
+  //   const styles = toObject(component.props.style);
+  //   expect(styles.fontSize).toBe(20);
+  // });
+});