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

Rename show preview by default prop name #227

Open
HarshDobariya79 opened this issue Aug 22, 2024 · 4 comments
Open

Rename show preview by default prop name #227

HarshDobariya79 opened this issue Aug 22, 2024 · 4 comments

Comments

@HarshDobariya79
Copy link

Current Scenario

  • If we want to make the preview shown by default, we've to use the visible prop.
  • The problem with this prop is that it's not easy to understand and search, so If we search "prev", the visible prop won't be there in the typescript suggestions and no examples are there in the documentation from which one can easily find the way to show the preview by default.

Changes

  • We can rename the prop from visible to something else which contains the word preview in it so it's easy to find from the typescript suggestions.
  • Also we can add some examples for this in the documentation.
@jaywcjlove
Copy link
Member

@HarshDobariya79 Do you think changing visible to livePreview would be appropriate?

@HarshDobariya79
Copy link
Author

@HarshDobariya79 Do you think changing visible to livePreview would be appropriate?

Maybe we should come up with something else, because someone might think this prop disables the live preview at all if given false. Maybe defaultPreview or something.

@HarshDobariya79
Copy link
Author

@jaywcjlove what do you think, will this issue help the community?

@jaywcjlove
Copy link
Member

@jaywcjlove what do you think, will this issue help the community?

Your suggestion is very helpful to the community, and I believe your idea aligns with the props of another component I’m working on. However, I currently don’t have the capacity to address this issue. I maintain many projects, and due to personal financial constraints, I can only prioritize my macOS applications and those supported by donations. Nevertheless, I will try to fix bugs if they arise, but for optimizations, I would appreciate it if you could submit a PR. Thank you! @HarshDobariya79

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants