@bundle-stats/ui 4.13.0-beta.2 → 4.13.0-beta.21

package/src/components/metrics-display-selector/metrics-display-selector.stories.tsx

@@ -0,0 +1,33 @@
+import { action } from '@storybook/addon-actions'; // eslint-disable-line
+import { Meta, StoryObj } from '@storybook/react';
+
+import { MetricsDisplayType } from '../../constants';
+import { MetricsDisplaySelector } from '.';
+
+const meta: Meta<typeof MetricsDisplaySelector> = {
+  title: 'Components/MetricsDisplaySelector',
+  component: MetricsDisplaySelector,
+  args: {
+    onSelect: action('SELECT'),
+  },
+} as Meta;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    value: MetricsDisplayType.TABLE,
+  },
+};
+
+export const TreemapGroups: Story = {
+  args: {
+    value: MetricsDisplayType.TREEMAP,
+    groupBy: '',
+    groups: {
+      [MetricsDisplayType.TREEMAP]: ['folder'],
+    },
+  },
+};

package/src/components/metrics-display-selector/metrics-display-selector.tsx

@@ -2,46 +2,104 @@ import React from 'react';
 import cx from 'classnames';
 
 import { MetricsDisplayType } from '../../constants';
-import { FlexStack } from '../../layout/flex-stack';
 import { Button } from '../../ui/button';
+import { ControlGroup } from '../../ui/control-group';
+import { Dropdown, DropdownItem } from '../../ui/dropdown';
 import { Icon } from '../../ui/icon';
 import css from './metrics-display-selector.module.css';
+import { FlexStack } from '../../layout';
+
+const DEFAULT_GROUP_BY = '';
+
+const METRICS_DISPLAY_MAP = {
+  [MetricsDisplayType.TABLE]: {
+    glyph: Icon.ICONS.TABLE,
+    label: 'Table',
+  },
+  [MetricsDisplayType.TREEMAP]: {
+    glyph: Icon.ICONS.TREEMAP,
+    label: 'Treemap',
+  },
+};
+
+const displayTypes = Object.values(MetricsDisplayType);
 
 interface MetricsDisplaySelectorProps {
   value: MetricsDisplayType;
-  onSelect: (newValue: MetricsDisplayType) => void;
+  groupBy?: string;
+  groups?: Partial<Record<MetricsDisplayType, Array<string>>>;
+  onSelect: (newValue: MetricsDisplayType, groupBy?: string) => void;
 }
 
 export const MetricsDisplaySelector = (
   props: MetricsDisplaySelectorProps &
-    Omit<React.ComponentProps<typeof FlexStack>, 'onSelect' | 'value'>,
+    Omit<React.ComponentProps<typeof ControlGroup>, 'onSelect' | 'value'>,
 ) => {
-  const { className = '', value, onSelect, ...restProps } = props;
+  const { value, groupBy = DEFAULT_GROUP_BY, groups = {}, onSelect, ...restProps } = props;
 
   return (
-    <FlexStack space="xxsmall" as="nav" className={cx(css.root, className)} {...restProps}>
-      <Button
-        outline
-        active={value === MetricsDisplayType.TABLE}
-        size="small"
-        type="button"
-        glyph={Icon.ICONS.TABLE}
-        onClick={() => onSelect(MetricsDisplayType.TABLE)}
-        className={css.button}
-      >
-        Table
-      </Button>
-      <Button
-        outline
-        active={value === MetricsDisplayType.TREEMAP}
-        size="small"
-        type="button"
-        glyph={Icon.ICONS.TREEMAP}
-        onClick={() => onSelect(MetricsDisplayType.TREEMAP)}
-        className={cx(css.button)}
-      >
-        Treemap
-      </Button>
-    </FlexStack>
+    <ControlGroup {...restProps}>
+      {displayTypes.map((displayType, index) => {
+        const displayGroups = groups?.[displayType];
+        const displayProps = METRICS_DISPLAY_MAP[displayType];
+        const isLast = displayTypes.length - 1 === index;
+        const isActive = displayType === value;
+
+        if (!displayGroups || displayGroups.length === 0) {
+          return (
+            <Button
+              outline
+              active={isActive}
+              size="small"
+              type="button"
+              glyph={displayProps.glyph}
+              onClick={() => onSelect(displayType)}
+              className={isLast && css.itemLast}
+              key={displayType}
+            >
+              {displayProps.label}
+            </Button>
+          );
+        }
+
+        const displayGroupsData = [
+          {
+            value: DEFAULT_GROUP_BY,
+            label: 'No groups',
+          },
+          ...displayGroups.map((displayGroup) => ({
+            value: displayGroup,
+            label: `Group by ${displayGroup}`,
+          })),
+        ];
+
+        return (
+          <Dropdown
+            glyph={displayProps.glyph}
+            label={displayProps.label}
+            className={cx(isLast && css.itemLast, isActive && css.buttonActive)}
+            key={displayType}
+          >
+            {displayGroupsData.map((displayGroupData) => {
+              const isGroupActive = isActive && displayGroupData.value === groupBy;
+
+              return (
+                <DropdownItem
+                  onClick={() => onSelect(displayType, displayGroupData.value)}
+                  isActive={isGroupActive}
+                  className={cx(css.dropdownItem, isGroupActive && css.dropdownItemActive)}
+                  key={displayGroupData.value}
+                >
+                  <FlexStack space="xxxsmall" alignItems="center">
+                    <Icon glyph={Icon.ICONS.CHECK} size="small" className={css.dropdownItemIcon} />
+                    <span>{displayGroupData.label}</span>
+                  </FlexStack>
+                </DropdownItem>
+              );
+            })}
+          </Dropdown>
+        );
+      })}
+    </ControlGroup>
   );
 };

