Merge pull request #72 from Demonstrandum/cursor/collapsible-superimposed-section-b74a

Make superimposed section collapsible like other tag group sections

Author: Demonstrandum

tensorbored/webapp/metrics/actions/index.ts

@@ -206,6 +206,10 @@ export const metricsTagGroupExpansionStateLoaded = createAction(
   props<{expandedGroups: Array<[string, boolean]>}>()
 );
 
+export const metricsSuperimposedSectionExpansionChanged = createAction(
+  '[Metrics] Superimposed Section Expansion Changed'
+);
+
 export const cardFullWidthStateLoaded = createAction(
   '[Metrics] Card Full Width State Loaded From Storage',
   props<{fullWidthCardIds: string[]; fullWidthSuperimposedCardIds: string[]}>()

tensorbored/webapp/metrics/effects/index.ts

@@ -108,6 +108,7 @@ import {
   getTagSymlogLinearThresholds,
   getSuperimposedCardsWithMetadata,
   getMetricsTagGroupExpansionMap,
+  getMetricsSuperimposedSectionExpanded,
   getCardStateMap,
   getFullWidthSuperimposedCards,
 } from '../store';
@@ -875,22 +876,23 @@ export class MetricsEffects implements OnInitEffects {
     this.persistTagGroupExpansion$ = this.actions$.pipe(
       ofType(
         actions.metricsTagGroupExpansionChanged,
-        actions.metricsTagMetadataLoaded
+        actions.metricsTagMetadataLoaded,
+        actions.metricsSuperimposedSectionExpansionChanged
       ),
       debounceTime(200),
-      withLatestFrom(this.store.select(getMetricsTagGroupExpansionMap)),
-      tap(([, expansionMap]) => {
+      withLatestFrom(
+        this.store.select(getMetricsTagGroupExpansionMap),
+        this.store.select(getMetricsSuperimposedSectionExpanded)
+      ),
+      tap(([, expansionMap, superimposedExpanded]) => {
         const entries: Array<[string, boolean]> = Array.from(
           expansionMap.entries()
         );
-        if (entries.length > 0) {
-          window.localStorage.setItem(
-            TAG_GROUP_EXPANSION_STORAGE_KEY,
-            JSON.stringify({version: 1, groups: entries})
-          );
-        } else {
-          window.localStorage.removeItem(TAG_GROUP_EXPANSION_STORAGE_KEY);
-        }
+        entries.push(['__superimposed__', superimposedExpanded]);
+        window.localStorage.setItem(
+          TAG_GROUP_EXPANSION_STORAGE_KEY,
+          JSON.stringify({version: 1, groups: entries})
+        );
         window.dispatchEvent(new CustomEvent('tb-tag-group-expansion-changed'));
       })
     );

tensorbored/webapp/metrics/store/metrics_reducers.ts

@@ -502,6 +502,7 @@ const {initialState, reducers: namespaceContextedReducer} =
       superimposedCardMetadataMap: {},
       superimposedCardList: [],
       fullWidthSuperimposedCards: new Set<string>(),
+      superimposedSectionExpanded: true,
     },
     {
       isSettingsPaneOpen: true,
@@ -1280,8 +1281,21 @@ const reducer = createReducer(
     return {...state, tagGroupExpanded};
   }),
   on(actions.metricsTagGroupExpansionStateLoaded, (state, {expandedGroups}) => {
-    const tagGroupExpanded = new Map<string, boolean>(expandedGroups);
-    return {...state, tagGroupExpanded};
+    const superimposedEntry = expandedGroups.find(
+      ([key]) => key === '__superimposed__'
+    );
+    const tagGroupExpanded = new Map<string, boolean>(
+      expandedGroups.filter(([key]) => key !== '__superimposed__')
+    );
+    const superimposedSectionExpanded =
+      superimposedEntry !== undefined ? superimposedEntry[1] : true;
+    return {...state, tagGroupExpanded, superimposedSectionExpanded};
+  }),
+  on(actions.metricsSuperimposedSectionExpansionChanged, (state) => {
+    return {
+      ...state,
+      superimposedSectionExpanded: !state.superimposedSectionExpanded,
+    };
   }),
   on(
     actions.cardFullWidthStateLoaded,

tensorbored/webapp/metrics/store/metrics_selectors.ts

@@ -473,6 +473,11 @@ export const getMetricsTagGroupExpansionMap = createSelector(
   }
 );
 
+export const getMetricsSuperimposedSectionExpanded = createSelector(
+  selectMetricsState,
+  (state: MetricsState): boolean => state.superimposedSectionExpanded
+);
+
 export const getMetricsLinkedTimeEnabled = createSelector(
   selectMetricsState,
   (state: MetricsState): boolean => {

tensorbored/webapp/metrics/store/metrics_types.ts

@@ -242,6 +242,13 @@ export interface MetricsNamespacedState {
    * Set of superimposed card IDs that are displayed at full width.
    */
   fullWidthSuperimposedCards: Set<SuperimposedCardId>;
+
+  /**
+   * Whether the Superimposed section header is expanded (cards visible).
+   * Defaults to true. Persisted in the same localStorage key as tagGroupExpanded,
+   * using the reserved key '__superimposed__'.
+   */
+  superimposedSectionExpanded: boolean;
 }
 
 export interface MetricsSettings {

tensorbored/webapp/metrics/testing.ts

@@ -161,6 +161,7 @@ function buildBlankState(): MetricsState {
     superimposedCardMetadataMap: {},
     superimposedCardList: [],
     fullWidthSuperimposedCards: new Set<string>(),
+    superimposedSectionExpanded: true,
   };
 }
 

tensorbored/webapp/metrics/views/main_view/superimposed_cards_view_component.scss

@@ -21,16 +21,21 @@ limitations under the License.
 
 .group-toolbar {
   @include tb-theme-background-prop(background-color, background);
-  @include tb-theme-foreground-prop(border-bottom, border, 1px solid);
+  @include tb-theme-foreground-prop(color, text);
   align-items: center;
   background-color: #fff;
+  border: 0;
+  @include tb-theme-foreground-prop(border-bottom, border, 1px solid);
+  cursor: pointer;
   display: flex;
   flex: none;
+  font: inherit;
   height: 42px;
   margin-bottom: -1px;
   padding: 0 16px;
   position: sticky;
   top: 0;
+  width: 100%;
   z-index: 1;
   box-shadow: 0px 2px 4px 0px rgba(#000, 15%);
   @include tb-dark-theme {
@@ -40,8 +45,10 @@ limitations under the License.
   .left-items {
     align-items: center;
     display: flex;
+    flex-grow: 1;
     gap: 10px;
     overflow: hidden;
+    text-align: left;
 
     mat-icon {
       color: #673ab7;
@@ -70,6 +77,10 @@ limitations under the License.
   }
 }
 
+.expand-group-icon {
+  @include tb-theme-foreground-prop(color, secondary-text);
+}
+
 .superimposed-cards-grid {
   display: grid;
   grid-template-columns: repeat(

tensorbored/webapp/metrics/views/main_view/superimposed_cards_view_component.ts

@@ -15,8 +15,10 @@ limitations under the License.
 import {
   ChangeDetectionStrategy,
   Component,
+  EventEmitter,
   Input,
   OnChanges,
+  Output,
   SimpleChanges,
 } from '@angular/core';
 import {Store} from '@ngrx/store';
@@ -35,7 +37,14 @@ const MAX_CARD_MIN_WIDTH_IN_PX = 735;
   selector: 'superimposed-cards-view-component',
   template: `
     <ng-container *ngIf="superimposedCards.length > 0">
-      <div class="group-toolbar">
+      <button
+        class="group-toolbar"
+        i18n-aria-label="
+          A button that allows user to expand the superimposed section.
+        "
+        aria-label="Expand superimposed section"
+        (click)="expansionToggled.emit()"
+      >
         <div class="left-items">
           <mat-icon svgIcon="group_work_24px"></mat-icon>
           <span class="group-text">
@@ -47,8 +56,18 @@ const MAX_CARD_MIN_WIDTH_IN_PX = 735;
             >
           </span>
         </div>
-      </div>
+        <span class="expand-group-icon">
+          <mat-icon
+            *ngIf="isExpanded; else expandMore"
+            svgIcon="expand_less_24px"
+          ></mat-icon>
+          <ng-template #expandMore>
+            <mat-icon svgIcon="expand_more_24px"></mat-icon>
+          </ng-template>
+        </span>
+      </button>
       <div
+        *ngIf="isExpanded"
         class="superimposed-cards-grid"
         [style.grid-template-columns]="gridTemplateColumn"
       >
@@ -76,6 +95,8 @@ export class SuperimposedCardsViewComponent implements OnChanges {
   @Input() cardObserver!: CardObserver;
   @Input() superimposedCards: SuperimposedCardMetadata[] = [];
   @Input() cardMinWidth: number | null = null;
+  @Input() isExpanded: boolean = true;
+  @Output() expansionToggled = new EventEmitter<void>();
 
   gridTemplateColumn = '';
 

tensorbored/webapp/metrics/views/main_view/superimposed_cards_view_container.ts

@@ -18,7 +18,11 @@ import {Observable} from 'rxjs';
 import {startWith} from 'rxjs/operators';
 import {State} from '../../../app_state';
 import {getMetricsCardMinWidth} from '../../../selectors';
-import {getSuperimposedCardsWithMetadata} from '../../store';
+import {
+  getSuperimposedCardsWithMetadata,
+  getMetricsSuperimposedSectionExpanded,
+} from '../../store';
+import {metricsSuperimposedSectionExpansionChanged} from '../../actions';
 import {SuperimposedCardMetadata} from '../../types';
 import {CardObserver} from '../card_renderer/card_lazy_loader';
 
@@ -30,6 +34,8 @@ import {CardObserver} from '../card_renderer/card_lazy_loader';
       [superimposedCards]="superimposedCards$ | async"
       [cardObserver]="cardObserver"
       [cardMinWidth]="cardMinWidth$ | async"
+      [isExpanded]="isExpanded$ | async"
+      (expansionToggled)="onExpansionToggled()"
     ></superimposed-cards-view-component>
   `,
   changeDetection: ChangeDetectionStrategy.OnPush,
@@ -39,11 +45,17 @@ export class SuperimposedCardsViewContainer {
 
   readonly superimposedCards$: Observable<SuperimposedCardMetadata[]>;
   readonly cardMinWidth$: Observable<number | null>;
+  readonly isExpanded$: Observable<boolean>;
 
   constructor(private readonly store: Store<State>) {
     this.superimposedCards$ = this.store
       .select(getSuperimposedCardsWithMetadata)
       .pipe(startWith([]));
     this.cardMinWidth$ = this.store.select(getMetricsCardMinWidth);
+    this.isExpanded$ = this.store.select(getMetricsSuperimposedSectionExpanded);
+  }
+
+  onExpansionToggled() {
+    this.store.dispatch(metricsSuperimposedSectionExpansionChanged());
   }
 }