c706d845eb
* feat: restart config on add, remove, update * fix: reload for root project configs only * fix: throw when userConfigPath can't resolve * chore: changeset * wip: remove normalizePath before writeFile * refactor: invalidateWithCache -> isConfigReload * wip: mustExist? * debug: config loaded successfully * debug: more logs * debug: MORE logging * fix: normalize resolved config path * debug: yet MORE logging * chore: bump proload * fix: use file path, not URL.pathname * Revert "wip: mustExist?" This reverts commit 8ca8662132532dcdc9fd120868e615ddc60f498e. * chore: remove console log * feat: cleanup restart message, better invalid config handling * chore: update lockfile * chore: fix types * fix: throw helpful error when config does not exist * docs: remove "restart dev server" from integrations * docs: make sure to restart -> try restarting Co-authored-by: Nate Moore <nate@astro.build> |
||
|---|---|---|
| .. | ||
| src | ||
| CHANGELOG.md | ||
| client.js | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
This integration is no longer actively supported
Turbolinks is no longer under active development. The @astrojs/turbolinks integration has been deprecated.
Looking for an alternative?
Check out swup! If you are using any client:* script for partial hydration, make sure to install the @swup/scripts-plugin to ensure components are rehydrated after a page navigation.
@astrojs/turbolinks ⚡️
This Astro integration brings Turbo to your Astro project.
Turbolinks is a plug-and-play solution to bring single page app (SPA) routing to your site. This brings performant navigation without the added complexity of a client-side JavaScript framework.
Installation
There are two ways to add integrations to your project. Let's try the most convenient option first!
(experimental) astro add command
Astro includes a CLI tool for adding first party integrations: astro add. This command will:
- (Optionally) Install all necessary dependencies and peer dependencies
- (Also optionally) Update your
astro.config.*file to apply this integration
To install @astrojs/turbolinks, run the following from your project directory and follow the prompts:
# Using NPM
npx astro add turbolinks
# Using Yarn
yarn astro add turbolinks
# Using PNPM
pnpm astro add turbolinks
If you run into any issues, feel free to report them to us on GitHub and try the manual installation steps below.
Install dependencies manually
First, install the @astrojs/turbolinks integration like so:
npm install @astrojs/turbolinks
Then, apply this integration to your astro.config.* file using the integrations property:
astro.config.mjs
import turbolinks from '@astrojs/turbolinks';
export default {
// ...
integrations: [turbolinks()],
}
Getting started
Turbo links, frames, and more should be ready-to-use with zero config. For instance, try navigating between different pages via links. You should no longer see browser refreshes! You will also find each page request passing through turbolinks under the "Network" tab in your browser's dev tools.
Head to the Turbo handbook for all options and features available. You can also check our Astro Integration Documentation for more on integrations.