<Link> component. This component is a light wrapper around a standard anchor <a> link that intercepts click events and prevents full page reloads. This is how Inertia provides a single-page app experience once your application has been loaded.
Creating Links
To create an Inertia link, use the Inertia<Link> component. Any attributes you provide to this component will be proxied to the underlying HTML tag.
<a> elements. However, you can change the tag using the as prop.
Creating
POST/PUT/PATCH/ DELETE anchor <a> links is discouraged as it causes “Open Link in New Tab / Window” accessibility issues. The component automatically renders a <button> element when using these methods.Method
You can specify the HTTP request method for an Inertia link request using themethod prop. The default method used by links is GET, but you can use the method prop to make POST, PUT, PATCH, and DELETE requests via links.
Wayfinder
v2.0.6+ When using Wayfinder in conjunction with theLinkcomponent, you can simply pass the resulting object directly to the href prop. The Link will infer the HTTP method and URL directly from the Wayfinder object.
Data
When makingPOST or PUT requests, you may wish to add additional data to the request. You can accomplish this using the data prop. The provided data can be an object or FormData instance.
Custom Headers
Theheaders prop allows you to add custom headers to an Inertia link. However, the headers Inertia uses internally to communicate its state to the server take priority and therefore cannot be overwritten.
Browser History
Thereplace prop allows you to specify the browser’s history behavior. By default, page visits push (new) state (window.history.pushState) into the history; however, it’s also possible to replace state (window.history.replaceState) by setting the replace prop to true. This will cause the visit to replace the current history state instead of adding a new history state to the stack.
State Preservation
You can preserve a page component’s local state using thepreserve-state prop. This will prevent a page component from fully re-rendering. The preserve-state prop is especially helpful on pages that contain forms, since you can avoid manually repopulating input fields and can also maintain a focused input.
Scroll Preservation
You can use thepreserveScroll prop to prevent Inertia from automatically resetting the scroll position when making a page visit.
Partial Reloads
Theonly prop allows you to specify that only a subset of a page’s props (data) should be retrieved from the server on subsequent visits to that page.
View Transitions
You may enable View transitions for a link by setting theviewTransition prop to true. This will use the browser’s View Transitions API to animate the page transition.
Active States
It’s common to set an active state for navigation links based on the current page. This can be accomplished when using Inertia by inspecting thepage object and doing string comparisons against the page.url and page.component properties.
===), startsWith() comparisons (useful for matching a subset of pages), or even more complex comparisons using regular expressions.
Using this approach, you’re not limited to just setting class names. You can use this technique to conditionally render any markup on active state, such as different link text or even an SVG icon that represents the link is active.
Data Loading Attribute
While a link is making an active request, adata-loading attribute is added to the link element. This allows you to style the link while it’s in a loading state. The attribute is removed once the request is complete.