React Utilities
React Utilities to speed up and simplify development π
The goal of the project is to provide everyday components, in example window scroll detection, to speed up and simplify React development with little to no extra boilerplate code. In this eco-system/monorepo, everyday React utilities can be implemented and tested so that users of this repository's utilities can use the provided utilities with confidence and without much thought.
Usage
In this section, how to use specific React Utilities will be supplied.
import { SomeReactUtility } from '@react-utilities/some-react-utility
const SomeReactComponent: FunctionComponent<SomeReactComponentProps> = (): JSX.Element =>
(<SomeReactUtility><p>Foo</p></SomeReactUtility>)
Development
Listed below are steps and commands for developing new React Utilities or fixing/updating current react utilities.
Commands
Commands for developing React Utilities
build
: builds all packages in parallelclean
: cleans up all build files for all packagesci
: shortcut command to run CI-friendly conformance checks forlint
,typescript
checks, andtest
slint
: runs lint and auto-fixes code if necessarytest
: runs all tests- Shortcut for
jest
. You can pass anyjest
CLI flags to this command like--watch
- Shortcut for
tsc
: runs anoEmit
Typescript check across all files.
Thanks
This project is being built referencing Paul Armstrong's Monorepo TS with additions for react development supplied by me, Jeff Wainwright.