feat: rename useControlledValue to useControllableValue (#99)

* feat: rename useControlledValue to useControllableValue

Author: brickspert

src/index.ts

@@ -3,21 +3,29 @@ import useAPI, { configRequest } from './useAPI';
 import useAsync from './useAsync';
 import useLoadMore from './useLoadMore';
 import useSearch from './useSearch';
-import useControlledValue from './useControlledValue';
+import useControllableValue from './useControllableValue';
 import useDynamicList from './useDynamicList';
 import useEventEmitter from './useEventEmitter';
 import useVirtualList from './useVirtualList';
 import { configResponsive, useResponsive } from './useResponsive';
 import useSize from './useSize';
 import useLocalStorageState from './useLocalStorageState';
 
+const useControlledValue: typeof useControllableValue = function (...args) {
+  console.warn(
+    'useControlledValue is deprecated and will be removed in the next major version. Please use useControllableValue instead.',
+  );
+  return useControllableValue(...args);
+};
+
 export {
   useAntdTable,
   useAPI,
   useAsync,
   useLoadMore,
   useSearch,
   useControlledValue,
+  useControllableValue,
   useDynamicList,
   useVirtualList,
   useResponsive,

…eControlledValue/__tests__/index.test.ts …ontrollableValue/__tests__/index.test.tssrc/useControlledValue/__tests__/index.test.ts renamed to src/useControllableValue/__tests__/index.test.ts src/useControlledValue/__tests__/index.test.ts renamed to src/useControllableValue/__tests__/index.test.ts

@@ -1,14 +1,14 @@
 import { renderHook, act } from '@testing-library/react-hooks';
 import { useCallback } from 'react';
-import useControlledValue, { Options, Props } from '../index';
+import useControllableValue, { Options, Props } from '../index';
 
-describe('useControlledValue', () => {
+describe('useControllableValue', () => {
   it('should be defined', () => {
-    expect(useControlledValue).toBeDefined();
+    expect(useControllableValue).toBeDefined();
   });
 
   const setUp = (props?: Props, options?: Options): any =>
-    renderHook(() => useControlledValue(props, options));
+    renderHook(() => useControllableValue(props, options));
 
   it('defaultValue should work', () => {
     const hook = setUp({ defaultValue: 1 });

src/useControlledValue/index.mdx src/useControllableValue/index.mdxsrc/useControlledValue/index.mdx renamed to src/useControllableValue/index.mdx

@@ -1,17 +1,17 @@
 ---
-name: useControlledValue
-route: /useControlledValue
+name: useControllableValue
+route: /useControllableValue
 menu: '中台 hooks'
 edit: false
 sidebar: true
 ---
 
 import { Playground } from 'docz';
-import useControlledValue from './index';
+import useControllableValue from './index';
 import { useState } from 'react';
 import { InputNumber, Button } from 'antd';
 
-# useControlledValue
+# useControllableValue
 
 一个帮你处理受控组件中受控值的 Hook。
 
@@ -22,7 +22,7 @@ import { InputNumber, Button } from 'antd';
   ()=>{
 
     const ControlledComponent = (props) => {
-      const [state, setState] = useControlledValue(props);
+      const [state, setState] = useControllableValue(props);
 
       return (
         <InputNumber
@@ -68,7 +68,7 @@ import { InputNumber, Button } from 'antd';
 ## API
 
 ```
-const [state, setState] = useControlledValue(params);
+const [state, setState] = useControllableValue(params);
 
 params:(
   props: object;

src/useControlledValue/index.ts src/useControllableValue/index.tssrc/useControlledValue/index.ts renamed to src/useControllableValue/index.ts

@@ -11,7 +11,7 @@ export interface Props {
   [key: string]: any;
 }
 
-export default function useControlledValue<T>(props: Props = {}, options: Options = {}) {
+export default function useControllableValue<T>(props: Props = {}, options: Options = {}) {
   const {
     defaultValuePropName = 'defaultValue',
     valuePropName = 'value',