feat(docs-page): consolidate version-select into docs-page, add projectName prop #650
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
🦋 Changeset detectedLatest commit: 8dc6f59 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
There was a problem hiding this comment.
I approve! Thank you for taking on the consolidation that I never did ❤️ .
Just one concern about the projectName prop name and the usage with string interpolation.
Curious if you think the ${projectName} Version string interpolation is potentially limiting to us, in the event that say Design Team wants some copy that doesn't end with " Version"
Regardless, LGTM.
| @@ -11,14 +11,20 @@ import { | |||
| interface Props { | |||
| versions: { label: string; name: string }[] | |||
| basePath: string | |||
| projectName?: string | |||
There was a problem hiding this comment.
2 cents: maybe a label prop to entirely override the label text is a more flexible prop?
There was a problem hiding this comment.
But I guess the prop needing to be drilled down several levels make that a bit more involved of a change to get right.
There was a problem hiding this comment.
Fair point. I had opted for this approach as I didn't feel we needed the full flexibility, but maybe it's not super clear what the prop is actually doing on usage 💭
Do you have a preference?
There was a problem hiding this comment.
Sorry missed your comment!
Just one concern about the projectName prop name and the usage with string interpolation.
Curious if you think the ${projectName} Version string interpolation is potentially limiting to us, in the event that say Design Team wants some copy that doesn't end with " Version"
I think if design wants something else it would be consistent across projects, in which case it felt better to enforce it in the component than to have to update all usages / implementations.
🎟️ Asana Task
🔍 Preview Link
Description
To support clearly displaying versions for a specific sub-project, adds a
projectNameprop toDocsPagewhich will get passed down toVersionSelect. Also consolidates the source ofreact-version-selectintoreact-docs-pageas we're only using it there.PR Checklist 🚀
Items in this checklist may not may not apply to your PR, but please consider each item carefully.