Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

remove outdated devoverlay config and defaultstate config #9291

Merged
merged 3 commits into from
Dec 4, 2023

Conversation

FredKSchott
Copy link
Member

@FredKSchott FredKSchott commented Dec 4, 2023

Changes

  • devOverlay config was introduced in the 4.0.0-beta.X release branch, meaning it is not covered by semver now that it has been renamed to devToolbar. The only people who would have been using this were people experimenting with early versions of the Astro 4.0 beta.
  • This PR removes that no-longer-used config for the official 4.0 release.
  • This PR also fixes a bug where devOverlay was being checked, instead of devToolbar
  • This PR also updates tests to use devToolbar instead of devOverlay
  • This PR also removes an outdated defaultState config, which was removed in Overlay look-and-feel polish #9230 but the config was missed. This is now a no-op and doesn't make conceptual sense since the toolbar now shows/hides based on hover/focus.

Testing

  • Updated tests

Docs

  • Updated docs in JSDoc
  • @matthewp want your signoff first before I involve docs!

Copy link

changeset-bot bot commented Dec 4, 2023

⚠️ No Changeset found

Latest commit: 771c0c8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Dec 4, 2023
Copy link
Contributor

github-actions bot commented Dec 4, 2023

⚖️ Bundle Size Check

Latest commit: 771c0c8

File Old Size New Size Change
dev-overlay/overlay 40.13 KB 40 KB - NaN undefined

@@ -228,12 +228,7 @@ export class AstroDevOverlay extends HTMLElement {
width: 1px;
}
</style>
<div id="dev-overlay"${
((window as DevOverlayMetadata)?.__astro_dev_overlay__?.defaultState ?? 'minimized') ===
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the part that is no longer needed, as the dev overlay is now always hidden to start.

@FredKSchott
Copy link
Member Author

Confirmed no impact on docs, since this was never added to docs either during the early 4.0.0-beta.1 days!

@FredKSchott FredKSchott merged commit 99c1bca into main Dec 4, 2023
15 checks passed
@FredKSchott FredKSchott deleted the remove-dev-overlay-config branch December 4, 2023 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants