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

[docs-infra] Support anchor link to each prop #36544

Closed
sai6855 opened this issue Mar 17, 2023 · 4 comments · Fixed by #37405
Closed

[docs-infra] Support anchor link to each prop #36544

sai6855 opened this issue Mar 17, 2023 · 4 comments · Fixed by #37405
Assignees
Labels
design This is about UI or UX design, please involve a designer docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product

Comments

@sai6855
Copy link
Contributor

sai6855 commented Mar 17, 2023

What's the problem? 🤔

I think there is scope to improve on sharing props. Currently we can only share props section of an component not an individual prop of an component, I think it's good to have a sharable link for an individual prop

What are the requirements? ❓

No response

What are our options? 💡

No response

Proposed solution 🟢

If you want to share inputProps of textfield component, url could be something like this Something like this https://mui.com/material-ui/api/text-field/#props#inputProps and on opening the URL, UI should display inputProps section

Resources and benchmarks 🔗

No response

@sai6855 sai6855 added RFC Request For Comments status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Mar 17, 2023
@zannager zannager added the component: text field This is the name of the generic UI component, not the React module! label Mar 17, 2023
@sai6855
Copy link
Contributor Author

sai6855 commented Mar 18, 2023

got this idea while answering this issue #36538 (comment)

@michaldudak

This comment was marked as resolved.

@oliviertassinari oliviertassinari added scope: docs-infra Specific to the docs-infra product and removed component: text field This is the name of the generic UI component, not the React module! status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Mar 23, 2023
@oliviertassinari oliviertassinari changed the title [RFC] Ability to share individual props [docs-infra] Add the ability to anchor link individual props? Mar 23, 2023
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Mar 23, 2023
@oliviertassinari oliviertassinari changed the title [docs-infra] Add the ability to anchor link individual props? [docs-infra] Support anchor link to each prop? Mar 23, 2023
@oliviertassinari
Copy link
Member

oliviertassinari commented Mar 23, 2023

I recall @eps1lon explored this idea in the past but I can't find the PR back. I can't recall exactly why we didn't move forward.

At a minimum, having a hidden id so that maintainers can link to rows directly in big tables like https://mui.com/x/api/data-grid/data-grid/ seems like a step forward.

If we make it visible to the developers, there is a need for a design reflection on how we can make it feel great.

One benchmark:

  • Stripe, with a direct anchor link to issuingCard

Screenshot 2023-03-23 at 16 50 46

https://stripe.com/docs/js/issuing_elements/create?type=issuingCardNumberDisplay#issuing_elements_create-options-issuingCard

@oliviertassinari oliviertassinari added the design This is about UI or UX design, please involve a designer label Apr 16, 2023
@alexfauquette
Copy link
Member

I tried a POC on this topic #35543 But yes, the design is clearly the main blocker here.

@oliviertassinari oliviertassinari changed the title [docs-infra] Support anchor link to each prop? [docs-infra] Support anchor link to each prop May 23, 2023
@oliviertassinari oliviertassinari added enhancement This is not a bug, nor a new feature and removed RFC Request For Comments labels May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design This is about UI or UX design, please involve a designer docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants