diff --git a/.changeset/rotten-moles-draw.md b/.changeset/rotten-moles-draw.md deleted file mode 100644 index eb5d076..0000000 --- a/.changeset/rotten-moles-draw.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -'astro-vtbot': major ---- - -When installed as an integration, the and components will no longer be auto-installed on all pages. The `autoLint` and `loadingIndicator` options in the `vtbot()` integration in your astro-config file now default to `false` instead of `true`. These options will be completely removed in a future release. - - -## What's Changing? - -- If you use astro-vtbot as a library and haven't installed it as an Astro integration: Nothing changes for you. - -- If you have installed it as an integration and have explicitly opted out of the linter and loading indicator: remove these settings: `{autoLint: false, loadingIndicator: false}` from your astro-config file. - -- If you have installed it as an integration and called vtbot({...}) with one option or no parameter at all: -To ensure continued functionality, explicitly add the `` and/or `` components to the pages that need them. Ideally, include them in your common `layout.astro` file for consistency across your site. Make sure that the call to `vtbot()` in you astro-config file does not set any options. - -### Temporary Workaround -You can restore the previous behavior by enabling the deprecated options, but note that they will be removed soon: - -```ts -import vtbot from "astro-vtbot"; - -export default defineConfig({ - integrations: [vtbot({ - autoLint: true, loadingIndicator: true - })] -}); -``` -Take action now to ensure smooth transitions and avoid future disruptions. diff --git a/CHANGELOG.md b/CHANGELOG.md index ed9f63a..dcae247 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,37 @@ # The Bag of Tricks for Astro's View Transitions +## 2.0.0 - 2024-12-30 + +### Major Changes + +- 85e6fb4: When installed as an integration, the and components will no longer be auto-installed on all pages. The `autoLint` and `loadingIndicator` options in the `vtbot()` integration in your astro-config file now default to `false` instead of `true`. These options will be completely removed in a future release. + + ## What's Changing? + + - If you use astro-vtbot as a library and haven't installed it as an Astro integration: Nothing changes for you. + - If you have installed it as an integration and have explicitly opted out of the linter and loading indicator: remove these settings: `{autoLint: false, loadingIndicator: false}` from your astro-config file. + - If you have installed it as an integration and called vtbot({...}) with one option or no parameter at all: + To ensure continued functionality, explicitly add the `` and/or `` components to the pages that need them. Ideally, include them in your common `layout.astro` file for consistency across your site. Make sure that the call to `vtbot()` in you astro-config file does not set any options. + + ### Temporary Workaround + + You can restore the previous behavior by enabling the deprecated options, but note that they will be removed soon: + + ```ts + import vtbot from 'astro-vtbot'; + + export default defineConfig({ + integrations: [ + vtbot({ + autoLint: true, + loadingIndicator: true, + }), + ], + }); + ``` + + Take action now to ensure smooth transitions and avoid future disruptions. + ## 1.10.7 - 2024-11-15 ### Patch Changes diff --git a/package.json b/package.json index d7d5b5d..88d72d1 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "publishConfig": { "access": "public" }, - "version": "1.10.7", + "version": "2.0.0", "description": "The 👜 Bag of Tricks ✨ for Astro's View Transitions", "homepage": "https://events-3bg.pages.dev/", "bugs": {