extra-react-hooks 0.1.5 → 0.1.9

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [0.1.9](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.8...v0.1.9) (2021-12-13)
+
+
+### Features
+
+* add useFiniteStateMachine ([e6e8962](https://github.com/BlackGlory/extra-react-hooks/commit/e6e8962724774a8b217a1fd5332c13ba4ee051f7))
+
+### [0.1.8](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.7...v0.1.8) (2021-12-13)
+
+
+### Features
+
+* add useForceUpdate ([f747227](https://github.com/BlackGlory/extra-react-hooks/commit/f747227c02c5bb2f0a0f1889de1c022bc9ca1e4d))
+
+### [0.1.7](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.6...v0.1.7) (2021-12-10)
+
+
+### Features
+
+* add useStep ([f404846](https://github.com/BlackGlory/extra-react-hooks/commit/f4048462cc254499d7fd06cd51e16e98acd978ca))
+
+### [0.1.6](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.5...v0.1.6) (2021-11-15)
+
+
+### Features
+
+* add useResizeObserver ([8a4e317](https://github.com/BlackGlory/extra-react-hooks/commit/8a4e317921387fa26e768796e52c8fe44e9b347e))
+
+### [0.1.5](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.4...v0.1.5) (2021-10-04)
+
+
+### Features
+
+* add useIncrement ([e5f1fc4](https://github.com/BlackGlory/extra-react-hooks/commit/e5f1fc442a2c69aa490fed873cc21fe4ad9ff76b))
+
+### [0.1.4](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.3...v0.1.4) (2021-08-18)
+
+
+### Features
+
+* add useIsMounted ([32a1295](https://github.com/BlackGlory/extra-react-hooks/commit/32a12951aab92ae5734f4caddf45021e2bbed793))
+
+### [0.1.3](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.2...v0.1.3) (2021-08-18)
+
+
+### Features
+
+* add useStateCycle ([a48da21](https://github.com/BlackGlory/extra-react-hooks/commit/a48da211f364688daa63a0bd5406fa2f2c61eba7))
+
+### [0.1.2](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.1...v0.1.2) (2021-07-03)
+
+### [0.1.1](https://github.com/BlackGlory/extra-react-hooks/compare/v0.1.0...v0.1.1) (2021-06-29)
+
+
+### Features
+
+* add useMount ([070045a](https://github.com/BlackGlory/extra-react-hooks/commit/070045ac0f209712eadd0f4e79c1328d20745b04))
+
+## 0.1.0 (2021-06-04)
+
+
+### Features
+
+* add useToggle, useSingleSelection ([0b9ee92](https://github.com/BlackGlory/extra-react-hooks/commit/0b9ee92597a230989b51b7242f529f0a36590d1f))

package/README.md

@@ -1,7 +1,5 @@
 # extra-react-hooks
-
 ## Install
-
 ```sh
 npm install --save extra-react-hooks
 # or
@@ -9,15 +7,12 @@ yarn add extra-react-hooks
 ```
 
 ## API
-
 ### useToggle
-
 ```ts
 function useToggle(initialState: boolean = false): [on: boolean, toggle: () => void]
 ```
 
 ### useSingleSelection
-
 ```ts
 interface IOption<T> {
   value: T
@@ -37,13 +32,11 @@ function useSingleSelection<T>(values: T[]): {
 ```
 
 ### useMount
-
 ```ts
 function useMount(effect: EffectCallback): void
 ```
 
 ### useStateCycle
-
 ```ts
 function useStateCycle<T>(
   stateList: [T, ...T[]]
@@ -52,15 +45,46 @@ function useStateCycle<T>(
 ```
 
 ### useIsMounted
-
 ```ts
 function useIsMounted(): () => boolean
 ```
 
 ### useIncrement
-
 ```ts
 function useIncrement(
   initialValue: number
 ): [value: number, increment: (step?: number) => void, reset: () => void]
 ```
+
+### useResizeObserver
+```ts
+function useResizeObserver(
+  callback: ResizeObserverCallback
+, refs: Array<RefObject<HTMLElement> | MutableRefObject<HTMLElement>>
+): void
+```
+
+### useStep
+```ts
+function useStep<T>(
+  steps: [T, ...T[]]
+, initialStepIndex: number = 0
+): [currentStep: T, next: () => void, previous: () => void]
+```
+
+### useForceUpdate
+```ts
+function useForceUpdate(): () => void
+```
+
+### useFiniteStateMachine
+```ts
+function useFiniteStateMachine<State extends string, Event extends string>(
+  schema: IFiniteStateMachineSchema<State, Event>
+, initialState: State
+): ObservableFiniteStateMachine<State, Event>
+```
+
+The `ObservableFiniteStateMachine` comes from [@blackglory/structures].
+
+[@blackglory/structures]: https://www.npmjs.com/package/@blackglory/structures