package/src/components/metrics-table/metrics-table.i18n.ts

@@ -1,10 +1,3 @@
-export const BASELINE_TITLE = 'Baseline';
-export const CURRENT_TITLE = 'Current';
-
-export const SORT_VALUE = 'value';
-export const SORT_CHANGE = 'change';
-export const SORT_PERCENTUAL_CHANGE = 'percentual change';
-
 export const EMPTY_MESSAGE = 'No items found.';
 export const SHOW_ALL = 'Show all';
 export const SHOW_LESS = 'Show less';

package/src/components/metrics-table/metrics-table.module.css

@@ -10,52 +10,9 @@
   text-decoration: underline;
 }
 
-/* columns */
-.metricName {
-  width: 55%;
-}
-
-.root .jobCol {
-  text-align: right;
-}
-
-.root .value {
-  text-align: right;
-  vertical-align: baseline;
-  width: 15%;
-}
-
+.root .value,
 .root .delta {
   text-align: right;
-  font-size: var(--size-xsmall);
-  vertical-align: baseline;
-  width: 10%;
-  color: pink;
-}
-
-.root .deltaPercentage {
-  width: 5%;
-}
-
-.root tbody .delta {
-  line-height: 1.6rem; /* baseline alignment with the column value */
-}
-
-.jobName {
-  white-space: nowrap;
-}
-
-/* columns overrides for showHeaderSum */
-.showHeaderSum .headerRow .jobCol {
-  border-bottom: 0;
-  padding-bottom: 0;
-}
-
-.showHeaderSum .headerRow .sum {
-  padding-top: var(--space-xxxsmall);
-  font-size: var(--size-small);
-  vertical-align: middle;
-  text-transform: none;
 }
 
 /** rows */

package/src/components/metrics-table/metrics-table.tsx

@@ -1,13 +1,7 @@
 import React from 'react';
 import cx from 'classnames';
 import isEmpty from 'lodash/isEmpty';
-import sum from 'lodash/sum';
-import {
-  METRIC_TYPE_CONFIGS,
-  type MetricRunInfo,
-  MetricTypes,
-  getMetricRunInfo,
-} from '@bundle-stats/utils';
+import type { ReportMetricRow } from '@bundle-stats/utils';
 
 import { Button } from '../../ui/button';
 import { Icon } from '../../ui/icon';
@@ -15,128 +9,17 @@ import { Table } from '../../ui/table';
 import { Stack } from '../../layout/stack';
 import { Metric } from '../metric';
 import { Delta } from '../delta';
-import { JobName } from '../job-name';
-import { SortButton } from '../sort-button';
+import { MetricsTableHeader } from '../metrics-table-header';
 import * as I18N from './metrics-table.i18n';
 import css from './metrics-table.module.css';
 
-const METRIC_TYPE = METRIC_TYPE_CONFIGS[MetricTypes.FileSize];
 const VISIBLE_COUNT = 500;
 const BASELINE_COLUMN_SPAN = 1;
 const CURRENT_COLUMN_SPAN = 3;
 
