tightenco/ziggy
Ziggy
Ziggy is a frontend route bridge and JavaScript route resolver that allows Laravel route names and parameters to be used within JavaScript and TypeScript environments. It serves as a synchronization layer that exports backend route configurations to frontend assets, ensuring that frontend navigation remains in sync with backend route definitions.
The project provides a TypeScript route type generator that produces strict type definitions for route names and parameters to enable IDE autocompletion. It includes a route exposure filtering system that uses inclusion and exclusion patterns to control which backend route configurations are shared with the client.
The utility covers named URL generation, route name resolution, and active route identification. It also handles route model binding by extracting unique identifiers from objects and enables route parameter extraction from the current URL path.
Features
- Full Stack Route Synchronization - Keeps frontend navigation in sync with backend route definitions automatically across different application layers.
- Route Type Generators - Generates TypeScript definitions for application routes and parameters to ensure end-to-end type safety.
- Type Definition Generators - Synthesizes static TypeScript type information from route definitions for external consumption and IDE autocompletion.
- TypeScript Type Definitions - Provides TypeScript type support for Laravel routes to enable developer autocompletion and prevent broken links.
- Backend-Frontend Bridges - Acts as a synchronization layer exporting backend route configurations to frontend assets for type-safe communication.
- Named Route Lookups - Uses a key-value map to resolve unique route identifiers into complete URLs.
- JavaScript Route Resolvers - Converts backend route identifiers into full URLs and extracts parameters from the current browser path.
- Laravel Integrations - Integrates Laravel named routes and parameters directly within JavaScript and TypeScript environments.
- Route Definition Exporting - Exports server-side routing configurations into portable formats for frontend route resolution.
- Routing Configurations - Outputs application route lists as declarative structures for consumption by external frontend repositories.
- Route Model Bindings - Provides mechanisms to automatically extract unique identifiers from models to generate URLs.
- URL Generators - Allows programmatically constructing full URLs using a route name and a set of parameters.
- Manifest-Based Route Matching - Matches current browser URLs against an exported static route manifest to identify active routes.
- Route Manifest Filtering - Restricts exported route lists using inclusion and exclusion patterns to prevent sensitive endpoints from leaking to clients.
- Route Exposure Filtering - Controlling which backend route configurations are shared with the frontend to maintain security and reduce payload size.
- Active Route Segment Accessors - Provides the ability to match the active URL against specific route names and parameters to determine application state.
- Frontend Integration - Uses named routes within JavaScript.
