Skip to content

Improve JavaScript components docs #647

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

Open
Archmonger opened this issue Feb 6, 2022 · 0 comments
Open

Improve JavaScript components docs #647

Archmonger opened this issue Feb 6, 2022 · 0 comments
Labels
priority-2-moderate Should be resolved on a reasonable timeline. type-docs About changes and updates to documentation

Comments

@Archmonger
Copy link
Contributor

Archmonger commented Feb 6, 2022

Current Situation

The current docs are sparse on information, making it hard for new users to develop custom components. In particular, we jump to a relatively complicated example with super-simple-chart without ever showing a "Hello World" example. Also, this example does not demonstrate interactivity.

Proposed Actions

Extend the docs to add the following information

  • Simple "Hello World"
  • Adding interactivity (event handling)
  • Sending arbitrary JS data to Python
  • Sending arbitrary Python data to JS
  • Using a ReactJS component in a custom component
@Archmonger Archmonger added the flag-triage Not prioritized. label Feb 6, 2022
@rmorshea rmorshea added priority-2-moderate Should be resolved on a reasonable timeline. type-docs About changes and updates to documentation and removed flag-triage Not prioritized. labels Feb 6, 2022
@Archmonger Archmonger added this to the 2.0 milestone Feb 16, 2022
@Archmonger Archmonger changed the title Improve custom components docs Improve JavaScript components docs Jan 12, 2023
@Archmonger Archmonger removed this from the Luxury Features milestone Jan 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-2-moderate Should be resolved on a reasonable timeline. type-docs About changes and updates to documentation
Projects
None yet
Development

No branches or pull requests

2 participants