diff --git a/README.md b/README.md index 18f94632..099eac45 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ [![][npm-badge]][npm-url] [![][travis-badge]][travis-url] -React standard library, must-have toolbox for any React project. +React standard library — must-have toolbox for any React project. - - Collection of React sensors, FaCCs, HOCs, context providers, dummies, and [other goodies](#contents). - - Isomorphic - all components work in browser and on server (and some in `react-native`). + - Collection of React sensors, FaCCs, render props, HOCs, context providers, dummies, and [other goodies](#contents). + - *Isomorphic* - all components work in browser and on server (and some in `react-native`). - See [demos](https://mailonline.github.io/libreact/) and [docs](#contents). ## Installation @@ -28,44 +28,57 @@ const MyComponent = mock(); ## Contents - - Dummies - - [`mock()`](./docs/mock.md) - - [`loadable()`](./docs/loadable.md) - - [`lazy()`](./docs/lazy.md) - - [`delayed()`](./docs/delayed.md) - - [`invert()`](./docs/invert.md) - - Sensors + - [Introduction](./docs/Introduction.md) + - [Dummies](./docs/Dummies.md) + - [`mock()`](./docs/mock.md) and [`loadable()`](./docs/loadable.md) + - [`lazy()`](./docs/lazy.md), [`delayed()`](./docs/delayed.md), and [`viewport()`](./docs/viewport.md) + - [Inversion](./docs/Inversion.md) + - [`invert()`](./docs/invert.md) and [``](./docs/invert.md#inverted) + - [``](./docs/State.md) and [`withState()`](./docs/State.md#withstate-hoc) + - [``](./docs/Toggle.md), [`withToggle()`](./docs/Toggle.md#withtoggle-hoc), and [`@withToggle`](./docs/Toggle.md#withtoggle-decorator) + - [``](./docs/Flipflop.md), [`withFlipflop()`](./docs/Flipflop.md#withflipflop-hoc), and [`@withFlipflop`](./docs/Flipflop.md#withflipflop-decorator) + - [``](./docs/Value.md), [`withValue()`](./docs/Value.md#withvalue-hoc), and [`@withValue`](./docs/Value.md#withvalue-decorator) + - [``](./docs/Counter.md), [`withCounter()`](./docs/Counter.md#withcounter-hoc) and [`@withCounter`](./docs/Counter.md#withcounter-decorator) + - [``](./docs/List.md), [`withList()`](./docs/List.md#withlist-hoc), and [`@withList`](./docs/List.md#withlist-decorator) + - [``](./docs/Map.md), [`withMap()`](./docs/Map.md#withmap-hoc), and [`@withMap`](./docs/Map.md#withmap-decorator) + - [Context](./docs/Context.md) + - [``](./docs/Provider.md#provider), [``](./docs/Provider.md#consumer), [`withContext()`](./docs/Provider.md#withcontext), and `@withContext` + - [``](./docs/theme.md#theme), [``](./docs/theme.md#themed), [`withTheme()`](./docs/theme.md#withtheme), and `@withTheme` + - `` + - [``](./docs/route.md#router), [``](./docs/route.md#route), [`withRoute()`](./docs/route.md#withroute), `@withRoute`, `go()`, and `` + - [``](./docs/translate.md#translations), [``](./docs/translate.md#translate-or-t), [``](./docs/translate.md#translate-or-t), [`withT()`](./docs/translate.md#witht-hoc), and [`@withT`](./docs/translate.md#witht-decorator) + - [Sensors](./docs/Sensors.md) - [``](./docs/BatterySensor.md), [`withBattery()`](./docs/BatterySensor.md#withbattery), and [`@withBattery`](./docs/BatterySensor.md#withbattery-1) + - [``](./docs/GeoLocationSensor.md), [`withGeoLocation()`](./docs/GeoLocationSensor.md#withgeolocation-hoc), and [`@withGeoLocation`](./docs/GeoLocationSensor.md#withgeolocation-decorator) + - [``](./docs/HoverSensor.md), [`withHover()`](./docs/HoverSensor.md#withhover-hoc), and [`@withHover`](./docs/HoverSensor.md#withhover-decorator) - [``](./docs/MediaDeviceSensor.md), [`withMediaDevices()`](./docs/MediaDeviceSensor.md#withmediadevices), and [`@withMediaDevices`](./docs/MediaDeviceSensor.md#withmediadevices-1) - [``](./docs/MediaSensor.md), [`withMedia()`](./docs/MediaSensor.md#withmedia), and [`@withMedia`](./docs/MediaSensor.md#withmedia-1) - - [``](./docs/NetworkSensor.md) and [`withNetwork()`](./docs/NetworkSensor.md#withnetwork) - - [``](./docs/LightSensor.md) - - [``](./docs/LocationSensor.md) - - [``](./docs/OrientationSensor.md) and [`withOrientation()`](./docs/OrientationSensor.md#withorientation) + - [``](./docs/MotionSensor.md), [`withMotion()`](./docs/MotionSensor.md#withmotion-hoc), and [`@withMotion`](./docs/MotionSensor.md#withmotion-decorator) + - [``](./docs/MouseSensor.md), [`withMouse()`](./docs/MouseSensor.md#withmouse-hoc), and [`@withMouse`](./docs/MouseSensor.md#withmouse-decorator) + - [``](./docs/NetworkSensor.md), [`withNetwork()`](./docs/NetworkSensor.md#withnetwork-hoc), and [`@withNetwork`](./docs/NetworkSensor.md#withnetwork-decorator) + - [``](./docs/LightSensor.md), [`withLight()`](./docs/LightSensor.md#withlight-hoc), and [`@withLight`](./docs/LightSensor.md#withlight-decorator) + - [``](./docs/LocationSensor.md), [`withLocation()`](./docs/LocationSensor.md#withlocation-hoc), and [`@withLocation`](./docs/LocationSensor.md#withlocation-decora) + - [``](./docs/OrientationSensor.md), [`withOrientation()`](./docs/OrientationSensor.md#withorientation-hoc), and [`@withOrientation`](./docs/OrientationSensor.md#withorientation-decorator) - [``](./docs/ScrollSensor.md) - - [``](./docs/SizeSensor.md) - - [``](./docs/ViewportSensor.md), [``](./docs/ViewportSensor.md#viewportscrollsensor), and [``](./docs/ViewportSensor.md#viewportobserversensor) - - [``](./docs/WidthSensor.md) - - [``](./docs/WindowScrollSensor.md) - - [``](./docs/WindowSizeSensor.md) + - [``](./docs/SizeSensor.md), [`withSize()`](./docs/SizeSensor.md#withsize-hoc), and [`@withSize`](./docs/SizeSensor.md#withsize-decorator) + - [``](./docs/WidthSensor.md), [`withWidth()`](./docs/WidthSensor.md#withwidth-hoc-and-withwidth-decorator), and [`@withWidth`](./docs/WidthSensor.md#withwidth-hoc-and-withwidth-decorator) + - [``](./docs/ViewportSensor.md), [`withViewport()`](./docs/ViewportSensor.md#withviewport-hoc), and [`@withViewport`](./docs/ViewportSensor.md#withviewport-decorator) + - [``](./docs/ViewportSensor.md#viewportscrollsensor) and [``](./docs/ViewportSensor.md#viewportobserversensor) + - [``](./docs/WindowScrollSensor.md), [`withWindowScroll()`](./docs/WindowScrollSensor.md#withwindowscroll-hoc), and [`@withWindowScroll`](./docs/WindowScrollSensor.md#withwindowscroll-decorator) + - [``](./docs/WindowSizeSensor.md), [`withWindowSize()`](./docs/WindowSizeSensor.md#withwindowsize-hoc), and [`@withWindowSize`](./docs/WindowSizeSensor.md#withwindowsize-decorator) + - `ActiveSensor`, `withActive()`, and `@withActive` + - `FocusSensor`, `withFocus()`, and `@withFocus` - Generators - - [``](./docs/Alert.md) - [`