extra-react-hooks 0.2.0 → 0.3.1

package/README.md

@@ -7,6 +7,12 @@ yarn add extra-react-hooks
 ```
 
 ## API
+```ts
+interface IOptionState {
+  selected: boolean
+}
+```
+
 ### useToggle
 ```ts
 function useToggle(initialState: boolean = false): [on: boolean, toggle: () => void]
@@ -14,45 +20,27 @@ function useToggle(initialState: boolean = false): [on: boolean, toggle: () => v
 
 ### useSingleSelection
 ```ts
-interface ISingleSelectionOption<T> {
-  value: T
-  index: number
-  selected: boolean
-
-  select(): void
-}
-
 function useSingleSelection<T>(
-  values: T[]
+  options: NonEmptyArray<T>
 , defaultSelectedIndex: number
 ): {
-  selectedValue: T
-  options: Array<ISingleSelectionOption<T>>
-}
-function useSingleSelection<T>(values: T[]): {
-  selectedValue: T | undefined
-  options: Array<ISingleSelectionOption<T>>
+  selectedIndex: number
+  optionStates: IOptionState[]
+  select: (index: number) => void
 }
 ```
 
 ### useMultipleSelection
 ```ts
-interface IMultipleSelectionOption<T> {
-  value: T
-  index: number
-  selected: boolean
-
-  select(): void
-  unselect(): void
-  toggle(): void
-}
-
 function useMultipleSelection<T>(
-  values: T[]
+  options: NonEmptyArray<T>
 , defaultSelectedIndexes: number[] = []
 ): {
-  selectedValues: T[]
-  options: Array<IMultipleSelectionOption<T>>
+  selectedIndexes: number[]
+  optionStates: IOptionState[]
+  toggle: (index: number) => void
+  select: (index: number) => void
+  unselect: (index: number) => void
 }
 ```
 
@@ -61,6 +49,11 @@ function useMultipleSelection<T>(
 function useMount(effect: EffectCallback): void
 ```
 
+### useUnmount
+```ts
+function useUnmount(effect: () => void): void 
+```
+
 ### useUpdateEffect
 ```ts
 function useUpdateEffect(
@@ -72,7 +65,7 @@ function useUpdateEffect(
 ### useStateCycle
 ```ts
 function useStateCycle<T>(
-  stateList: [T, ...T[]]
+  orderedStates: NonEmptyArray<T>
 , initialStateIndex: number = 0
 ): [state: T, next: () => void]
 ```
@@ -105,7 +98,7 @@ function useResizeObserver(
 ### useStep
 ```ts
 function useStep<T>(
-  steps: [T, ...T[]]
+  steps: NonEmptyArray<T>
 , initialStepIndex: number = 0
 ): [currentStep: T, next: () => void, previous: () => void]
 ```
@@ -131,3 +124,8 @@ The `ObservableFiniteStateMachine` comes from [@blackglory/structures].
 ```ts
 function useRenderCounter(): number
 ```
+
+### useIIFE
+```ts
+function useIIFE(iife: () => void, deps: React.DependencyList): void
+```