Skip to content

Commit c7510fa

Browse files
jaywcjlovejaywcjlove
committed
chore: visiable rename visible & mark visiable deprecated. #369 
1 parent 281d6e9 commit c7510fa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+202
-164
lines changed

‎packages/bezier-curve/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ const Example = () => {
4646
<div style={{ width: '100%', height: '500px' }}>
4747
<Map zoom={14} center={[116.397637, 39.900001]}>
4848
<BezierCurve
49-
visiable={show}
49+
visible={show}
5050
path={path}
5151
isOutline={true}
5252
outlineColor="#ffeeff"
@@ -83,7 +83,7 @@ export default Mount;
8383

8484
| 参数 | 说明 | 类型 | 默认值 |
8585
|--------- |-------- |--------- |-------- |
86-
| visiable | 覆盖物是否可见。 | `boolean` | - |
86+
| visible | 覆盖物是否可见。 | `boolean` | - |
8787
| path | 贝瑟尔曲线的路径。 | `Array<LngLat>` / `Array<Array<LngLat>>` | - |
8888

8989
### 事件

‎packages/bezier-curve/src/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ import { useBezierCurve } from './useBezierCurve';
55
export * from './useBezierCurve';
66

77
export interface BezierCurveProps extends OverlayProps, AMap.BezierCurveEvents, AMap.BezierCurveOptions {
8-
/** 覆盖物是否可见 */
8+
/** @deprecated use `visible` */
99
visiable?: boolean;
10+
/** 覆盖物是否可见 */
11+
visible?: boolean;
1012
}
1113
export const BezierCurve = React.forwardRef<BezierCurveProps, BezierCurveProps>((props, ref) => {
1214
const { bezierCurve } = useBezierCurve(props);

‎packages/bezier-curve/src/useBezierCurve.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { BezierCurveProps } from '.';
55

66
export interface UseBezierCurve extends BezierCurveProps {}
77
export const useBezierCurve = (props = {} as UseBezierCurve) => {
8-
const { visiable, ...other } = props;
8+
const { visiable, visible, ...other } = props;
99
const { map } = useMapContext();
1010
const [bezierCurve, setBezierCurve] = useState<AMap.BezierCurve>();
1111
useEffect(() => {
@@ -27,7 +27,7 @@ export const useBezierCurve = (props = {} as UseBezierCurve) => {
2727
}
2828
}, [map]);
2929

30-
useVisiable(bezierCurve!, visiable);
30+
useVisiable(bezierCurve!, visible ?? visiable);
3131
useSettingProperties<AMap.BezierCurve, UseBezierCurve>(bezierCurve!, props, [
3232
'Options',
3333
'Path',

‎packages/circle-marker/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const Example = () => {
3333
<Map zoom={4} center={[116.400274, 39.905812]}>
3434
<CircleMarker
3535
center={new AMap.LngLat(116.407394, 39.904211)}
36-
visiable={show}
36+
visible={show}
3737
radius={10+Math.random()*10}
3838
strokeColor="#fff"
3939
strokeWeight={2}
@@ -47,7 +47,7 @@ const Example = () => {
4747
/>
4848
<CircleMarker
4949
center={new AMap.LngLat(113.26641, 23.132324)}
50-
visiable={show}
50+
visible={show}
5151
radius={10+Math.random()*10}
5252
strokeColor="#fff"
5353
strokeWeight={2}
@@ -61,7 +61,7 @@ const Example = () => {
6161
/>
6262
<CircleMarker
6363
center={new AMap.LngLat(112.562678, 37.873499)}
64-
visiable={show}
64+
visible={show}
6565
radius={10+Math.random()*10}
6666
strokeColor="#fff"
6767
strokeWeight={2}
@@ -75,7 +75,7 @@ const Example = () => {
7575
/>
7676
<CircleMarker
7777
center={new AMap.LngLat(121.473662, 31.230372)}
78-
visiable={show}
78+
visible={show}
7979
radius={10+Math.random()*10}
8080
strokeColor="#fff"
8181
strokeWeight={2}
@@ -89,7 +89,7 @@ const Example = () => {
8989
/>
9090
<CircleMarker
9191
center={new AMap.LngLat(117.329949, 31.733806)}
92-
visiable={show}
92+
visible={show}
9393
radius={10+Math.random()*10}
9494
strokeColor="#fff"
9595
strokeWeight={2}
@@ -122,7 +122,7 @@ export default Mount;
122122

123123
| 参数 | 说明 | 类型 | 默认值 |
124124
|--------- |-------- |--------- |-------- |
125-
| visiable | 覆盖物是否可见。 | `boolean` | - |
125+
| visible | 覆盖物是否可见。 | `boolean` | - |
126126
| center | 圆心位置 | `LngLat` | - |
127127
| radius | 圆半径，单位:px 最大值64 | `number` | - |
128128
| zIndex | 多边形覆盖物的叠加顺序。地图上存在多个多边形覆盖物叠加时，通过该属性使级别较高的多边形覆盖物在上层显示 | `number` | 10 |

‎packages/circle-marker/src/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ import { useCircleMarker } from './useCircleMarker';
55
export * from './useCircleMarker';
66

77
export interface CircleMarkerProps extends OverlayProps, AMap.CircleMarkerEvents, AMap.CircleMarkerOptions {
8-
/** 覆盖物是否可见 */
8+
/** @deprecated use `visible` */
99
visiable?: boolean;
10+
/** 覆盖物是否可见 */
11+
visible?: boolean;
1012
}
1113
export const CircleMarker = React.forwardRef<CircleMarkerProps, CircleMarkerProps>((props, ref) => {
1214
const { circleMarker } = useCircleMarker(props);

‎packages/circle-marker/src/useCircleMarker.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { CircleMarkerProps } from '.';
55

66
export interface UseCircleMarker extends CircleMarkerProps {}
77
export const useCircleMarker = (props = {} as UseCircleMarker) => {
8-
const { visiable, ...other } = props;
8+
const { visiable, visible, ...other } = props;
99
const { map } = useMapContext();
1010
const [circleMarker, setCircleMarker] = useState<AMap.CircleMarker>();
1111
useEffect(() => {
@@ -28,7 +28,7 @@ export const useCircleMarker = (props = {} as UseCircleMarker) => {
2828
}
2929
}, [map]);
3030

31-
useVisiable(circleMarker!, visiable);
31+
useVisiable(circleMarker!, visible ?? visiable);
3232
useSettingProperties<AMap.CircleMarker, UseCircleMarker>(circleMarker!, props, [
3333
'Center',
3434
'Raius',

‎packages/circle/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const Example = () => {
3030
<div style={{ width: '100%', height: '300px' }}>
3131
<Map zoom={14} center={[116.400274, 39.905812]}>
3232
<Circle
33-
visiable={show}
33+
visible={show}
3434
radius={1000}
3535
strokeColor="#fff"
3636
strokeWeight={2}
@@ -57,7 +57,7 @@ export default Mount;
5757

5858
| 参数 | 说明 | 类型 | 默认值 |
5959
|--------- |-------- |--------- |-------- |
60-
| visiable | 覆盖物是否可见。 | `boolean` | - |
60+
| visible | 覆盖物是否可见。 | `boolean` | - |
6161
| radius | 圆半径，单位:米 | `number` | - |
6262

6363
### 事件

‎packages/circle/src/index.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ import { useCircle } from './useCircle';
55
export * from './useCircle';
66

77
export interface CircleProps extends OverlayProps, AMap.CircleEvents, AMap.CircleOptions {
8-
/** 覆盖物是否可见 */
8+
/** @deprecated use `visible` */
99
visiable?: boolean;
10+
/** 覆盖物是否可见 */
11+
visible?: boolean;
1012
}
1113
export const Circle = React.forwardRef<CircleProps, CircleProps>((props, ref) => {
1214
const { circle } = useCircle(props);

‎packages/circle/src/useCircle.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { CircleProps } from '.';
55

66
export interface UseCircle extends CircleProps {}
77
export const useCircle = (props = {} as UseCircle) => {
8-
const { visiable, ...other } = props;
8+
const { visiable, visible, ...other } = props;
99
const { map } = useMapContext();
1010
const [circle, setCircle] = useState<AMap.Circle>();
1111
useLayoutEffect(() => {
@@ -20,7 +20,7 @@ export const useCircle = (props = {} as UseCircle) => {
2020
}
2121
}, [map]);
2222

23-
useVisiable(circle!, visiable);
23+
useVisiable(circle!, visible ?? visiable);
2424
useSettingProperties<AMap.Circle, UseCircle>(circle!, props, ['Center', 'Raius', 'Options', 'ExtData']);
2525
useEventProperties<AMap.Circle, UseCircle>(circle!, props, [
2626
'onHide',

‎packages/control-bar-control/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ const Demo = () => {
3030
<div style={{ width: '100%', height: '300px' }}>
3131
<Map>
3232
<ControlBarControl
33-
visiable={show}
33+
visible={show}
3434
offset={[30, 10]}
3535
position="RT"
3636
/>
3737
{show && (
3838
<ControlBarControl
39-
visiable={show}
39+
visible={show}
4040
offset={[10, 10]}
4141
position="RB"
4242
/>
@@ -60,6 +60,6 @@ export default Mount;
6060

6161
| 参数 | 说明 | 类型 | 默认值 |
6262
| ----- | ----- | ----- | ----- |
63-
| visiable | 覆盖物是否可见。 | `boolean` | - |
63+
| visible | 覆盖物是否可见。 | `boolean` | - |
6464
| position | 控件停靠位置 `{ top: 5; left: 5; right: 5; bottom: 5 }` 或者 'LT': 左上角, 'RT': 右上角, 'LB': 左下角, 'RB': 右下角。 | `string| object` | - |
6565
| offset | 相对于地图容器左上角的偏移量，正数代表向右下偏移。默认为 `AMap.Pixel(10,10)` | `[number, number]` | - |

0 commit comments

Comments
 (0)