feat(toolbar): Toolbar API improvements #10665
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: d719e40 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: astro
Princesseuh
commented
Apr 5, 2024
| id: string; | ||
| name: string; | ||
| icon?: Icon; | ||
| }; | ||
|
|
||
| export type DevToolbarApp = { |
There was a problem hiding this comment.
The types are quite messy around these parts right now because we support both patterns, once we remove the old pattern, there'll only be one type again
* feat(toolbar): Add helpers features * fix: consistent payloads and naming * chore: changeset * nit: rename eventTarget to app * feat: add server-side helpers * test: update test to use new APIs * fix: types * nit: erikaaaaa * feat: add new event * Update .changeset/khaki-pianos-burn.md * test: use data to create text * Apply suggestions from code review Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev> * nit: use diff * nit: documentation effort * test: fix --------- Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
!preview toolbar-improvements |
|
Snapshots have been released for the following packages:
Publish LogBuild Log |
* feat: add a toolbar starter * test: skip examples that are not Astro projects * nit: small changes * feat: setup for build step * fix: add to devdep * docs: add commands to README
Princesseuh
commented
Apr 18, 2024
Comment on lines
+1
to
+5
| import type { DevToolbarApp } from '../@types/astro.js'; | ||
|
|
||
| export function defineToolbarApp(app: DevToolbarApp) { | ||
| return app; | ||
| } |
There was a problem hiding this comment.
Since it's intended for external usage, and possibly build systems. I figured astro/toolbar would be better, otherwise you can't build using TypeScript, you need to use external etc. I'm expecting that we'll do the same with astro/integration if we have exports there.
ematipico
approved these changes
Apr 18, 2024
bluwy
approved these changes
Apr 19, 2024
I knew I would forget to update it in one place somewhere 😔 Updated! |
|
!preview toolbar-improvements |
|
Snapshots have been released for the following packages:
Publish LogBuild Log |
sarah11918
reviewed
Apr 22, 2024
There was a problem hiding this comment.
A couple of thoughts on the changeset here for you, @Princesseuh ! 🙌
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR makes the surface smaller for defining a toolbar app and also introduce an helper function to define an app. These changes are intended to lower the barrier to create an app.
Before
After
Similar to
defineCollection,defineConfigetc,defineToolbarApptakes care of the typing for you.The metadata is now part of the
addDevToolbarAppcall inside your integration, in addition of making the actual app code clearer since it only contains logic, this allows for better error handling in cases where your entrypoint is invalid, as we can now tell you exactly which app failed to load.This PR also includes new helpers and a new starter, see #10667 and #10793 for more details on that.
Testing
Modified the third-party plugin test to use those new APIs.
Docs
withastro/docs#7821