All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Create package.json
- Setup .gitignore
- Add a CHANGELOG.md
- Add a Readme.md and a Contributing.md
- Add Styleguidist
- Add ESLint
- Add Stylelint
- Tests
- Build System
- useCallbackRef hook & tests
- useDidMount hook & tests
- useWillUnmount hook & tests
- useLifecycle hook & tests
- useWindowResize hook & tests
- Auto-generating documentation script
- useDebouncedFn hook & tests
- useMouseEvents hook & tests
- useMouseState hook & tests
- useMouse hook & tests
- Adding babel-plugin-istanbul to solve this issue with istanbul/nyc
- Adding playground build as a gitpages website
- Adding better documentation
- useInterval hook & tests
- useTimeout hook & tests
- Build workflow performs tests twice
- useThrottledFn hook & tests
- debounce and throttle utilities
- useWindowScroll hook & tests
- useGlobalEvent hook & tests
- Few documentation typos
- Few documentation typos
- README image
- Types support
- Few documentation typos
- usePreviousValue hook & tests
- peerDependencies
- build was missing
- usePreviousValue types were missing
- React & ReactDom moved to
devDependencies
- Package name for public usage
- Code of conduct
- Contributing guidelines
- issue template
- pull request template
- correct package.json version
- dependencies update
- Rewriting
useMouseHandler
intouseMouseEvents
- documentation typos
- documentation typos
- useGeolocationEvents hook & tests
- useGeolocationState hook & tests
- useGeolocation hook & tests
- useMediaQuery hook & tests
- change the order of the listed hooks into the Readme.md file
useOnMount
renamed touseDidMount
- Usage example image
- improved
useCallbackRef
documentation - changed lib logo
- removed wrong
useCallbackRef
dependencies - dependency check on other event related hooks
- Switching CI to Travis
- useTimeout refactory
- few hooks refactory
- Improved documentation by a better use of Styleguidist
- Improved types
usePrev
renamed tousePreviousValue
- Fix on
usePreviousValue
type
- Fixing CI
- useValueHistory hook & tests
- useOnlineState hook
- Repository ownership changed from
antonioru
tobeautifulinteractions
- useViewportSpy hook & tests
- Improved documentation
- types reference into package.json
- Fixed license in package.json
- useDragEvents hook & tests
- useDrag hook
- event handlers uses the right parameters and avoid using (...args)
useCallbackRef
has been reverted to an internal utility
- Build removed from the source package
- useOnlineState returns true when the device does not support the
online/offline
state assuming the app is already online - Improved test
- useConditionalTimeout hook & tests
- adding react and react-dom as dev-dependencies
- adding types for useConditionalTimeout
- Updated typings for cancelable functions. Updated docs.
- Support windows. Add .npmrc for saving exact version of dependencies
- Updating dependencies
- Improving documentation by using
beautiful-react-ui
components
- useValidatedState hook & tests
- Adding useValidatedState into README.md
- Rewriting README.md
- Moved beautiful-react-ui from dependencies to dev-dependencies
- useRequestAnimationFrame hook & tests
- Fix isSupported when window is not defined to allow SSR
- useLocalStorage hook & tests & docs & types
- improving SSR check and window.* check before usage
- adding SSR warning to
useRequestAnimationFrame
- improving
useLocalStorage
documentation
- dependencies update
- Adding Chinese translation of README.md
- Fixing missing links between README.md files
- Adding Italian translation of README.md
- Fixing missing image links in italian Readme.md
- Adding Spanish translation of README.md
- Adding Ukranian translation of README.md
- Fixing package version
- Adding Polish translation of README.md
- Fixing Polish translation of README.md
- Fixing links to hooks in language specific README files
- useDropZone hook & tests
- Fixing links in Contributing section and minor typos in language specific README files
- useStorage hook & tests
- adding SSR warning to
useLocalStorage
hook - adding warning to
useLocalStorage
hook iflocalStorage
is not inwindow
object - adding new test for
useLocalStorage
hook that checks thatlocalStorage
inwindow
object
- Improved build system by removing gulp and introducing rollup
- tests directory from
src
totests
- Dependencies updated
- Tests improved by running them from the dist folder
- Fixed double
npm run build-doc
script run before deploy
- Type declaration fix for
useDebouncedFn
anduseThrottledFn
- useInterval, clear the previous interval when the milliseconds value changes.
- Introducing ESModules build
module
property added topackage.jsoin
to support ESModules
- useSessionStorage hook & documentation
- useStorage refactory
- useStorage types refactory
- useResizeObserver hook & documentation
- useStorage throws an error on server side rendering as the window object is not defined yet
- useInterval clear function is now correctly used as useEffect cleanup
- Rollup configuration
preserveModules
bug
- useTimeout clear function is now correctly used as useEffect cleanup
- CI minor issues
useValueHistory
can now be used with distinct history
- dependencies update
- CI minor issues
useDefaultedState
hook and tests
useObservable
hook and tests
- CI minor issues
useSystemVoices
hook and testsuseSpeechSynthesis
hook and tests
useLocalStoreage
types fix
- Better dist package
- CI bugfix
- Wrong path settings in package.json causes the library to be empty
- Wrong CI settings causes the library to be empty
- Webpack 5 error with the
isDevelopment
constant
useRenderInfo
hook and tests
- Support for SSR in
isAPISupport
- Documentation link
useTouchEvents
,useTouchState
hookuseSwipe
,useHorizontalSwipe
anduseVerticalSwipe
hook
useMouseEvents
flaws- improved docs
useConditionalTimeout
hook
useSwipe
typings
useConditionalTimeout
hook
useSwipeEvents
hook
- typings module
useSwipe
types
- converted
HandlerSetter
type to better generic type
useSwipeEvents
swipe performing only once in the same direction
HandlerSetter
types a function taking another function as parameter
- index exports
useHorizontalSwipe
anduseVerticalSwipe
useSwipeEvents
exportsonSwipeMove
useMediaQuery
addEventListener bug
- removed useless console.log from
useSwipe
useSwipeEvents
exportsonSwipeEnd
,onSwipeStart
- Complete typescript rewrite
- Changing to the handler function do not cause the handler setter refs to update
- Updating useGlobalEvent ref to the provided function
- Updating useValueHistory's misuse of Array.prototype.filter to update history.current
- Type definitions on useResizeObserver
- Refs are typed as RefObject, which is more correct as they are React-managed refs.
useDebouncedFn
anduseThrottledFn
refs
- rewriting
useDebouncedFn
anduseThrottledFn
asuseDebouncedCallback
anduseThrottledCallback
useDebouncedCallback
anduseThrottledCallback
improvements
- Reverted rewrite of
useDebouncedFn
anduseThrottledFn
, as they were breaking changes. Will release those as2.0.0
.
- rewriting
useDebouncedFn
anduseThrottledFn
asuseDebouncedCallback
anduseThrottledCallback
- BREAKING CHANGE useDebouncedCallback
anduseThrottledCallback
improvements
- fixes useConditionalTimeout clearing function
- introduces
useInfiniteScroll
- rewrite of useEvent and useGlobalEvent as well as the hooks using those
- introduces
useViewportState
- fix(release): updates release process and changelog
Errored release
Errored release
- Fixes CI, semantic-release
- fix(useQueryParam): revert to version 5 of react-router-dom
- useQueryParams, adds support for param deletion
- useQueryParams, adds support for param deletion
- useQueryParams types
- CI
- feat(useQueryParams): adds useQueryParams
- feat(useQueryParams): adds useQueryParams
- useQueryParams and useQueryParam state bugs
- feat(timeouts): increase the general timeout/delay value
- feat(hook): introduces useURLSearchParams
- error handling for useStorage hook
- add more types for useStorage hook, fix bug where storage wasn't being set on initial render
- wrap setValue from useStorage hook in useCallback to persist reference
- wrap setValue from useSt
- useCookie hook
- wraps useStorage's setValue in a useCallback hook
- useTimeout return type
- moves type checking functions into a separate utility
- allow user to pass 'passive' flag events-related hooks
- Improves 'passive' events flag
- useAudio hook
- useDarkMode hook
- useToggle hook
- useToggle types
warnOnce
function to make sure the warning messages are displayed only once
- improve
useInfiniteScroll
code
- Fixes
useInfiniteScroll
not working on Windows machines
- Fixes
useInfiniteScroll
console.error message
useLocalStorage
anduseSessionStorage
no longer return a newsetValue
function everytimesetValue
is called
- Removes
index.ts
file fromsrc
folder - Updates dependencies
- Improves documentation
- Improves types
useMutableState
hook
- wrong dependency in package.json
useLongPress
hook
- Deprecated GitHub actions version
- package.json specifiers (exports)
useSpeechRecognition
hook