feat(components): Add additionalPages prop to PageGrid component
#5625
Conversation
This file contains hidden or 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
the new prop allows customization of the list generated by PageGrid
AbhiPrasad
reviewed
Oct 10, 2022
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Lms24
force-pushed
the
lms-customize-pagegrid
branch
from
6f1dc8d to
b2c3eb8
Compare
Lms24
changed the title
additionalPages to PageGrid propsadditionalPages prop to PageGrid component
Contributor
|
Our current PageGrid component automatically pulls in the current description of the page from the front matter. Is there a way to make this additional pages prop do that? I'm concerned about this creating a wild west of people just putting in whatever they want in that description vs copying what's in the current description and/or creating copy/pasta errors when they do. |
Member
Author
|
That's a good point @imatwawana. I agree that the potential danger of people abusing this additional prop to link to ...wherever is greater than the advantage it offers in the particular case I needed it for. Closing this in favour of consistency. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
(This might cause build errors until #5619 is merged. Opening as a draft for now)
This PR adds a new optional prop to the
PageGridcomponent (additionalPages) that allows us to pass a list of additional page links that should be added to the list of pages generated by the component. This is useful when we want to link to a page that is not a sub-page of the MDX file wherePageGridwas placed.Furthermore, this PR adds an index page to JS SDK's performance instrumentation section that makes use of the new prop.
ref: #5582