A platform for community discussion. Free, open, simple.
UX: Admin dashboard > refactor manage reports modal (#40329)
chapoi43206c17e05c
diff --git a/app/assets/stylesheets/admin/admin_dashboard.scss b/app/assets/stylesheets/admin/admin_dashboard.scssindex fda4397d920..851278121eb 100644--- a/app/assets/stylesheets/admin/admin_dashboard.scss+++ b/app/assets/stylesheets/admin/admin_dashboard.scss@@ -895,121 +895,3 @@ h1 {.db-reports {display: contents;}--.manage-reports__search-wrapper {- padding: var(--space-2) 1.5rem;- border-bottom: 1px solid var(--primary-low);- background: var(--secondary);-}--.manage-reports-modal .d-modal__footer .manage-reports__apply {- margin-inline-start: auto;-}--.manage-reports-modal .d-modal__body {- padding-inline: 0;- padding-block: var(--space-3);-}--.manage-reports {- display: flex;- flex-direction: column;- gap: var(--space-3);-- &__section-header {- display: flex;- align-items: baseline;- justify-content: space-between;- gap: var(--space-2);- padding-inline: 1.5rem;- }-- &__counter {- color: var(--primary-medium);- font-size: var(--font-down-1-rem);- }-- &__group-title {- margin: 0;- padding-inline: 1.5rem;- font-size: var(--font-down-1-rem);- color: var(--primary-medium);- text-transform: uppercase;- letter-spacing: 0.05em;- }-- &__section-header &__group-title {- padding-inline: 0;- }-- &__list {- display: flex;- flex-direction: column;- list-style: none;- margin: 0;- padding: 0;- border-top: 1px solid var(--primary-low);- }-- &__row {- display: flex;- align-items: center;- gap: var(--space-2);- padding: var(--space-3) 1.5rem;- border-bottom: 1px solid var(--primary-low);- background: var(--secondary);-- &[draggable="true"] {- cursor: grab;- }- }-- &__grip {- color: var(--primary-medium);- display: inline-flex;- }-- &__row-text {- display: flex;- flex-direction: column;- gap: var(--space-half);- flex: 1 1 auto;- min-width: 0;- }-- &__row-heading {- display: flex;- align-items: center;- gap: var(--space-2);- min-width: 0;- }-- &__title {- font-weight: 600;- overflow: hidden;- text-overflow: ellipsis;- white-space: nowrap;- min-width: 0;- }-- &__label {- color: var(--primary-high);- background: var(--primary-low);- border-radius: 4px;- font-size: var(--font-down-3);- padding: var(--space-half) var(--space-2);- flex: 0 0 auto;- white-space: nowrap;- }-- &__description {- margin: 0;- color: var(--primary-medium);- font-size: var(--font-down-1);- }-- &__arrow,- &__toggle {- flex: 0 0 auto;- }-}diff --git a/app/assets/stylesheets/common/modal/_index.scss b/app/assets/stylesheets/common/modal/_index.scssindex 142e213533b..cd4744ea891 100644--- a/app/assets/stylesheets/common/modal/_index.scss+++ b/app/assets/stylesheets/common/modal/_index.scss@@ -2,3 +2,4 @@@import "user-status";@import "discourse-reactions-popup";@import "change-reply-to";+@import "manage-reports-modal";diff --git a/app/assets/stylesheets/common/modal/manage-reports-modal.scss b/app/assets/stylesheets/common/modal/manage-reports-modal.scssnew file mode 100644index 00000000000..a17e52e10d6--- /dev/null+++ b/app/assets/stylesheets/common/modal/manage-reports-modal.scss@@ -0,0 +1,115 @@+@use "lib/viewport";++.manage-reports {+ .d-modal__body {+ padding-inline: 0;+ padding-block: var(--space-3);+ }++ &__search-wrapper {+ padding: var(--space-2) 1.5rem;+ border-bottom: 1px solid var(--primary-low);+ background: var(--secondary);+ }++ &__counter {+ color: var(--primary-medium);+ font-size: var(--font-down-2-rem);+ }++ &__list {+ display: flex;+ flex-direction: column;+ list-style: none;+ margin: 0;+ padding: 0;+ }++ &__row {+ display: flex;+ align-items: center;+ gap: var(--space-3);+ padding: var(--space-3) var(--space-6);+ background: var(--secondary);++ &:not(:last-child) {+ border-bottom: 1px solid var(--primary-low);+ }++ &[draggable="true"] {+ cursor: grab;+ }++ @include viewport.until(sm) {+ padding-inline: var(--space-3) var(--space-6);+ }+ }++ &__grip {+ align-self: flex-start;+ color: var(--primary-low-mid);+ visibility: hidden;++ .manage-reports__row.--enabled & {+ visibility: visible;+ }+ }++ &__order-mobile {+ display: flex;+ flex-direction: column;+ gap: var(--space-2);+ visibility: hidden;++ .manage-reports__row.--enabled & {+ visibility: visible;+ }+ }++ &__row-text {+ display: flex;+ flex-direction: column;+ gap: var(--space-half);+ flex: 1 1 auto;+ min-width: 0;+ }++ &__row-heading {+ display: flex;+ align-items: center;+ gap: var(--space-2);+ min-width: 0;+ }++ &__title {+ font-weight: 600;+ overflow: hidden;+ text-overflow: ellipsis;+ white-space: nowrap;+ min-width: 0;+ }++ &__label {+ color: var(--primary-high);+ background: var(--primary-low);+ border-radius: 4px;+ font-size: var(--font-down-3);+ white-space: nowrap;+ padding: var(--space-half) var(--space-2);+ line-height: normal;+ }++ &__description {+ margin: 0;+ color: var(--primary-medium);+ font-size: var(--font-down-1);+ }++ &__arrow {+ flex: 0 0 auto;+ }++ .d-modal__footer {+ justify-content: flex-end;+ }+}diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex e48574dc747..e775630e72a 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -6959,13 +6959,14 @@ en:modal:title: "Manage reports"search_placeholder: "Search reports"- counter: "%{count} / %{max} reports"+ counter: "%{count} / %{max} reports added"enabled_heading: "Enabled"all_heading: "All reports"apply: "Apply"- toggle: "Toggle report"- move_up: "Move up"- move_down: "Move down"+ enable: "Enable %{title}"+ disable: "Disable %{title}"+ move_up: "Move %{title} up"+ move_down: "Move %{title} down"configure:button: "Configure"diff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex 2f886dd9b04..9ee46eea4a2 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -1392,7 +1392,7 @@ en:vs_prior: "Vs Prior"posters_by_member_type:title: "Who's posting?"- description: "Posts authored in the selected period, bucketed by member type. \"New members\" signed up during the period, \"Returning\" signed up before it, and \"Staff\" are admins or moderators."+ description: 'Posts authored in the selected period, bucketed by member type. "New members" signed up during the period, "Returning" signed up before it, and "Staff" are admins or moderators.'labels:member_type: "Member type"count: "Posts"@@ -2128,7 +2128,7 @@ en:google_oauth2_client_secret: "Client secret of your Google application."google_oauth2_prompt: "An optional space-delimited list of string values that specifies whether the authorization server prompts the user for reauthentication and consent. See <a href='https://developers.google.com/identity/protocols/OpenIDConnect#prompt' target='_blank'>https://developers.google.com/identity/protocols/OpenIDConnect#prompt</a> for the possible values."google_oauth2_hd: "An optional Google Apps Hosted domain that the sign-in will be limited to. See <a href='https://developers.google.com/identity/protocols/OpenIDConnect#hd-param' target='_blank'>https://developers.google.com/identity/protocols/OpenIDConnect#hd-param</a> for more details."- google_oauth2_hd_groups: "Retrieve users' Google groups on the hosted domain on authentication. Retrieved Google groups can be used to grant automatic Discourse group membership (see group settings). For more information, see <a target=\"_blank\" href=\"https://meta.discourse.org/t/226850\">this Meta topic</a>."+ google_oauth2_hd_groups: 'Retrieve users'' Google groups on the hosted domain on authentication. Retrieved Google groups can be used to grant automatic Discourse group membership (see group settings). For more information, see <a target="_blank" href="https://meta.discourse.org/t/226850">this Meta topic</a>.'google_oauth2_hd_groups_service_account_admin_email: "An email address belonging to a Google Workspace administrator account. Will be used with the service account credentials to fetch group information."google_oauth2_hd_groups_service_account_json: "JSON formatted key information for the Service Account. Will be used to fetch group information."google_oauth2_verbose_logging: "Log verbose Google OAuth2 related diagnostics to <a href='%{base_path}/logs' target='_blank'>/logs</a>"@@ -2164,7 +2164,7 @@ en:s3_configure_tombstone_policy: "Enable automatic deletion policy for tombstone uploads. IMPORTANT: If disabled, no space will be reclaimed after uploads are deleted."s3_disable_cleanup: "Prevent removal of old backups from S3 when there are more backups than the maximum allowed."s3_use_acls: "AWS recommends not using ACLs on S3 buckets; only uncheck this option if intend to configure permissions policies on the configured `s3_upload_bucket` and `s3_backup_bucket`."- enable_direct_s3_uploads: "Allows for direct multipart uploads to Amazon S3, see <a target=\"_blank\" href=\"https://meta.discourse.org/t/a-new-era-for-file-uploads-in-discourse/210469\">this Meta topic</a> for more details."+ enable_direct_s3_uploads: 'Allows for direct multipart uploads to Amazon S3, see <a target="_blank" href="https://meta.discourse.org/t/a-new-era-for-file-uploads-in-discourse/210469">this Meta topic</a> for more details.'backup_time_of_day: "Time of day UTC when the backup should occur."backup_with_uploads: "Include uploads in scheduled backups. Disabling this will only backup the database."backup_location: "Location where backups are stored. IMPORTANT: S3 requires valid S3 credentials entered in <a href='%{base_path}/admin/site_settings/category/files'>Files settings</a>. When changing this to S3 from Local, you must run the `s3:ensure_cors_rules` rake task."diff --git a/frontend/discourse/admin/components/modal/manage-reports.gjs b/frontend/discourse/admin/components/modal/manage-reports.gjsindex 8503cc11a88..f6798190f25 100644--- a/frontend/discourse/admin/components/modal/manage-reports.gjs+++ b/frontend/discourse/admin/components/modal/manage-reports.gjs@@ -15,6 +15,7 @@ import DFilterInput from "discourse/ui-kit/d-filter-input";import DLoadMore from "discourse/ui-kit/d-load-more";import DModal from "discourse/ui-kit/d-modal";import DToggleSwitch from "discourse/ui-kit/d-toggle-switch";+import dConcatClass from "discourse/ui-kit/helpers/d-concat-class";import dIcon from "discourse/ui-kit/helpers/d-icon";import { i18n } from "discourse-i18n";@@ -62,12 +63,27 @@ export default class ManageReports extends Component {return this.allKeys.map((key) => this.itemsByKey.get(key)).filter(Boolean);}- get visibleEnabled() {- return this.enabledRows;+ get disabledRows() {+ return this.allRows.filter((row) => !this.enabledKeys.has(row.key));}- get visibleAll() {- return this.allRows;+ get filteredEnabledRows() {+ const query = this.search.trim().toLowerCase();+ if (!query) {+ return this.enabledRows;+ }+ return this.enabledRows.filter(+ (row) =>+ (row.title ?? "").toLowerCase().includes(query) ||+ (row.description ?? "").toLowerCase().includes(query)+ );+ }++ get visibleRows() {+ return [+ ...this.filteredEnabledRows.map((row) => ({ ...row, enabled: true })),+ ...this.disabledRows.map((row) => ({ ...row, enabled: false })),+ ];}get atCap() {@@ -147,7 +163,6 @@ export default class ManageReports extends Component {const page = response.available ?? [];this.cacheItems(enabled);this.cacheItems(page);- this.enabledOrder = enabled.map((item) => item.key);this.allKeys = page.map((item) => item.key);this.nextCursor = response.cursor ?? null;this.hasMore = !!response.has_more;@@ -250,8 +265,19 @@ export default class ManageReports extends Component {<DModal@title={{i18n "admin.dashboard.reports_section.modal.title"}}@closeModal={{@closeModal}}- class="manage-reports-modal"+ class="manage-reports has-search">++ <:belowModalTitle>+ <span class="manage-reports__counter">+ {{i18n+ "admin.dashboard.reports_section.modal.counter"+ count=this.enabledOrder.length+ max=VISIBLE_CAP+ }}+ </span>+ </:belowModalTitle>+<:belowHeader><div class="manage-reports__search-wrapper"><DFilterInput@@ -266,124 +292,93 @@ export default class ManageReports extends Component {</:belowHeader><:body>- <div class="manage-reports">- {{#if this.visibleEnabled.length}}- <div class="manage-reports__section-header">- <h3 class="manage-reports__group-title">- {{i18n "admin.dashboard.reports_section.modal.enabled_heading"}}- </h3>- <span class="manage-reports__counter">- {{i18n- "admin.dashboard.reports_section.modal.counter"- count=this.enabledOrder.length- max=VISIBLE_CAP++ {{#if this.visibleRows.length}}+ <ul class="manage-reports__list">+ {{#each this.visibleRows key="key" as |row index|}}+ <li+ class={{dConcatClass+ "manage-reports__row"+ (if row.enabled "--enabled")}}- </span>- </div>- <ul class="manage-reports__list manage-reports__list--enabled">- {{#each this.visibleEnabled key="key" as |row index|}}- <li- class="manage-reports__row"- draggable="true"- data-identifier={{row.key}}- {{on "dragstart" (fn this.onDragStart row)}}- {{on "dragover" this.onDragOver}}- {{on "drop" (fn this.onDrop row)}}- {{on "dragend" this.onDragEnd}}- >- {{#unless this.site.mobileView}}- <span class="manage-reports__grip">- {{dIcon "grip-lines"}}- </span>- {{/unless}}- <div class="manage-reports__row-text">- <div class="manage-reports__row-heading">- <span class="manage-reports__title">{{row.title}}</span>- {{#if this.showLabels}}- <span- class="manage-reports__label"- data-source={{row.source}}- >{{row.label}}</span>- {{/if}}- </div>- {{#if row.description}}- <p- class="manage-reports__description"- >{{row.description}}</p>- {{/if}}- </div>- {{#if this.site.mobileView}}+ data-identifier={{row.key}}+ draggable={{row.enabled}}+ {{on "dragstart" (fn this.onDragStart row)}}+ {{on "dragover" this.onDragOver}}+ {{on "drop" (fn this.onDrop row)}}+ {{on "dragend" this.onDragEnd}}+ >++ {{#unless this.site.mobileView}}+ <span class="manage-reports__grip">+ {{dIcon "grip-vertical"}}+ </span>+ {{/unless}}++ {{#if this.site.mobileView}}+ <div class="manage-reports__order-mobile"><DButton@icon="arrow-up"@action={{fn this.moveUp row}}@disabled={{eq index 0}}@translatedAriaLabel={{i18n"admin.dashboard.reports_section.modal.move_up"+ title=row.title}}- class="manage-reports__arrow btn-transparent btn-small"+ class="manage-reports__arrow btn-transparent"/><DButton@icon="arrow-down"@action={{fn this.moveDown row}}@translatedAriaLabel={{i18n"admin.dashboard.reports_section.modal.move_down"+ title=row.title}}- class="manage-reports__arrow btn-transparent btn-small"+ class="manage-reports__arrow btn-transparent"/>- {{/if}}- <DToggleSwitch- @state={{this.isEnabled row}}- aria-label={{i18n- "admin.dashboard.reports_section.modal.toggle"- }}- {{on "click" (fn this.toggle row)}}- />- </li>- {{/each}}- </ul>- {{/if}}-- {{#if this.visibleAll.length}}- <h3 class="manage-reports__group-title">- {{i18n "admin.dashboard.reports_section.modal.all_heading"}}- </h3>- <ul class="manage-reports__list manage-reports__list--all">- {{#each this.visibleAll key="key" as |row|}}- <li class="manage-reports__row" data-identifier={{row.key}}>- <div class="manage-reports__row-text">- <div class="manage-reports__row-heading">- <span class="manage-reports__title">{{row.title}}</span>- {{#if this.showLabels}}- <span- class="manage-reports__label"- data-source={{row.source}}- >{{row.label}}</span>- {{/if}}- </div>- {{#if row.description}}- <p- class="manage-reports__description"- >{{row.description}}</p>+ </div>+ {{/if}}++ <div class="manage-reports__row-text">+ <div class="manage-reports__row-heading">+ <span class="manage-reports__title">{{row.title}}</span>+ {{#if this.showLabels}}+ <span+ class="manage-reports__label"+ data-source={{row.source}}+ >{{row.label}}</span>{{/if}}</div>- <DToggleSwitch- @state={{this.isEnabled row}}- disabled={{this.toggleDisabled row}}- aria-label={{i18n- "admin.dashboard.reports_section.modal.toggle"- }}- {{on "click" (fn this.toggle row)}}- />- </li>- {{/each}}- </ul>- <DLoadMore- @action={{this.loadMore}}- @enabled={{this.hasMore}}- @isLoading={{this.loading}}- />- {{/if}}- </div>+ {{#if row.description}}+ <p+ class="manage-reports__description"+ >{{row.description}}</p>+ {{/if}}+ </div>++ <DToggleSwitch+ @state={{row.enabled}}+ disabled={{this.toggleDisabled row}}+ aria-label={{i18n+ (if+ row.enabled+ "admin.dashboard.reports_section.modal.disable"+ "admin.dashboard.reports_section.modal.enable"+ )+ title=row.title+ }}+ {{on "click" (fn this.toggle row)}}+ />+ </li>+ {{/each}}+ </ul>+ <DLoadMore+ @action={{this.loadMore}}+ @enabled={{this.hasMore}}+ @isLoading={{this.loading}}+ />+ {{/if}}+</:body><:aboveFooter>diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/connectors/admin-dashboard-manage-reports-footer/data-explorer-hint.gjs b/plugins/discourse-data-explorer/assets/javascripts/discourse/connectors/admin-dashboard-manage-reports-footer/data-explorer-hint.gjsindex 3c6b156d457..19f21ff0dda 100644--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/connectors/admin-dashboard-manage-reports-footer/data-explorer-hint.gjs+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/connectors/admin-dashboard-manage-reports-footer/data-explorer-hint.gjs@@ -6,16 +6,16 @@ import { i18n } from "discourse-i18n";<LinkTo@route="adminPlugins.show.explorer.new"@model="discourse-data-explorer"- class="de-manage-reports-hint"+ class="de-cta">- <div class="de-manage-reports-hint__text">- <span class="de-manage-reports-hint__title">+ <div class="de-cta__text">+ <span class="de-cta__title">{{i18n "data_explorer.manage_reports_hint.title"}}</span>- <span class="de-manage-reports-hint__description">+ <span class="de-cta__description">{{i18n "data_explorer.manage_reports_hint.description"}}</span></div>- {{dIcon "chevron-right" class="de-manage-reports-hint__chevron"}}+ {{dIcon "chevron-right" class="de-cta__chevron"}}</LinkTo></template>diff --git a/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss b/plugins/discourse-data-explorer/assets/stylesheets/explorer.scssindex dc80193606c..2d56344d46b 100644--- a/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss+++ b/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss@@ -23,7 +23,7 @@}}-.de-manage-reports-hint {+.de-cta {display: flex;align-items: center;gap: var(--space-2);diff --git a/plugins/discourse-data-explorer/spec/system/page_objects/components/admin_dashboard_manage_reports_hint.rb b/plugins/discourse-data-explorer/spec/system/page_objects/components/admin_dashboard_manage_reports_hint.rbindex 6fc4a6c0a77..5836ca085b9 100644--- a/plugins/discourse-data-explorer/spec/system/page_objects/components/admin_dashboard_manage_reports_hint.rb+++ b/plugins/discourse-data-explorer/spec/system/page_objects/components/admin_dashboard_manage_reports_hint.rb@@ -3,7 +3,7 @@module PageObjectsmodule Componentsclass AdminDashboardManageReportsHint < PageObjects::Components::Base- SELECTOR = ".manage-reports-modal .de-manage-reports-hint"+ SELECTOR = ".manage-reports .de-cta"def has_hint?has_css?(SELECTOR)diff --git a/spec/system/page_objects/components/manage_reports_modal.rb b/spec/system/page_objects/components/manage_reports_modal.rbindex dc0f9ae83a7..e246f0fdfed 100644--- a/spec/system/page_objects/components/manage_reports_modal.rb+++ b/spec/system/page_objects/components/manage_reports_modal.rb@@ -3,7 +3,9 @@module PageObjectsmodule Componentsclass ManageReportsModal < PageObjects::Components::Base- MODAL = ".manage-reports-modal"+ MODAL = ".manage-reports"+ ROW = ".manage-reports__row"+ ENABLED_ROW = ".manage-reports__row.--enabled"def has_open?has_css?(MODAL)@@ -19,29 +21,15 @@ module PageObjectsenddef enabled_identifiers- within("#{MODAL} .manage-reports__list--enabled") do- all(".manage-reports__row").map { |el| el["data-identifier"] }- end- end-- def all_identifiers- within("#{MODAL} .manage-reports__list--all") do- all(".manage-reports__row").map { |el| el["data-identifier"] }- end+ all("#{MODAL} #{ENABLED_ROW}").map { |el| el["data-identifier"] }enddef has_all_row?(identifier)- has_css?(- "#{MODAL} .manage-reports__list--all " \- ".manage-reports__row[data-identifier='#{identifier}']",- )+ has_css?("#{MODAL} #{ROW}[data-identifier='#{identifier}']")enddef has_no_all_row?(identifier)- has_no_css?(- "#{MODAL} .manage-reports__list--all " \- ".manage-reports__row[data-identifier='#{identifier}']",- )+ has_no_css?("#{MODAL} #{ROW}[data-identifier='#{identifier}']")enddef toggle(identifier)@@ -50,36 +38,18 @@ module PageObjectsenddef has_toggle_on?(identifier)- has_css?(- "#{MODAL} .manage-reports__list--enabled " \- ".manage-reports__row[data-identifier='#{identifier}']",- )+ has_css?("#{MODAL} #{ENABLED_ROW}[data-identifier='#{identifier}']")enddef has_toggle_off?(identifier)- has_no_css?(- "#{MODAL} .manage-reports__list--enabled " \- ".manage-reports__row[data-identifier='#{identifier}']",- ) &&- has_css?(- "#{MODAL} .manage-reports__list--all " \- ".manage-reports__row[data-identifier='#{identifier}']",- )+ has_css?("#{MODAL} #{ROW}[data-identifier='#{identifier}']") &&+ has_no_css?("#{MODAL} #{ENABLED_ROW}[data-identifier='#{identifier}']")enddef toggle_for(identifier)- enabled_row =- "#{MODAL} .manage-reports__list--enabled " \- ".manage-reports__row[data-identifier='#{identifier}']"- toggle_selector =- if has_css?(enabled_row, wait: 0)- "#{enabled_row} .d-toggle-switch__checkbox"- else- "#{MODAL} .manage-reports__list--all " \- ".manage-reports__row[data-identifier='#{identifier}'] " \- ".d-toggle-switch__checkbox"- end- PageObjects::Components::DToggleSwitch.new(toggle_selector)+ PageObjects::Components::DToggleSwitch.new(+ "#{MODAL} #{ROW}[data-identifier='#{identifier}'] .d-toggle-switch__checkbox",+ )enddef apply