Skip to content

connect-dot/ui-hooks

Repository files navigation

npm version License: MIT GitHubstar GitHub watchers

Maintainability Test Coverage

GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests

This is react custom hook library for web action like scroll lock, to use media query.

The goal for this project is to make custom hook which is useful to deal with ui action. When I develop some web ui, there is some problem which to make some component. For example, The component which need to change based on media query have got on my nerves.

I hope this project is useful for solving that kind of problem.

API

API Result Parameter Description
useMediaQuery(config, initial) [mediaType, error] config : { key : string }, initial : string get Media Query from config.
useScrollLock(on) void on : boolean scrollLock when some component is visible
useColorPick(image, position, initColor?) {color, loading} `image: string File, position : { x: number, y: number }, initColor: string`