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

Feature: Add ability to display informational texts in Knobs addon #1274

Closed
Knagis opened this issue Jun 14, 2017 · 13 comments
Closed

Feature: Add ability to display informational texts in Knobs addon #1274

Knagis opened this issue Jun 14, 2017 · 13 comments

Comments

@Knagis
Copy link

Knagis commented Jun 14, 2017

For example, we might want to add some descriptive text informing the user what values should be set in certain scenarios.

Perhaps something like readonly("Important", "Read this text before changing the value of any knob").

@Gongreg
Copy link
Member

Gongreg commented Jun 15, 2017

@Knagis ,

Hey, what about using description addon for that? Or that wouldn't work for you?

@Knagis
Copy link
Author

Knagis commented Jun 15, 2017

@Gongreg Did you mean the notes addon? I don't see anything named description in this repo. It can be used however in our case we would like to have something that can be seen together with a certain knob - basically some instructions or warnings related to a knob.

Very specifically - we have a checkbox (boolean knob) that is handled in a very special way - we want to add instruction next to the checkbox that instructs the person who uses it what other actions must be taken in order for the checkbox to take effect (in our case - reload the page).

@Gongreg
Copy link
Member

Gongreg commented Jun 16, 2017

Oh okay.

So I think one solution would be to add this functionality or storybook functionality to be able to show multiple panels at once.

Maybe you could do a small example of how this description could look like? I mean a picture or something like that :)

@shilman
Copy link
Member

shilman commented Jun 16, 2017

@Gongreg awesome. I'm very interested in this direction both for panels and for stories

@Knagis
Copy link
Author

Knagis commented Jun 16, 2017

There are many different ways - one might be adding a "?" icon that show the description on tooltip:

image

@stale
Copy link

stale bot commented Oct 31, 2017

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. We do try to do some housekeeping every once in a while so inactive issues will get closed after 90 days. Thanks!

@stale stale bot added the inactive label Oct 31, 2017
@stale
Copy link

stale bot commented Nov 2, 2017

Hey there, it's me again! I am going to help our maintainers close this issue so they can focus on development efforts instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!

@bbecker-te
Copy link

bbecker-te commented May 24, 2019

Its too bad this was closed. It would be nice if once could add tooltip text to knobs. Can we just reopen this instead of creating a new issue and linking?
This could trivially be supported by having a "title" or "tooltip" attribute in the options passed to the knob constructor.

@Gongreg Gongreg reopened this May 27, 2019
@stale stale bot removed the inactive label May 27, 2019
@Gongreg
Copy link
Member

Gongreg commented May 27, 2019

@bbecker-te, I've reopened it. It would be great if you could create a PR for it :)

@stale
Copy link

stale bot commented Jun 17, 2019

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

@stale stale bot added the inactive label Jun 17, 2019
@stale
Copy link

stale bot commented Jul 17, 2019

Hey there, it's me again! I am going close this issue to help our maintainers focus on the current development roadmap instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!

@stale stale bot closed this as completed Jul 17, 2019
@lukaszrys
Copy link

lukaszrys commented Sep 27, 2021

I second that, it would be really nice to have an ability to add some kind of the tooltip next to the knob

@ananta-dev
Copy link

I agree it would be nice to be able to add some explanatory text next to the knob fields.
For example: "enter negative value in days to create a past date"

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

No branches or pull requests

7 participants