Skip to content

Commit

Permalink
docs: add <AfterTimeout> reference
Browse files Browse the repository at this point in the history
  • Loading branch information
streamich committed Feb 24, 2018
1 parent 436cdc9 commit ca1c2ee
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ const MyComponent = mock();
- [`<Ripple>`](./docs/en/Ripple.md) and [`withRipple()`](./docs/en/Ripple.md#withripple) &mdash; [**example**](https://codesandbox.io/s/983q7jr80o)
- [`<Audio>`](./docs/en/Audio.md) and [`<Video>`](./docs/en/Video.md)
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md), `<Prompt>`, `<Confirm>`
- [Animation](./docs/en/Animation.md)
- [`<AfterTimeout>`](./docs/en/AfterTimeout.md), [`<AfterDraf>`](./docs/en/AfterDraf.md), and [`<WhenIdle>`](./docs/en/WhenIdle.md)
- [`<Render>`](./docs/en/Render.md), [`withRender()`](./docs/en/Render.md#withrender-hoc), and [`@withRender`](./docs/en/Render.md#withrender-decorator)
- [`<RenderInterval>`](./docs/en/RenderInverval.md), [`withRenderInterval()`](./docs/en/RenderInverval.md#withrenderinterval-hoc), and [`@withRenderInterval`](./docs/en/RenderInverval.md#withrenderinterval-decorator)
- [`<Tween>`](./docs/en/Tween.md), [`withTween()`](./docs/en/Tween.md#withtween-hoc), and [`@withTween`](./docs/en/Tween.md#withtween-decorator)
- [`<Interpolation>`](./docs/en/Interpolation.md), [`withInterpolation()`](./docs/en/Interpolation.md#withinterpolation-hoc), and [`@withInterpolation`](./docs/en/Interpolation.md#withinterpolation-decorator)
- [Side Effects](./docs/en/Side-effects.md)
- [`<LocalStorage>`](./docs/en/LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
- `<Title>`, `<Favicon>`
Expand Down
20 changes: 20 additions & 0 deletions docs/en/AfterTimeout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# `<AfterTimeout>`

Renders its children only after a specified timeout. Useful to
improving perceived performance by not blocking the main event loop.


## Usage

```jsx
import {AfterTimeout} from 'libreact/lib/AfterTimeout';

<AfterTimeout ms={100}>
Hello world!
</AfterTimeout>
```


## Props

- `ms` &mdash; optional, number, time in milliseconds after which to render children, defaults to `200`.
6 changes: 6 additions & 0 deletions docs/en/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@
- [`<Ripple>`](./Ripple.md) and [`withRipple()`](./Ripple.md#withripple) &mdash; [**example**](https://codesandbox.io/s/983q7jr80o)
- [`<Audio>`](./Audio.md) and [`<Video>`](./Video.md)
- [`<Speak>`](./Speak.md), [`<Vibrate>`](./Vibrate.md), [`<Alert>`](./Alert.md), `<Prompt>`, `<Confirm>`
- [Animation](./Animation.md)
- [`<AfterTimeout>`](./AfterTimeout.md), [`<AfterDraf>`](./AfterDraf.md), and [`<WhenIdle>`](./WhenIdle.md)
- [`<Render>`](./Render.md), [`withRender()`](./Render.md#withrender-hoc), and [`@withRender`](./Render.md#withrender-decorator)
- [`<RenderInterval>`](./RenderInverval.md), [`withRenderInterval()`](./RenderInverval.md#withrenderinterval-hoc), and [`@withRenderInterval`](./RenderInverval.md#withrenderinterval-decorator)
- [`<Tween>`](./Tween.md), [`withTween()`](./Tween.md#withtween-hoc), and [`@withTween`](./Tween.md#withtween-decorator)
- [`<Interpolation>`](./Interpolation.md), [`withInterpolation()`](./Interpolation.md#withinterpolation-hoc), and [`@withInterpolation`](./Interpolation.md#withinterpolation-decorator)
- [Side Effects](./Side-effects.md)
- [`<LocalStorage>`](./LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
- `<Title>`, `<Favicon>`
Expand Down
8 changes: 8 additions & 0 deletions docs/en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,14 @@
* [Alert](Alert.md)
* [Sms](Sms.md)
* [Mailto](Mailto.md)
* [Animation](Animation.md)
* [AfterTimeout](AfterTimeout.md)
* [AfterDraf](AfterDraf.md)
* [WhenIdle](WhenIdle.md)
* [Render](Render.md)
* [RenderInterval](RenderInterval.md)
* [Tween](Tween.md)
* [Interpolation](Interpolation.md)
* [Side Effects](Side-effects.md)
* [LocalStorage](LocalStorage.md)
* [Boundaries](Boundaries.md)
Expand Down
9 changes: 9 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,14 @@ export * from './FullScreen';
export * from './Ripple';
export * from './Slider';

// Animation
export * from './AfterTimeout';
export * from './AfterDraf';
export * from './WhenIdle';
export * from './Render';
export * from './RenderInterval';
export * from './Tween';
export * from './Interpolation';

// Other
export * from './Resolve';

0 comments on commit ca1c2ee

Please sign in to comment.