Use your AdonisJs routes in JavaScript.
This package provides a JavaScript route() function that can be used to generate URLs for named routes defined in an AdonisJs application.
Install and configure the package using the following command :
node ace add @izzyjs/routeTo use the route() function in your JavaScript applications, you need to follow these steps:
You can run a command to generate the route definitions from @izzyjs/routes with:
node ace izzy:routesThese type definitions are only needed in a development environment, so they can be generated automatically in the next step.
Add the following line to the adonisrc.ts file to register the () => import('@izzyjs/route/dev_hook') on onDevServerStarted array list.
{
// rest of adonisrc.ts file
unstable_assembler: {
onBuildStarting: [() => import('@adonisjs/vite/build_hook')],
onDevServerStarted: [() => import('@izzyjs/route/dev_hook')] // Add this line,
}
}Add edge plugin in entry view file @routes to use the route() into javascript.
// resources/views/inertia_layout.edge
<!doctype html>
<html>
<head>
// rest of the file
@routes() // Add this line
// rest of the file
</head>
<body>
@inertia()
</body>
</html>Now that we've followed all the steps, we're ready to use route() on the client side to generate URLs for named routes.
import { route } from '@izzyjs/route/client'
const url = route('users.show', { id: '1' }) // /users/1Is a callback class with a parameter for route(), with information about the method, partern and path itself.
import { route } from '@izzyjs/route/client'
const url = route('users.show', { id: '1' }) // /users/1
url.method // GET
url.pattern // /users/:id
url.path // /users/1Is a callback class withoout a parameter for route(), with information about the method, partern and path itself.
The current method returns the current URL of the page or the URL of the page that the user is currently on.
import { route } from '@izzyjs/route/client'
// current /users/1
route().current() // /users/1
route().current('/users/1') // true
route().current('/users/2') // false
route().current('users.*') // trueThe has method returns a boolean value indicating whether the named route exists in the application.
// start/routes.ts
import router from '@adonisjs/core/services/router'
const usersConstroller = () => import('#app/controllers/users_controller')
router.get('/users', [usersConstroller, 'index']).as('users.index')
router.get('/users/:id', [usersConstroller, 'show']).as('users.show')import { route } from '@izzyjs/route/client'
route().has('users.show') // true
route().has('users.*') // true
route().has('dashboard') // falseThe params method returns the parameters of the URL of the page that the user is currently on.
import { route } from '@izzyjs/route/client'
route().params() // { id: '1' }These features enable seamless integration of AdonisJs routing within your JavaScript applications, enhancing flexibility and maintainability. By leveraging route(), you can easily manage and navigate your application routes with ease, ensuring a smooth user experience.
Thank you for being interested in making this package better. We encourage everyone to help improve this project with new features, bug fixes, or performance improvements. Please take a little bit of your time to read our guide to make this process faster and easier.
To understand how to submit an issue, commit and create pull requests, check our Contribution Guidelines.
We expect you to follow our Code of Conduct. You can read it to understand what kind of behavior will and will not be tolerated.
MIT License © IzzyJs