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 modes #485

Open
MichalBryxi opened this issue Oct 4, 2024 · 0 comments
Open

Rename modes #485

MichalBryxi opened this issue Oct 4, 2024 · 0 comments

Comments

@MichalBryxi
Copy link
Contributor

MichalBryxi commented Oct 4, 2024

This is a pet-peeve, but I still consider it a good DX. The modes in ember-highcharts seem to be arbitrary values that don't directly map to highcharts.com world. That being said, their product pages are not very consistent either. So since this is supposed to be consumed by developers, I'd go with whatever Highcharts.[api-call] is used in the source code:

mode option currently used mode change proposal
falsy value "chart"
"StockChart" "stockChart"
"Map" "mapChart"
"Gantt" "ganttChart"

This would IMO make it easier to navigate for newcommers as they might be looking into the highcharts documentation and copy&pasting things.

Note that I wrote falsy -> "chart". This is not to remove the fallback value, but to support the effort to have an explicit chart mode: #486

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

1 participant