Skip to content

Commit daf6f2b

Browse files
committed
docs: ✏️ improve router docs
1 parent 35f863a commit daf6f2b

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -89,18 +89,17 @@ const MyComponent = mock();
8989
- [`<Img>`](./docs/en/Img.md)
9090
- [`<WidthQuery>`](./docs/en/WidthQuery.md), [`<View>`](./docs/en/View.md), [`<WindowWidthQuery>`](./docs/en/WindowWidthQuery.md), and [`<InlineWidthQuery>`](./docs/en/InlineWidthQuery.md)
9191
- [`<Audio>`](./docs/en/Audio.md) and [`<Video>`](./docs/en/Video.md)
92-
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md), `<Prompt>`, `<Confirm>`
92+
- [`<Speak>`](./docs/en/Speak.md), [`<Vibrate>`](./docs/en/Vibrate.md), [`<Alert>`](./docs/en/Alert.md)
9393
- [Animation](./docs/en/Animation.md)
9494
- [`<AfterTimeout>`](./docs/en/AfterTimeout.md), [`<AfterDraf>`](./docs/en/AfterDraf.md), and [`<WhenIdle>`](./docs/en/WhenIdle.md)
9595
- [`<Render>`](./docs/en/Render.md), [`withRender()`](./docs/en/Render.md#withrender-hoc), and [`@withRender`](./docs/en/Render.md#withrender-decorator)
9696
- [`<RenderInterval>`](./docs/en/RenderInterval.md), [`withRenderInterval()`](./docs/en/RenderInterval.md#withrenderinterval-hoc), and [`@withRenderInterval`](./docs/en/RenderInterval.md#withrenderinterval-decorator)
9797
- [`<Tween>`](./docs/en/Tween.md), [`withTween()`](./docs/en/Tween.md#withtween-hoc), and [`@withTween`](./docs/en/Tween.md#withtween-decorator)
9898
- [`<Interpolation>`](./docs/en/Interpolation.md), [`withInterpolation()`](./docs/en/Interpolation.md#withinterpolation-hoc), and [`@withInterpolation`](./docs/en/Interpolation.md#withinterpolation-decorator)
9999
- [Side Effects](./docs/en/Side-effects.md)
100-
- [`<LocalStorage>`](./docs/en/LocalStorage.md), `<SessionStorage>`, `<IndexedDb>`
100+
- [`<LocalStorage>`](./docs/en/LocalStorage.md)
101101
- [`<ClassNames>`](./docs/en/ClassNames.md)
102-
- `<Title>`, `<Favicon>`
103-
- [`go()`](./docs/en/routing.md#go), [`<Sms>`](./docs/en/Sms.md), [`<Mailto>`](./docs/en/Mailto.md), and `<Tel>`
102+
- [`go()`](./docs/en/routing.md#go), [`<Sms>`](./docs/en/Sms.md), [`<Mailto>`](./docs/en/Mailto.md)
104103
- [Boundaries](./docs/en/Boundaries.md)
105104
- [`<BrowserOnly>`](./docs/en/BrowserOnly.md), [`<ServerOnly>`](./docs/en/ServerOnly.md), and [`<ElectronOnly>`](./docs/en/ElectronOnly.md)
106105
- [`<ErrorBoundary>`](./docs/en/ErrorBoundary.md) and [`withErrorBoundary()`](./docs/en/ErrorBoundary.md#witherrorboundary-hoc)

docs/en/routing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Reference:
1717
- [`createRouter()`](#createrouter)
1818

1919

20-
## Use any state container
20+
###### Use any state container
2121

2222
With libreact's `<Router>` you can choose to store the current route in your state continer (like Redux or MobX) of
2323
choice.
@@ -58,7 +58,7 @@ so, simply use:
5858
```
5959

6060

61-
## Multiple routers
61+
###### Multiple routers
6262

6363
You can have many routers operating on the same page in parallel. All you have to do is specify a *namespace* using the `ns` prop.
6464

@@ -68,7 +68,7 @@ You can have many routers operating on the same page in parallel. All you have t
6868
</Router>
6969
```
7070

71-
You can have *app-inside-app* that has its own routing logic.
71+
Or use [`createRouter()`](#createrouter) to create React components with bound namespace.
7272

7373

7474
## Reference

0 commit comments

Comments
 (0)