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

Hover namespace not documented #8296

Closed
1 of 3 tasks
stockiNail opened this issue Jan 11, 2021 · 0 comments · Fixed by #8436
Closed
1 of 3 tasks

Hover namespace not documented #8296

stockiNail opened this issue Jan 11, 2021 · 0 comments · Fixed by #8436

Comments

@stockiNail
Copy link
Contributor

Documentation Is:

  • Missing or needed
  • Confusing
  • Not Sure?

Please Explain in Detail...

PR #7922 add new interaction namespace inside the options. As far as I have understood, options.hover and tooltip are using options.interaction (and then defaults.interaction) as defaults when the specific options in options.hover and tooltip are not set.
This enables the possibility to set hover of tooltip separately starting from the same default.

The hover namespace is mentioned twice into documentation:

  1. https://www.chartjs.org/docs/master/general/interactions/modes
  2. https://www.chartjs.org/docs/master/configuration/index

but it's not clear to me why all options of hover (even if equals to the interaction ones) are not mentioned or at least is not mentioned that exists and you can use for a its purpose.

Furthermore it seems that hover namespace can contain another option, onHover, that's not documented even if it seems the same of options.onHover.

Your Proposal for Changes

I think it could be useful to document also hover namespace in some way.

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

Successfully merging a pull request may close this issue.

1 participant