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] Store properties in URL on a component's Property Explorer page #2787

Open
vasilii-kovalev opened this issue Apr 1, 2025 · 2 comments
Labels
Documentation Improvements or additions to documentation improvement Something that could be better

Comments

@vasilii-kovalev
Copy link
Collaborator

vasilii-kovalev commented Apr 1, 2025

Now

Sometimes it is necessary to share a customized version of a component with a team so that they can understand the idea of how it will look and work in our case. For example, I would like to show how NumericInput without arrows and up 2 fractional digits would look and work. Currently, I would need to share the link to the component's Property Explorer page and a screenshot of how the properties should look like with the highlighted differences (or describe what needs to be changed in text), which is inconvenient.

To Do

  1. Store all or only changed properties in URL on a component's Property Explorer page. It can be a simple key-value pair or a hash string like in TypeScript Playground (for example, https://www.typescriptlang.org/play/?#code/MYewdgziA2CmB00QHMAUAiAEraSA0ABAKpECS6AlANwBQQA)
  2. (Optional) Add a button on UI to copy URL and a notification that the URL has been copied to clipboard, like in TypeScript Playground ("Share" button)
@vasilii-kovalev vasilii-kovalev added the improvement Something that could be better label Apr 1, 2025
@cpoftea
Copy link
Contributor

cpoftea commented Apr 1, 2025

@vasilii-kovalev You mean like that? Fullscreen button does that after you play with some props.

@vasilii-kovalev
Copy link
Collaborator Author

vasilii-kovalev commented Apr 1, 2025

@vasilii-kovalev You mean like that? Fullscreen button does that after you play with some props.

Yes. But it is not obvious at all. It looks like a by-product rather than an intentionally implemented feature. Also, if I need to play with the properties further, I can't convert the URL back to the split screen version of the page. So I'd need to figure out what customization is encoded in the URL, repeat the customization, and then proceed with further adjustments. That would be very helpful if the URL with the customization can work with the split screen version too. Or at least an ability to go to the split screen version from full screen version of the page with preserved customization.

@AlekseyManetov AlekseyManetov added the Documentation Improvements or additions to documentation label Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation improvement Something that could be better
Projects
Status: Backlog
Development

No branches or pull requests

3 participants