Chart: add show_legend toggle, document it, and add e2e test#1270
Merged
Chart: add show_legend toggle, document it, and add e2e test#1270
show_legend toggle, document it, and add e2e test#1270Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 375df59c3a
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
false AS show_legendso charts can be rendered without the series legend when desired.Description
"show_legend": {{stringify show_legend}}insqlpage/templates/chart.handlebarsso SQL values are passed to the client.sqlpage/apexcharts.jswithlegend: { show: data.show_legend !== false }so the legend is visible by default and hidden only when explicitlyfalse.examples/official-site/sqlpage/migrations/01_documentation.sqland updated the existingExpensesexample to include"show_legend": false.tests/end-to-end/official-site.spec.tsthat loads the documentation page and asserts theExpenseschart renders while its legend is hidden.Testing
npm run formatwhich completed successfully and formatted files.npx playwright install chromiumand installed required host libs viaapt-getto run headless tests successfully.cargo runto serveexamples/official-siteand executed the Playwright e2e testchart supports hiding legend; the test passed.cargo run -- --helpduring the workflow to verify the binary built and started as expected.Codex Task