Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Route wrapper for typescript #465

Merged
merged 4 commits into from
Apr 6, 2024
Merged

Document Route wrapper for typescript #465

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b433f9
Document Route wrapper for typescript
zlondrej Apr 5, 2024
627d708
Apply suggestion
zlondrej Apr 6, 2024
cecf084
Fix badly applied suggestion
zlondrej Apr 6, 2024
34eed6b
Update README.md
rschristian Apr 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ render(<Main />, document.body);

If there is an error rendering the destination route, a 404 will be displayed.

#### Caveats

Because the `path` and `default` props are used by the router, it's best to avoid using those props for your component(s) as they will conflict.

### Handling URLS

:information_desk_person: Pages are just regular components that get mounted when you navigate to a certain URL.
Expand Down Expand Up @@ -276,6 +280,26 @@ function App() {
render(<App />, document.body);
```

### `Route` Component

Alternatively to adding the router props (`path`, `default`) directly to your component, you may want to use the `Route` component we provide instead. This tends to appease TypeScript, while still passing down the routing props into your component for use.

```js
import { Router, Route } from 'preact-router';

function App() {
let users = getUsers();

return (
<Router>
<Route path="/" component={Home} />
{/* Route will accept any props of `component` type */}
<Route path="/users" component={Users} users={users} />
</Router>
);
}
```

### License

[MIT](./LICENSE)
Loading