A platform for community discussion. Free, open, simple.
UX: Result controls for data explorer (#39147)
Natalie Tayd86f2eb5bdef
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/components/data-explorer-chart.gjs b/plugins/discourse-data-explorer/assets/javascripts/discourse/components/data-explorer-chart.gjsindex cfcb28a474a..630e4682729 100644--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/components/data-explorer-chart.gjs+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/components/data-explorer-chart.gjs@@ -50,7 +50,7 @@ export default class DataExplorerChart extends Component {data: { labels: this.args.labels, datasets: [dataset] },options: {responsive: true,- maintainAspectRatio: true,+ maintainAspectRatio: false,plugins: {legend: { display: false },},@@ -116,7 +116,7 @@ export default class DataExplorerChart extends Component {data: { labels: this.args.labels, datasets },options: {responsive: true,- maintainAspectRatio: true,+ maintainAspectRatio: false,plugins: {legend: { display: true, position: "bottom" },tooltip: {diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/components/query-result.gjs b/plugins/discourse-data-explorer/assets/javascripts/discourse/components/query-result.gjsindex b50ea115fc6..a8b6bc8fbe2 100644--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/components/query-result.gjs+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/components/query-result.gjs@@ -1,7 +1,10 @@import Component from "@glimmer/component";+import { tracked } from "@glimmer/tracking";+import { action } from "@ember/object";import { service } from "@ember/service";import { capitalize } from "@ember/string";import moment from "moment";+import DButton from "discourse/components/d-button";import icon from "discourse/helpers/d-icon";import Badge from "discourse/models/badge";import Category from "discourse/models/category";@@ -41,6 +44,23 @@ const VIEW_COMPONENTS = {export default class QueryResult extends Component {@service site;+ @tracked showChart = true;+ @tracked showTable = true;++ @action+ toggleChart() {+ this.showChart = !this.showChart;+ }++ @action+ toggleTable() {+ this.showTable = !this.showTable;+ }++ get chartVisible() {+ return this.canShowChart && this.showChart;+ }+get colRender() {return this.args.content.colrender || {};}@@ -283,7 +303,7 @@ export default class QueryResult extends Component {<template><article>- <header class="result-header">+ <div class="result-header"><div class="result-info">{{#if this.showDownloads}}<QueryResultDownloadButtons@@ -307,8 +327,6 @@ export default class QueryResult extends Component {{{/if}}</div>- <br />-{{~#if this.explainText}}<pre class="result-explain"><code>@@ -316,12 +334,27 @@ export default class QueryResult extends Component {</code></pre>{{~/if}}-- <br />- </header>+ </div><section>{{#if this.canShowChart}}+ <div class="query-results-modes">+ <DButton+ @action={{this.toggleChart}}+ @icon="signal"+ @translatedTitle={{i18n "explorer.show_graph"}}+ class={{if this.showChart "btn-primary" "btn-default"}}+ />+ <DButton+ @action={{this.toggleTable}}+ @icon="table"+ @translatedTitle={{i18n "explorer.show_table"}}+ class={{if this.showTable "btn-primary" "btn-default"}}+ />+ </div>+ {{/if}}++ {{#if this.chartVisible}}<div class="query-results-chart"><DataExplorerChart@labels={{this.chartLabels}}@@ -332,39 +365,41 @@ export default class QueryResult extends Component {</div>{{/if}}- <div class="query-results-table-wrapper">- <table class="query-results-table">- <thead>- <tr class="headers">- {{#each this.columnNames as |col|}}- <th>{{col}}</th>+ {{#if this.showTable}}+ <div class="query-results-table-wrapper">+ <table class="query-results-table">+ <thead>+ <tr class="headers">+ {{#each this.columnNames as |col|}}+ <th>{{col}}</th>+ {{/each}}+ </tr>+ </thead>+ <tbody>+ {{#each this.rows as |row|}}+ <QueryRowContent+ @row={{row}}+ @columnComponents={{this.columnComponents}}+ @lookupUser={{this.lookupUser}}+ @lookupBadge={{this.lookupBadge}}+ @lookupPost={{this.lookupPost}}+ @lookupTopic={{this.lookupTopic}}+ @lookupTagGroup={{this.lookupTagGroup}}+ @lookupGroup={{this.lookupGroup}}+ @lookupCategory={{this.lookupCategory}}+ @transformedPostTable={{this.transformedPostTable}}+ @transformedBadgeTable={{this.transformedBadgeTable}}+ @transformedUserTable={{this.transformedUserTable}}+ @transformedTagGroupTable={{this.transformedTagGroupTable}}+ @transformedGroupTable={{this.transformedGroupTable}}+ @transformedTopicTable={{this.transformedTopicTable}}+ @site={{this.site}}+ />{{/each}}- </tr>- </thead>- <tbody>- {{#each this.rows as |row|}}- <QueryRowContent- @row={{row}}- @columnComponents={{this.columnComponents}}- @lookupUser={{this.lookupUser}}- @lookupBadge={{this.lookupBadge}}- @lookupPost={{this.lookupPost}}- @lookupTopic={{this.lookupTopic}}- @lookupTagGroup={{this.lookupTagGroup}}- @lookupGroup={{this.lookupGroup}}- @lookupCategory={{this.lookupCategory}}- @transformedPostTable={{this.transformedPostTable}}- @transformedBadgeTable={{this.transformedBadgeTable}}- @transformedUserTable={{this.transformedUserTable}}- @transformedTagGroupTable={{this.transformedTagGroupTable}}- @transformedGroupTable={{this.transformedGroupTable}}- @transformedTopicTable={{this.transformedTopicTable}}- @site={{this.site}}- />- {{/each}}- </tbody>- </table>- </div>+ </tbody>+ </table>+ </div>+ {{/if}}</section></article></template>diff --git a/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss b/plugins/discourse-data-explorer/assets/stylesheets/explorer.scssindex f7b97cd3d41..edfa17daba2 100644--- a/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss+++ b/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss@@ -421,12 +421,20 @@ table.group-reports {}section {+ display: flex;+ flex-direction: column;width: 100%;}.query-results-chart {- width: min(100%, 840px);- margin: 0 auto 1rem;+ height: clamp(200px, 50vh, 350px);+ min-width: 0;+ margin-bottom: 1rem;+ animation: fadein 2s;++ @media (prefers-reduced-motion) {+ animation-duration: 0s;+ }}table {@@ -452,6 +460,16 @@ table.group-reports {overflow: auto;max-height: 1000px;}++ .query-results-modes {+ display: inline-flex;+ gap: 0.35em;+ margin: 0.75em 0;++ .btn {+ margin: 0;+ }+ }}.discourse-data-explorer-query-list {diff --git a/plugins/discourse-data-explorer/test/javascripts/acceptance/run-query-test.js b/plugins/discourse-data-explorer/test/javascripts/acceptance/run-query-test.jsindex 58bbd758423..8dea6d536f4 100644--- a/plugins/discourse-data-explorer/test/javascripts/acceptance/run-query-test.js+++ b/plugins/discourse-data-explorer/test/javascripts/acceptance/run-query-test.js@@ -307,11 +307,8 @@ acceptance("Data Explorer Plugin | Run Query", function (needs) {assert.dom("canvas").exists("the chart was rendered");assert- .dom("div.query-results section > :first-child")- .matchesSelector(- ".query-results-chart",- "the chart is shown above the table"- );+ .dom(".query-results-modes")+ .exists("the chart/table toggle buttons were rendered");});test("runs query and is able to download the results", async function (assert) {diff --git a/plugins/discourse-data-explorer/test/javascripts/integration/components/query-result-test.gjs b/plugins/discourse-data-explorer/test/javascripts/integration/components/query-result-test.gjsindex 391d3f54ed3..7488cee8524 100644--- a/plugins/discourse-data-explorer/test/javascripts/integration/components/query-result-test.gjs+++ b/plugins/discourse-data-explorer/test/javascripts/integration/components/query-result-test.gjs@@ -1,4 +1,4 @@-import { render } from "@ember/test-helpers";+import { click, render } from "@ember/test-helpers";import { module, test } from "qunit";import { setupRenderingTest } from "discourse/tests/helpers/component-test";import { i18n } from "discourse-i18n";@@ -156,15 +156,11 @@ module(await render(<template><QueryResult @content={{content}} /></template>);- assert.dom(".result-info button:nth-child(3)").doesNotExist();assert.dom("canvas").exists("the chart was rendered");assert.dom("table").exists("the table was rendered");assert- .dom("section > :first-child")- .matchesSelector(- ".query-results-chart",- "the chart is shown above the table"- );+ .dom(".query-results-modes")+ .exists("the chart/table toggle buttons are rendered");});test("renders a chart when data has two columns and numbers in the second column", async function (assert) {@@ -299,6 +295,48 @@ module(assert.dom("canvas").doesNotExist();});+ test("toggle buttons independently show and hide chart and table", async function (assert) {+ const content = {+ colrender: [],+ result_count: 2,+ columns: ["user_name", "like_count"],+ rows: [+ ["user1", 10],+ ["user2", 20],+ ],+ };++ await render(<template><QueryResult @content={{content}} /></template>);++ assert.dom("canvas").exists("chart is visible by default");+ assert.dom("table").exists("table is visible by default");++ await click(".query-results-modes .btn:first-child");+ assert.dom("canvas").doesNotExist("chart is hidden after toggle");+ assert.dom("table").exists("table remains visible");++ await click(".query-results-modes .btn:last-child");+ assert.dom("canvas").doesNotExist("chart stays hidden");+ assert.dom("table").doesNotExist("table is hidden after toggle");++ await click(".query-results-modes .btn:first-child");+ assert.dom("canvas").exists("chart is visible again");+ assert.dom("table").doesNotExist("table stays hidden");+ });++ test("toggle buttons are not shown for non-chartable data", async function (assert) {+ const content = {+ colrender: [],+ result_count: 2,+ columns: ["user_name"],+ rows: [["user1"], ["user2"]],+ };++ await render(<template><QueryResult @content={{content}} /></template>);++ assert.dom(".query-results-modes").doesNotExist();+ });+test("handles no results", async function (assert) {const content = {colrender: [],