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

Provide documentation on what Parameter types are needed for the different Panel widgets from_param method. #6813

Open
dwillhelm opened this issue May 6, 2024 · 0 comments
Labels
type: docs Related to the Panel documentation and examples

Comments

@dwillhelm
Copy link

dwillhelm commented May 6, 2024

Is your feature request related to a problem? Please describe.

When using the from_param method, I often have to guess and check what Parameter type I need. While many are straightforward, it would be nice if I could just look it up somewhere.

This is an example, of how I might use the from_param - to set up the widget I need the param.String parameter type.

class Foo(panel.viewable.Viewer): 
    display_text = param.String(default="foo")

    def __panel__(self) -> Viewable: 
        self.display_text_widget = pn.widgets.StaticText.from_param(
             self.param.display_text, name = "Static Text"
         ) 
         ... 

Describe the solution you'd like

Some documentation on the online docs or added directly to the class docstring.

Describe alternatives you've considered

Guess and check

Additional context

AFAIK, there is no documentation I can find. But if there is, please let me know and close this issue, thanks!

*edit: grammar/spelling; rm header

@philippjfr philippjfr added the type: docs Related to the Panel documentation and examples label May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Related to the Panel documentation and examples
Projects
None yet
Development

No branches or pull requests

2 participants