chore: add use.uncontrolled / use.valuesstate

Author: imcuttle

README.md

@@ -59,6 +59,8 @@ should be named as `use.{{lowerCase}}`, eg. `@rp/use.i18n`.
 - [@rcp/hoc.uncontrolled](packages/hoc.uncontrolled) - The high order component for creating uncontrolled component  
 - [@rcp/use.i18n](packages/use.i18n) - A react hook for using i18n  
 - [@rcp/use.i18ncontext](packages/use.i18ncontext) - A react hook for using i18n provider/consumer  
+- [@rcp/use.valuesstate](packages/use.valuesstate) - The useful methods exported for values state  
+- [@rcp/use.uncontrolled](packages/use.uncontrolled) - Make props.value piped to state, and exposes `onChange`, make react component is **uncontrolled & controlled**  
 - [@rcp/util.createlogger](packages/util.createlogger) - Create namespace isomorphic logger  
 - [@rcp/util.createmount](packages/util.createmount) - The utility for creating mountable view  
 - [@rcp/util.displayname](packages/util.displayname) - The utility for getting display name  

package-lock.json

@@ -40,6 +40,7 @@
   "devDependencies": {
     "@commitlint/cli": "^7.1.2",
     "@commitlint/config-conventional": "^7.1.2",
+    "@testing-library/react-hooks": "^3.4.1",
     "@types/enzyme": "^3.1.13",
     "@types/jest": "^23.3.1",
     "@types/node": "^10.9.4",
@@ -79,6 +80,7 @@
     "puppeteer": "^2.1.1",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
+    "react-test-renderer": "^16.13.1",
     "rimraf": "^2.6.2",
     "ts-jest": "^23.1.4",
     "ts-loader": "^6.2.2",

package.json

@@ -21,7 +21,7 @@ module.exports = ({ _, name, description }) => {
       dev: 'npm run dist -- -w',
       prepublishOnly: 'npm run dist',
       version: 'npm run doc',
-      doc: 'documentation --markdown-toc=false readme index.js -a public -s "API" && git add README.md'
+      doc: 'documentation --markdown-toc=false readme dist/es/index.js -a public -s "API" && git add README.md'
     },
     repository: {
       type: 'git',

packages/__template/template/package.json.js

@@ -0,0 +1,2 @@
+**/*.js
+!jest.config.js

packages/use.uncontrolled/.gitignore

@@ -0,0 +1,2 @@
+index.ts
+index.tsx

packages/use.uncontrolled/.npmignore

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) imcuttle <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/use.uncontrolled/License

@@ -0,0 +1,55 @@
+# @rcp/use.uncontrolled
+
+[![NPM version](https://img.shields.io/npm/v/@rcp/use.uncontrolled.svg?style=flat-square)](https://www.npmjs.com/package/@rcp/use.uncontrolled)
+[![NPM Downloads](https://img.shields.io/npm/dm/@rcp/use.uncontrolled.svg?style=flat-square&maxAge=43200)](https://www.npmjs.com/package/@rcp/use.uncontrolled)
+
+Make props.value piped to state, and exposes `onChange`, make react component is **uncontrolled & controlled**
+
+## Installation
+
+```bash
+npm install @rcp/use.uncontrolled
+# or use yarn
+yarn add @rcp/use.uncontrolled
+```
+
+## Usage
+
+```javascript
+import useUncontrolled from '@rcp/use.uncontrolled'
+```
+
+## API
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### useUncontrolled
+
+#### Parameters
+
+- `value` {T} - Piped value
+- `defaultValue` {T} - Initialize value firstly
+- `onChange` {(value: T) => void} - Bind `onChange` handler when value updating
+- `useEffect` {typeof React.useLayoutEffect}
+
+#### Examples
+
+```javascript
+function Input({ value, onChangeValue, defaultValue }) {
+  const [valueState, setValue] = useUncontrolled({ value, onChange: onChangeValue, defaultValue })
+
+  return <input type="text" value={valueState} onChange={evt => setValue(evt.target.value)} />
+}
+```
+
+Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** `[T, ((value: T) => T | T) => void]`
+
+## Related
+
+## Authors
+
+This library is written and maintained by imcuttle, <a href="mailto:[email protected]">[email protected]</a>.
+
+## License
+
+MIT

packages/use.uncontrolled/README.md

@@ -0,0 +1,58 @@
+import useUncontrolled from '..'
+import * as TestRenderer from 'react-test-renderer'
+import { renderHook, act } from '@testing-library/react-hooks'
+import * as React from 'react'
+
+describe('useUncontrolled', () => {
+  const Test = React.forwardRef(({ value, defaultValue, onChange }: any, ref) => {
+    const [stateValue, setValue] = useUncontrolled({ value, defaultValue, onChange })
+    React.useImperativeHandle(
+      ref,
+      () => {
+        return {
+          stateValue,
+          setValue
+        }
+      },
+      [stateValue, setValue]
+    )
+
+    return stateValue
+  })
+
+  it('value / props sync', () => {
+    const ref = React.createRef<any>()
+    const onChange = jest.fn(() => {})
+    const testRenderer = TestRenderer.create(<Test ref={ref} onChange={onChange} defaultValue={1} />)
+
+    expect(testRenderer.toJSON()).toMatchInlineSnapshot(`"1"`)
+    expect(ref.current.stateValue).toMatchInlineSnapshot(`1`)
+    expect(onChange).not.toBeCalled()
+
+    // update state inner
+    act(() => {
+      ref.current.setValue(2)
+    })
+    expect(onChange).toBeCalledWith(2)
+    expect(testRenderer.toJSON()).toMatchInlineSnapshot(`"2"`)
+    expect(ref.current.stateValue).toMatchInlineSnapshot(`2`)
+
+    // update state
+    testRenderer.update(<Test ref={ref} onChange={onChange} value={3} />)
+    expect(testRenderer.toJSON()).toMatchInlineSnapshot(`"3"`)
+    expect(ref.current.stateValue).toMatchInlineSnapshot(`3`)
+    expect(onChange).toBeCalledWith(3)
+  })
+
+  it('should do not call onChange firstly', function() {
+    const onChange = jest.fn(() => {})
+    const testRenderer = TestRenderer.create(<Test onChange={onChange} value={1} />)
+    expect(onChange).not.toBeCalled()
+
+    testRenderer.update(<Test onChange={onChange} value={1} />)
+    expect(onChange).not.toBeCalled()
+
+    testRenderer.update(<Test onChange={onChange} value={2} />)
+    expect(onChange).toHaveBeenCalledTimes(1)
+  })
+})

packages/use.uncontrolled/__tests__/spec.test.tsx

@@ -0,0 +1,80 @@
+/**
+ * @file index.ts
+ * @author imcuttle
+ *
+ */
+
+import * as React from 'react'
+
+export function useUncontrolledCore<T = any>(
+  propValue?: T,
+  {
+    initialValue = propValue,
+    useEffect = React.useEffect,
+    onChange
+  }: { initialValue?: T; useEffect?: typeof React.useEffect; onChange?: (value: T) => void } = {}
+): [T | undefined, (newValue: ((value: T) => T) | T) => void] {
+  const [value, setStateValue] = React.useState(initialValue)
+  const setValueFinal = React.useCallback(
+    (newValue: Function | boolean | any) => {
+      if (typeof newValue === 'function') {
+        newValue = newValue(value)
+      }
+      if (value === newValue) {
+        return
+      }
+      setStateValue(newValue)
+      onChange && onChange(newValue)
+    },
+    [value, onChange, setStateValue]
+  )
+
+  useEffect(
+    () => {
+      if (typeof propValue !== 'undefined') {
+        setValueFinal(propValue)
+      }
+    },
+    [propValue, setValueFinal]
+  )
+
+  return [value, setValueFinal]
+}
+
+/**
+ * @public
+ * @name useUncontrolled
+ * @param [value] {T} - Piped value
+ * @param [defaultValue] {T} - Initialize value firstly
+ * @param [onChange] {(value: T) => void} - Bind `onChange` handler when value updating
+ * @param [useEffect] {typeof React.useLayoutEffect}
+ * @returns {Array} `[T, ((value: T) => T | T) => void]`
+ * @example
+ * function Input({value, onChangeValue, defaultValue}) {
+ *   const [valueState, setValue] = useUncontrolled({value, onChange: onChangeValue, defaultValue})
+ *
+ *   return <input type='text' value={valueState} onChange={evt => setValue(evt.target.value)} />
+ * }
+ */
+export default function useUncontrolled<T = any>({
+  value,
+  defaultValue,
+  onChange,
+  useEffect = React.useLayoutEffect
+}: {
+  useEffect?: typeof React.useEffect
+  value?: T
+  defaultValue?: T
+  onChange?: (value: T) => void
+}) {
+  let initialValue = value
+  if (defaultValue) {
+    initialValue = typeof value === 'undefined' ? defaultValue : value
+  }
+
+  return useUncontrolledCore<T>(value, {
+    initialValue,
+    useEffect,
+    onChange
+  })
+}