> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/tighten/ziggy/llms.txt
> Use this file to discover all available pages before exploring further.
# Use your Laravel routes in JavaScript
> Ziggy provides a JavaScript route() helper that works like Laravel's, making it a breeze to use your named Laravel routes in JavaScript.
Ziggy
Use your Laravel named routes in JavaScript with a seamless route() helper function.
## Why Ziggy?
Ziggy creates a JavaScript `route()` helper function that works like [Laravel's route() helper](https://laravel.com/docs/helpers#method-route), allowing you to use your Laravel named routes in JavaScript just as easily as you do in PHP.
```javascript theme={null}
// In your Laravel routes
Route::get('posts/{post}', [PostController::class, 'show'])->name('posts.show');
// In your JavaScript
route('posts.show', 1); // 'https://ziggy.test/posts/1'
```
Install Ziggy via Composer and get started in minutes
Learn the basics and start using Ziggy in your app
Auto-generate types for route names and parameters
Use with Vue, React, or any JavaScript framework
## Key Features
JavaScript route() function that mirrors Laravel's PHP helper
Full support for Laravel's route-model binding with custom keys
Generate type definitions for route autocompletion
Built-in Vue plugin for seamless integration
useRoute() hook for React applications
Control which routes are exposed to JavaScript
## Quick Example
```javascript theme={null}
// Basic usage
route('posts.index'); // 'https://ziggy.test/posts'
// With parameters
route('posts.show', 1); // 'https://ziggy.test/posts/1'
// With query parameters
route('posts.index', { page: 2, sort: 'date' });
// 'https://ziggy.test/posts?page=2&sort=date'
// Check current route
route().current('posts.index'); // true/false
// Get current route name
route().current(); // 'posts.index'
```
## Getting Started
Add Ziggy to your Laravel application via Composer
```bash theme={null}
composer require tightenco/ziggy
```
Include the `@routes` directive in your main layout before your JavaScript
```blade theme={null}
@routes
```
Start using the route() function in your JavaScript
```javascript theme={null}
route('posts.show', { post: 1 });
```
## Community
Ziggy is built and maintained by [Tighten](https://tighten.com), a team dedicated to making Laravel development better. Join thousands of developers using Ziggy in production.
View source code, report issues, and contribute
Available as ziggy-js on npm