-interface Run {
-  /**
-   * Run job label
-   */
-  label?: React.ReactNode;
-  /**
-   * Job internal build number
-   */
-  internalBuildNumber: number;
-}
-
-interface Item {
-  key: string;
-  label?: string;
-  changed: boolean;
-  biggerIsBetter: boolean;
-  runs: Array<MetricRunInfo | null>;
-}
-
-const getRowsRunTotal = (rows: Array<Item>, runIndex: number): number =>
-  sum(rows.map((row) => row?.runs?.[runIndex]?.value || 0));
-
-interface JobColumnProps {
-  run: Run;
-  isBaseline: boolean;
-}
-
-const JobColumn = ({ run, isBaseline }: JobColumnProps) => {
-  const colSpan = isBaseline ? BASELINE_COLUMN_SPAN : CURRENT_COLUMN_SPAN;
-  const { label, internalBuildNumber } = run;
-
-  if (!run) {
-    return <Table.Th colSpan={colSpan}>-</Table.Th>;
-  }
-
-  return (
-    <Table.Th className={css.jobCol} colSpan={colSpan}>
-      <JobName
-        title={isBaseline ? I18N.BASELINE_TITLE : I18N.CURRENT_TITLE}
-        internalBuildNumber={internalBuildNumber}
-        className={css.jobName}
-      >
-        {label}
-      </JobName>
-    </Table.Th>
-  );
-};
-
-interface ColumnSumProps {
-  rows: Array<Item>;
-  isBaseline: boolean;
-  runIndex: number;
-  sort?: any;
-  updateSort?: (val: any) => void;
-}
-
-const SumColumn = ({ rows, isBaseline, runIndex, updateSort, sort }: ColumnSumProps) => {
-  const currentRunTotal = getRowsRunTotal(rows, runIndex);
-  const baselineRunTotal = !isBaseline ? getRowsRunTotal(rows, runIndex + 1) : 0;
-  const total = getMetricRunInfo(METRIC_TYPE, currentRunTotal, baselineRunTotal);
-  const fieldPath = `runs[${runIndex}]`;
-
-  return (
-    <>
-      <Table.Th className={cx(css.value, css.sum)}>
-        <SortButton
-          fieldPath={fieldPath}
-          fieldName="value"
-          label={I18N.SORT_VALUE}
-          updateSort={updateSort}
-          sort={sort}
-        >
-          <Metric value={total.displayValue} />
-        </SortButton>
-      </Table.Th>
-      {!isBaseline && (
-        <>
-          <Table.Th className={cx(css.delta, css.sum)}>
-            <SortButton
-              fieldPath={fieldPath}
-              fieldName="delta"
-              label={I18N.SORT_CHANGE}
-              updateSort={updateSort}
-              sort={sort}
-            >
-              {'delta' in total && (
-                <Delta displayValue={total.displayDelta} deltaType={total.deltaType} />
-              )}
-            </SortButton>
-          </Table.Th>
-          <Table.Th className={cx(css.delta, css.deltaPercentage, css.sum)}>
-            <SortButton
-              fieldPath={fieldPath}
-              fieldName="deltaPercentage"
-              label={I18N.SORT_PERCENTUAL_CHANGE}
-              updateSort={updateSort}
-              sort={sort}
-            >
-              {'delta' in total && (
-                <Delta displayValue={total.displayDeltaPercentage} deltaType={total.deltaType} />
-              )}
-            </SortButton>
-          </Table.Th>
-        </>
-      )}
-    </>
-  );
-};
-
 interface RowProps extends React.ComponentProps<typeof Table.Tr> {
-  item: Item;
-  renderHeader: (item: Item) => React.ReactNode;
+  item: ReportMetricRow;
+  renderHeader: (item: ReportMetricRow) => React.ReactNode;
 }
 
 const Row = ({ className = '', item, renderHeader, ...restProps }: RowProps) => (
@@ -185,14 +68,15 @@ const Row = ({ className = '', item, renderHeader, ...restProps }: RowProps) =>
 
 interface MetricsTableProps extends Omit<React.ComponentProps<typeof Table>, 'title'> {
   runs: Array<{
+    label: string;
     internalBuildNumber: number;
   }>;
-  items: Array<Item>;
+  items: Array<ReportMetricRow>;
   title?: React.ReactNode;
   showHeaderSum?: boolean;
   sort?: any;
   updateSort?: (val: any) => void;
-  renderRowHeader?: (item: Item) => React.ReactNode;
+  renderRowHeader?: (item: ReportMetricRow) => React.ReactNode;
   emptyMessage?: React.ReactNode;
   showAllItems: boolean;
   setShowAllItems: (value: boolean) => void;
@@ -203,7 +87,7 @@ export const MetricsTable = ({
   runs,
   items,
   showHeaderSum = false,
-  title = '',
+  title,
   sort,
   updateSort,
   renderRowHeader = (item: any) => item.label,
@@ -214,12 +98,7 @@ export const MetricsTable = ({
 }: MetricsTableProps) => {
   const columnCount = (runs.length - 1) * CURRENT_COLUMN_SPAN + BASELINE_COLUMN_SPAN + 1;
 
-  const rootClassName = cx(
-    css.root,
-    className,
-    runs.length > 1 && css.multipleRuns,
-    showHeaderSum && css.showHeaderSum,
-  );
+  const rootClassName = cx(css.root, className, runs.length > 1 && css.multipleRuns);
 
   const showEmpty = isEmpty(items);
   const showItems = !showEmpty;
@@ -228,29 +107,14 @@ export const MetricsTable = ({
 
   return (
     <Table className={rootClassName} compact {...restProps}>
-      <Table.THead>
-        <Table.Tr className={css.headerRow}>
-          <Table.Th className={css.metricName} rowSpan={showHeaderSum ? 2 : 1}>
-            {title || ' '}
-          </Table.Th>
-          {runs.map((run, runIndex) => (
-            <JobColumn run={run} isBaseline={runIndex === runs.length - 1} />
-          ))}
-        </Table.Tr>
-        {showHeaderSum && (
-          <Table.Tr className={css.headerRow}>
-            {runs.map((_, runIndex) => (
-              <SumColumn
-                rows={items}
-                isBaseline={runIndex === runs.length - 1}
-                runIndex={runIndex}
-                updateSort={updateSort}
-                sort={sort}
-              />
-            ))}
-          </Table.Tr>
-        )}
-      </Table.THead>
+      <MetricsTableHeader
+        metricTitle={title}
+        showSum={showHeaderSum}
+        jobs={runs}
+        rows={items}
+        sort={sort}
+        updateSort={updateSort}
+      />
       <Table.TBody>
         {showEmpty && (
           <Table.Tr>

package/src/components/metrics-table-header/index.ts

@@ -0,0 +1 @@
+export * from './metrics-table-header';

package/src/components/metrics-table-header/metrics-table-header.i18n.ts

@@ -0,0 +1,6 @@
+export const BASELINE_TITLE = 'Baseline';
+export const CURRENT_TITLE = 'Current';
+
+export const SORT_VALUE = 'value';
+export const SORT_CHANGE = 'change';
+export const SORT_PERCENTUAL_CHANGE = 'percentual change';

package/src/components/metrics-table-header/metrics-table-header.module.css

@@ -0,0 +1,51 @@
+/* columns */
+.root .col {
+  padding-top: var(--space-xxsmall);
+  padding-bottom: var(--space-xxsmall);
+}
+
+.root .metric {
+  width: 55%;
+  vertical-align: middle;
+}
+
+.root .job {
+  padding-top: var(--space-xxsmall);
+  text-align: right;
+}
+
+.root .value {
+  text-align: right;
+  vertical-align: baseline;
+  width: 15%;
+}
+
+.root .delta {
+  text-align: right;
+  font-size: var(--size-xsmall);
+  vertical-align: baseline;
+  width: 10%;
+  color: pink;
+}
+
+.root .deltaPercentage {
+  width: 5%;
+}
+
+.jobName {
+  white-space: nowrap;
+}
+
+/* columns overrides for showHeaderSum */
+.showHeaderSum .job {
+  border-bottom: 0;
+  padding-bottom: 0;
+}
+
+.showHeaderSum .sum {
+  padding-top: 0;
+  font-size: var(--size-small);
+  vertical-align: middle;
+  text-transform: none;
+}
+

package/src/components/metrics-table-header/metrics-table-header.tsx

@@ -0,0 +1,172 @@
+import React from 'react';
+import cx from 'classnames';
+import sum from 'lodash/sum';
+import {
+  METRIC_TYPE_CONFIGS,
+  MetricTypes,
+  type ReportMetricRow,
+  getMetricRunInfo,
+} from '@bundle-stats/utils';
+
+import { Table } from '../../ui/table';
+import { Delta } from '../delta';
+import { JobName } from '../job-name';
+import { Metric } from '../metric';
+import { SortButton } from '../sort-button';
+import * as I18N from './metrics-table-header.i18n';
+import css from './metrics-table-header.module.css';
+
+const METRIC_TYPE = METRIC_TYPE_CONFIGS[MetricTypes.FileSize];
+const BASELINE_COLUMN_SPAN = 1;
+const CURRENT_COLUMN_SPAN = 3;
+
+interface JobColumnProps {
+  job: { label: string; internalBuildNumber: number };
+  isBaseline: boolean;
+}
+
+const JobColumn = ({ job, isBaseline }: JobColumnProps) => {
+  const colSpan = isBaseline ? BASELINE_COLUMN_SPAN : CURRENT_COLUMN_SPAN;
+  const { label, internalBuildNumber } = job;
+
+  if (!job) {
+    return <Table.Th colSpan={colSpan}>-</Table.Th>;
+  }
+
+  return (
+    <Table.Th className={cx(css.col, css.job)} colSpan={colSpan}>
+      <JobName
+        title={isBaseline ? I18N.BASELINE_TITLE : I18N.CURRENT_TITLE}
+        internalBuildNumber={internalBuildNumber}
+        className={css.jobName}
+      >
+        {label}
+      </JobName>
+    </Table.Th>
+  );
+};
+
+const getRowsRunTotal = (rows: Array<ReportMetricRow>, runIndex: number): number =>
+  sum(rows.map((row) => row?.runs?.[runIndex]?.value || 0));
+
+interface ColumnSumProps {
+  rows: Array<ReportMetricRow>;
+  isBaseline: boolean;
+  runIndex: number;
+  sort?: any;
+  updateSort?: (val: any) => void;
+}
+
+const SumColumn = ({ rows, isBaseline, runIndex, updateSort, sort }: ColumnSumProps) => {
+  const currentRunTotal = getRowsRunTotal(rows, runIndex);
+  const baselineRunTotal = !isBaseline ? getRowsRunTotal(rows, runIndex + 1) : 0;
+  const total = getMetricRunInfo(METRIC_TYPE, currentRunTotal, baselineRunTotal);
+  const fieldPath = `runs[${runIndex}]`;
+
+  return (
+    <>
+      <Table.Th className={cx(css.col, css.value, css.sum)}>
+        <SortButton
+          fieldPath={fieldPath}
+          fieldName="value"
+          label={I18N.SORT_VALUE}
+          updateSort={updateSort}
+          sort={sort}
+        >
+          <Metric value={total.displayValue} />
+        </SortButton>
+      </Table.Th>
+      {!isBaseline && (
+        <>
+          <Table.Th className={cx(css.col, css.delta, css.sum)}>
+            <SortButton
+              fieldPath={fieldPath}
+              fieldName="delta"
+              label={I18N.SORT_CHANGE}
+              updateSort={updateSort}
+              sort={sort}
+            >
+              {'delta' in total && (
+                <Delta displayValue={total.displayDelta} deltaType={total.deltaType} />
+              )}
+            </SortButton>
+          </Table.Th>
+          <Table.Th className={cx(css.col, css.delta, css.deltaPercentage, css.sum)}>
+            <SortButton
+              fieldPath={fieldPath}
+              fieldName="deltaPercentage"
+              label={I18N.SORT_PERCENTUAL_CHANGE}
+              updateSort={updateSort}
+              sort={sort}
+            >
+              {'delta' in total && (
+                <Delta displayValue={total.displayDeltaPercentage} deltaType={total.deltaType} />
+              )}
+            </SortButton>
+          </Table.Th>
+        </>
+      )}
+    </>
+  );
+};
+
+interface MetricsTableHeaderProps {
+  /**
+   * Metric column title
+   */
+  metricTitle?: React.ReactNode;
+  /**
+   * Show column sum flag
+   */
+  showSum?: boolean;
+  /**
+   * Array of jobs
+   */
+  jobs: Array<{ label: string; internalBuildNumber: number }>;
+  /**
+   * Report rows
+   */
+  rows: Array<ReportMetricRow>;
+  /**
+   * Sort field data
+   */
+  sort?: any;
+  /**
+   * Update sort field
+   */
+  updateSort?: (val: any) => void;
+}
+
+export const MetricsTableHeader = (
+  props: MetricsTableHeaderProps & React.ComponentProps<'thead'>,
+) => {
+  const { className = '', metricTitle = '', showSum = false, jobs, rows, sort, updateSort } = props;
+
+  const rootClassName = cx(css.root, showSum && css.showHeaderSum, className);
+
+  return (
+    <Table.THead className={rootClassName}>
+      <Table.Tr>
+        <Table.Th className={cx(css.col, css.metric)} rowSpan={showSum ? 2 : 1}>
+          {metricTitle || ' '}
+        </Table.Th>
+        {jobs.map((job, runIndex) => (
+          <JobColumn job={job} isBaseline={runIndex === jobs.length - 1} />
+        ))}
+      </Table.Tr>
+      {showSum && (
+        <Table.Tr>
+          {jobs.map((_, runIndex) => (
+            <SumColumn
+              rows={rows}
+              isBaseline={runIndex === jobs.length - 1}
+              runIndex={runIndex}
+              updateSort={updateSort}
+              sort={sort}
+            />
+          ))}
+        </Table.Tr>
+      )}
+    </Table.THead>
+  );
+};