Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaunlee/alpinejs-router
Easy to use and flexible router for Alpine.js
https://github.com/shaunlee/alpinejs-router
Last synced: 6 days ago
JSON representation
Easy to use and flexible router for Alpine.js
- Host: GitHub
- URL: https://github.com/shaunlee/alpinejs-router
- Owner: shaunlee
- License: mit
- Created: 2022-09-28T18:01:28.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-10-01T02:25:57.000Z (3 months ago)
- Last Synced: 2024-12-29T17:07:56.201Z (13 days ago)
- Language: JavaScript
- Size: 31.3 KB
- Stars: 107
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - alpinejs-router - Easy to use and flexible router for Alpine.js, support dynamic route matching with params
README
# alpinejs-router
Easy to use and flexible router for Alpine.js
## Installation
### npm
```bash
npm install @shaun/alpinejs-router
```
### yarn
```bash
yarn add @shaun/alpinejs-router
```
### cdn
```html
```
```html
```
## Getting Started
```html
Hello World
Say hello to
```
somewhere.html
```html
Toggle Content
Content...
```
## Dynamic Route Matching with Params
Very often we will need to map routes with the given pattern to the same template.
For example we may have a `user` template which should be rendered for all users but with different user IDs.
In `@shaun/alpinejs-router` we can use a dynamic segment in the path to achieve that, we call that a param:
```html
```
Now URLs like `/users/johnny` and `/users/jolyne` will both map to the same route.
A param is denoted by a colon `:`. When a route is matched, the value of its params will be exposed as `$router.params`.
Therefore, we can render the current user ID by updating user's template to this:
```html
User ID:
```
You can have multiple params in the same route, and they will map to corresponding fields on `$router.params`. Examples:
| pattern | matched path | $router.params |
| --- | --- | --- |
| /users/:username | /users/eduardo | `{ username: 'eduardo' }` |
| /users/:username/posts/:postId | /users/eduardo/posts/123 | `{ username: 'eduardo', postId: '123' }` |
In addition to `$router.params`, the `$router` magic also exposes other useful information such as `$router.query` (if there is a query in the URL), `$router.path`, etc.
## Routes' Matching Syntax
Most applications will use static routes like `/about` and dynamic routes like `/users/:userId` like we just saw in Dynamic Route Matching, but `@shaun/alpinejs-router` has much more to offer!
### Custom regex in params
When defining a param like `:userId`, we internally use the following regex `([^/]+)` (at least one character that isn't a slash `/`) to extract params from URLs.
This works well unless you need to differentiate two routes based on the param content. Imagine two routes `/:orderId` and `/:productName`, both would match the exact same URLs, so we need a way to differentiate them.
The easiest way would be to add a static section to the path that differentiates them:
```html
```
But in some scenarios we don't want to add that static section `/o/p`. However, `orderId` is always a number while `productName` can be anything, so we can specify a custom regex for a param in parentheses:
```html
```
Now, going to `/25` will match `/:orderId` while going to anything else will match `/:productName`.
## Programmatic Navigation
Aside from using `` to create anchor tags for declarative navigation, we can do this programmatically using the router's instance methods.
### Navigate to a different location
To navigate to a different URL, use `$router.push`. This method pushes a new entry into the history stack, so when the user clicks the browser back button they will be taken to the previous URL.
This is the method called internally when you click a `x-link`, so clicking `` is the equivalent of calling `$router.push(...)`.
| Declarative | Programmatic |
| --- | --- |
| `` | `$router.push(...)` |
### Replace current location
It acts like `$router.push`, the only difference is that it navigates without pushing a new history entry, as its name suggests - it replaces the current entry.
| Declarative | Programmatic |
| --- | --- |
| `` | `$router.replace('...')` |
### History Manipulation
You may have noticed that `$router.push` and `$router.replace` are counterparts of `window.history.pushState` and `window.history.replaceState`, and they do imitate the `window.history` APIs.
Therefore, if you are already familiar with [Browser History APIs](https://developer.mozilla.org/en-US/docs/Web/API/History_API), manipulating history will feel familiar when using `@shaun/alpinejs-router`.
It is worth mentioning that `@shaun/alpinejs-router` navigation methods (push, replace) work consistently no matter the kind of `mode` option is passed when configuring the router instance.
## Different History modes
The `mode` option when configuring the router instance allows us to choose among different history modes.
### Hash Mode
The hash history mode is configured with `'hash'`:
```html
```
It uses a hash character (`#`) before the actual URL that is internally passed.
Because this section of the URL is never sent to the server, it doesn't require any special treatment on the server level.
It does however have a bad impact in SEO. If that's a concern for you, use the HTML5 history mode.
### HTML5 Mode
The HTML5 mode is configured with `'web'` and is the recommended mode:
```html
```
When using `'web'`, the URL will look "normal," e.g. `https://example.com/user/id`. Beautiful!
Here comes a problem, though: Since our app is a single page client side app, without a proper server configuration,
the users will get a 404 error if they access `https://example.com/user/id` directly in their browser. Now that's ugly.
Not to worry: To fix the issue, all you need to do is add a simple catch-all fallback route to your server.
If the URL doesn't match any static assets, it should serve the same `index.html` page that your app lives in. Beautiful, again!
## Route directive
Declare routes by creating a template tag with `x-route` attribute.
```html
...
Error 404 not found
```
## Link directive
```html
...
```
## Magic $router
### Properties
```html
Separate template file is loading
```
### Methods
```html
...
...
...
...
...
...
...
...
You can see me
You can see me also
...
```
## License
Licensed under [MIT](https://github.com/shaunlee/alpinejs-router/blob/master/LICENSE)