@micha.bigler/ui-core-micha 2.30.0 → 2.31.0

package/src/components/charts/chartDefaults.js

@@ -0,0 +1,111 @@
+export const DEFAULT_LEGEND_POSITION = {
+  vertical: 'bottom',
+  horizontal: 'start',
+};
+
+export function withAxisDefaults(axes, label, defaults, tickFontSize) {
+  const values = axes?.length ? axes : [defaults];
+  return values.map((axis) => ({
+    // `defaults.scaleType` (and any other scale-defining default) must
+    // survive even when the caller passes their OWN xAxis/yAxis array --
+    // confirmed live in the dev harness: a caller-supplied axis with `data`
+    // but no `scaleType` previously lost 'point'/'band' entirely (only
+    // applied when the whole array was absent), leaving MUI's scale
+    // undefined and every point position NaN (`<path> attribute d:
+    // Expected number, "MNaN,..."` in the real rendered SVG -- a mocked
+    // prop-assertion test cannot catch this, it only reproduces on an
+    // actual MUI scale computation).
+    ...defaults,
+    ...axis,
+    tickLabelStyle: {
+      fontSize: tickFontSize,
+      ...axis.tickLabelStyle,
+    },
+    label: axis.label || label,
+  }));
+}
+
+function cssLengthToPixels(value) {
+  if (typeof value === 'number') return value;
+  if (typeof value !== 'string') return 0;
+
+  const parsed = Number.parseFloat(value);
+  if (!Number.isFinite(parsed)) return 0;
+  if (value.endsWith('rem') || value.endsWith('em')) return parsed * 16;
+  return parsed;
+}
+
+const MUI_LABELLED_X_AXIS_HEIGHT = 45;
+const MUI_CHART_MARGIN_BOTTOM = 20;
+const AVERAGE_GLYPH_WIDTH_EM = 0.6;
+
+function formattedTickText(axis, value) {
+  if (!axis.valueFormatter) return String(value);
+  try {
+    return String(axis.valueFormatter(value, { location: 'tick' }));
+  } catch {
+    // Some formatters require MUI's complete scale context. Falling back to
+    // the raw value is conservative: it reserves at least as much space.
+    return String(value);
+  }
+}
+
+function rotatedTickMetrics(axis, defaultLineHeight) {
+  const angle = Number(axis.tickLabelStyle?.angle) || 0;
+  if (angle === 0) return null;
+
+  const fontSize = cssLengthToPixels(axis.tickLabelStyle?.fontSize);
+  if (fontSize === 0) return null;
+
+  const lineHeight = Number(axis.tickLabelStyle?.lineHeight) || defaultLineHeight;
+  const longestLabel = (axis.data || []).reduce((longest, value) => {
+    const text = formattedTickText(axis, value);
+    return text.length > longest.length ? text : longest;
+  }, '');
+  const textWidth = Math.max(fontSize, longestLabel.length * fontSize * AVERAGE_GLYPH_WIDTH_EM);
+  const radians = (angle * Math.PI) / 180;
+  const projectedHeight = Math.abs(Math.cos(radians)) * fontSize * lineHeight
+    + Math.abs(Math.sin(radians)) * textWidth;
+  const extraHeight = Math.max(1, Math.ceil(projectedHeight - fontSize));
+
+  return { extraHeight };
+}
+
+/**
+ * Rotated labels project both their line box and text width vertically.
+ * X-Charts uses xAxis.height when deciding whether a label fits, while margin
+ * only separates the axis from the SVG edge, so both surfaces must grow.
+ * Explicit caller height and bottom-margin values always remain untouched.
+ */
+export function spaceForRotatedTicks(xAxis, margin, defaultLineHeight = 1) {
+  let largestExtraHeight = 0;
+  const spacedXAxis = xAxis.map((axis) => {
+    const metrics = rotatedTickMetrics(axis, defaultLineHeight);
+    if (!metrics) return axis;
+
+    largestExtraHeight = Math.max(largestExtraHeight, metrics.extraHeight);
+    if (axis.height != null) return axis;
+    return { ...axis, height: MUI_LABELLED_X_AXIS_HEIGHT + metrics.extraHeight };
+  });
+
+  const callerSetBottom = typeof margin === 'number' || margin?.bottom != null;
+  const spacedMargin = largestExtraHeight > 0 && !callerSetBottom
+    ? { ...margin, bottom: MUI_CHART_MARGIN_BOTTOM + largestExtraHeight }
+    : margin;
+
+  return { xAxis: spacedXAxis, margin: spacedMargin };
+}
+
+export function withChartSlotDefaults(slotProps, legendPosition) {
+  return {
+    ...slotProps,
+    tooltip: {
+      trigger: 'axis',
+      ...slotProps?.tooltip,
+    },
+    legend: {
+      position: legendPosition,
+      ...slotProps?.legend,
+    },
+  };
+}

package/src/components/charts/chartLabels.js

@@ -0,0 +1,36 @@
+// Short, granularity-aware x-axis tick labels.
+//
+// Not a style choice -- MUI X-Charts has a known, unfixed bug (mui-x#18768,
+// duplicate of #18399): when the measured space for a tick label gets
+// tight, its ellipsize() logic doesn't truncate the text, it collapses it
+// to an empty string (the <tspan> stays in the DOM with no content). It
+// only reproduces with long label text ("08/05, 10:00 AM"-style, ~16
+// characters) combined with this app's actual font metrics (DM Sans) --
+// short labels like "05.08." or "10:00" leave enough margin that the bug
+// never triggers. Same fix already proven in jg-ferien's ActivitySection.
+
+// `locale` defaults to "de-CH" only as a fallback for callers that don't
+// pass the app's active i18n language (found in review: an earlier version
+// hardcoded "de-CH" always, showing German month names to en/fr users).
+
+export function formatShortTime(date, locale = 'de-CH') {
+  // hour12 forced false regardless of locale -- an English 12-hour label
+  // ("10:00 AM") is exactly the longer style that triggered the original
+  // collapse bug; staying short is the point, not locale fidelity here.
+  return date.toLocaleTimeString(locale, { hour: '2-digit', minute: '2-digit', hour12: false });
+}
+
+export function formatShortDate(date, locale = 'de-CH') {
+  return date.toLocaleDateString(locale, { day: '2-digit', month: '2-digit' });
+}
+
+export function formatShortMonth(date, locale = 'de-CH') {
+  return date.toLocaleDateString(locale, { month: 'short', year: '2-digit' });
+}
+
+// "All" spans years -- day/month labels repeat (e.g. every "01.04." shows up
+// once per year) and read as meaningless noise; a bare year number is the
+// only granularity dense multi-year history can show cleanly.
+export function formatShortYear(date, locale = 'de-CH') {
+  return date.toLocaleDateString(locale, { year: 'numeric' });
+}

package/src/components/charts/yearTickInterval.js

@@ -0,0 +1,7 @@
+/** Return one January tick for every calendar year represented in dates. */
+export function yearTickInterval(dates) {
+  const years = new Set(dates.map((date) => date.getFullYear()));
+  return [...years]
+    .sort((first, second) => first - second)
+    .map((year) => new Date(year, 0, 1));
+}

package/src/index.js

@@ -55,6 +55,13 @@ export { BarChart } from './components/charts/BarChart';
 export { LineChart } from './components/charts/LineChart';
 export { TimeSeriesChart } from './components/charts/TimeSeriesChart';
 export { getNeutralChartPalette, useNeutralChartPalette } from './components/charts/palette';
+export {
+  formatShortTime,
+  formatShortDate,
+  formatShortMonth,
+  formatShortYear,
+} from './components/charts/chartLabels';
+export { yearTickInterval } from './components/charts/yearTickInterval';
 export {
   formatPercentage,
   formatCompact,

package/src/theme/index.js

@@ -5,3 +5,10 @@ export {
   reportThemeAdoption,
   THEME_COMPLETENESS_SURFACES,
 } from './themeCompleteness';
+export {
+  formatShortTime,
+  formatShortDate,
+  formatShortMonth,
+  formatShortYear,
+} from '../components/charts/chartLabels';
+export { yearTickInterval } from '../components/charts/yearTickInterval';

package/tests/BarChart.test.jsx

@@ -26,7 +26,10 @@ describe('BarChart preset', () => {
 
     expect(props.xAxis[0].label).toBe('Year');
     expect(props.yAxis[0].label).toBe('Value (kg)');
-    expect(props.slotProps).toEqual({ tooltip: { trigger: 'axis' } });
+    expect(props.slotProps).toEqual({
+      tooltip: { trigger: 'axis' },
+      legend: { position: { vertical: 'bottom', horizontal: 'start' } },
+    });
     expect(props.hideLegend).toBe(true);
     expect(screen.getByTestId('bar-chart-container').getAttribute('style') || '').not.toContain('px');
   });

package/tests/LineChart.test.jsx

@@ -5,7 +5,7 @@ import { cleanup, render } from '@testing-library/react';
 import { ThemeProvider, createTheme } from '@mui/material/styles';
 
 const chartSpy = vi.hoisted(() => vi.fn(() => <div data-testid="mui-line-chart" />));
-vi.mock('@mui/x-charts/LineChart', () => ({ LineChart: chartSpy }));
+vi.mock('@mui/x-charts/LineChart', () => ({ LineChart: chartSpy, MarkElement: 'path' }));
 
 import { LineChart } from '../src/components/charts/LineChart';
 
@@ -28,6 +28,9 @@ describe('LineChart preset', () => {
     expect(props.xAxis[0].label).toBe('Date');
     expect(props.yAxis[0].label).toBe('Rate (%)');
     expect(props.hideLegend).toBe(false);
-    expect(props.slotProps).toEqual({ tooltip: { trigger: 'axis' } });
+    expect(props.slotProps).toEqual({
+      tooltip: { trigger: 'axis' },
+      legend: { position: { vertical: 'bottom', horizontal: 'start' } },
+    });
   });
 });

package/tests/chartDefaults.test.js

@@ -0,0 +1,177 @@
+// @vitest-environment jsdom
+import React from 'react';
+import i18next from 'i18next';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { cleanup, render } from '@testing-library/react';
+import { I18nextProvider } from 'react-i18next';
+import { ThemeProvider } from '@mui/material/styles';
+
+const barSpy = vi.hoisted(() => vi.fn(() => null));
+const lineSpy = vi.hoisted(() => vi.fn(() => null));
+vi.mock('@mui/x-charts/BarChart', () => ({ BarChart: barSpy }));
+vi.mock('@mui/x-charts/LineChart', () => ({ LineChart: lineSpy, MarkElement: 'path' }));
+
+import { BarChart } from '../src/components/charts/BarChart';
+import { LineChart } from '../src/components/charts/LineChart';
+import { TimeSeriesChart } from '../src/components/charts/TimeSeriesChart';
+import { createAppTheme } from '../src/theme/createAppTheme';
+
+const theme = createAppTheme({ palette: { primary: { main: '#3D5A99' } } });
+const i18n = i18next.createInstance();
+i18n.init({
+  lng: 'en',
+  resources: {
+    en: {
+      translation: {
+        'TimeSeriesChart.RANGE_LABEL': 'Range',
+        'TimeSeriesChart.RANGE_1_DAY': '1 day',
+        'TimeSeriesChart.RANGE_1_WEEK': '1 week',
+        'TimeSeriesChart.RANGE_1_MONTH': '1 month',
+        'TimeSeriesChart.RANGE_1_YEAR': '1 year',
+        'TimeSeriesChart.SERIES_LABEL': 'Series',
+        'ChartFrame.EMPTY_DEFAULT': 'No data available.',
+        'ChartFrame.LOADING': 'Loading chart.',
+        'ChartFrame.ERROR_DEFAULT': 'The chart could not be loaded.',
+      },
+    },
+  },
+  interpolation: { escapeValue: false },
+});
+
+function withProviders(children) {
+  return React.createElement(
+    ThemeProvider,
+    { theme },
+    React.createElement(I18nextProvider, { i18n }, children),
+  );
+}
+
+function renderBar(props = {}) {
+  return render(withProviders(
+    React.createElement(BarChart, {
+      xAxisLabel: 'Month',
+      yAxisLabel: 'Cases',
+      series: [{ label: 'Cases', data: [1, 2] }],
+      ...props,
+    }),
+  ));
+}
+
+function renderLine(props = {}) {
+  return render(withProviders(
+    React.createElement(LineChart, {
+      xAxisLabel: 'Month',
+      yAxisLabel: 'Cases',
+      series: [{ label: 'Cases', data: [1, 2] }],
+      ...props,
+    }),
+  ));
+}
+
+describe('chart chrome defaults', () => {
+  afterEach(() => {
+    cleanup();
+    vi.clearAllMocks();
+  });
+
+  it('gives minimal BarChart, LineChart, and TimeSeriesChart calls the baseline ticks and horizontal grid, with line marks off', () => {
+    renderBar();
+    const barProps = barSpy.mock.calls.at(-1)[0];
+    expect(barProps.xAxis[0].tickLabelStyle.fontSize).toBe(theme.typography.caption.fontSize);
+    expect(barProps.yAxis[0].tickLabelStyle.fontSize).toBe(theme.typography.caption.fontSize);
+    expect(barProps.grid).toEqual({ horizontal: true });
+
+    renderLine();
+    const lineProps = lineSpy.mock.calls.at(-1)[0];
+    expect(lineProps.xAxis[0].tickLabelStyle.fontSize).toBe(theme.typography.caption.fontSize);
+    expect(lineProps.yAxis[0].tickLabelStyle.fontSize).toBe(theme.typography.caption.fontSize);
+    expect(lineProps.grid).toEqual({ horizontal: true });
+    expect(lineProps.series[0].showMark).toBe(false);
+
+    render(withProviders(React.createElement(TimeSeriesChart, {
+      title: 'Activity',
+      xAxisLabel: 'Day',
+      yAxisLabel: 'Cases',
+      data: {
+          xLabels: ['Mon', 'Tue'],
+          series: [{ key: 'cases', label: 'Cases', data: [1, 2] }],
+      },
+      skipAnimation: true,
+    })));
+    const timeSeriesProps = barSpy.mock.calls.at(-1)[0];
+    expect(timeSeriesProps.xAxis[0].tickLabelStyle.fontSize).toBe(theme.typography.caption.fontSize);
+    expect(timeSeriesProps.yAxis[0].tickLabelStyle.fontSize).toBe(theme.typography.caption.fontSize);
+    expect(timeSeriesProps.grid).toEqual({ horizontal: true });
+    expect(timeSeriesProps.skipAnimation).toBe(true);
+  });
+
+  it('keeps caller tick font, grid, showMark, and legendPosition values instead of the defaults', () => {
+    const legendPosition = { vertical: 'top', horizontal: 'end' };
+    renderLine({
+      xAxis: [{ data: ['Jan', 'Feb'], tickLabelStyle: { fontSize: 17 } }],
+      grid: { horizontal: false, vertical: true },
+      series: [{ label: 'Cases', data: [1, 2], showMark: true }],
+      legendPosition,
+    });
+
+    const props = lineSpy.mock.calls.at(-1)[0];
+    expect(props.xAxis[0].tickLabelStyle.fontSize).toBe(17);
+    expect(props.grid).toEqual({ horizontal: false, vertical: true });
+    expect(props.series[0].showMark).toBe(true);
+    expect(props.slotProps.legend.position).toEqual(legendPosition);
+  });
+
+  // Found live in the dev harness (not by this mocked test, which cannot
+  // reproduce a real MUI scale computation): a caller-supplied xAxis with
+  // `data` but no `scaleType` lost the wrapper's default scaleType entirely,
+  // leaving MUI's point/band scale undefined and every rendered path NaN.
+  // This asserts the prop-level contract; the harness's "Chart defaults" /
+  // "Caller overrides" LineChart specimens are the real-render proof.
+  it('keeps the default scaleType on a caller-supplied axis that does not set one', () => {
+    renderLine({ xAxis: [{ data: ['Jan', 'Feb'] }] });
+    expect(lineSpy.mock.calls.at(-1)[0].xAxis[0].scaleType).toBe('point');
+
+    renderBar({ xAxis: [{ data: ['Jan', 'Feb'] }] });
+    expect(barSpy.mock.calls.at(-1)[0].xAxis[0].scaleType).toBe('band');
+  });
+
+  it('adds a font-and-angle-derived bottom margin only for rotated tick labels', () => {
+    renderBar({ xAxis: [{ data: ['Jan', 'Feb'], tickLabelStyle: { angle: -45 } }] });
+    const rotatedProps = barSpy.mock.calls.at(-1)[0];
+    expect(rotatedProps.margin.bottom).toBeGreaterThan(20);
+    expect(rotatedProps.xAxis[0].height).toBeGreaterThan(45);
+
+    cleanup();
+    renderBar({ xAxis: [{ data: ['Jan', 'Feb'], tickLabelStyle: { angle: 0 } }] });
+    expect(barSpy.mock.calls.at(-1)[0].margin).toBeUndefined();
+  });
+
+  it('uses the series colour as the fill when a caller opts line markers back in', () => {
+    renderLine({ series: [{ label: 'Cases', data: [1, 2], showMark: true }] });
+    const props = lineSpy.mock.calls.at(-1)[0];
+    const mark = props.slots.mark({
+      color: '#3D5A99',
+      id: 'cases',
+      dataIndex: 0,
+      shape: 'circle',
+      x: 10,
+      y: 10,
+    });
+
+    expect(mark.props.style.fill).toBe('#3D5A99');
+    expect(mark.props.style.fill).not.toBe(theme.palette.background.paper);
+  });
+
+  it('defaults legendPosition to bottom-start and lets a caller choose another MUI position', () => {
+    renderBar({ series: [{ data: [1] }, { data: [2] }] });
+    expect(barSpy.mock.calls.at(-1)[0].slotProps.legend.position).toEqual({
+      vertical: 'bottom',
+      horizontal: 'start',
+    });
+
+    cleanup();
+    const requested = { vertical: 'middle', horizontal: 'end' };
+    renderBar({ series: [{ data: [1] }, { data: [2] }], legendPosition: requested });
+    expect(barSpy.mock.calls.at(-1)[0].slotProps.legend.position).toEqual(requested);
+  });
+});

package/tests/chartLabels.test.js

@@ -0,0 +1,50 @@
+import { describe, expect, it } from 'vitest';
+
+import {
+  formatShortDate,
+  formatShortMonth,
+  formatShortTime,
+  formatShortYear,
+} from '../src/components/charts/chartLabels';
+import { yearTickInterval } from '../src/components/charts/yearTickInterval';
+
+// 2026-08-05 14:07, a fixed instant so assertions aren't flaky around
+// midnight/year boundaries.
+const FIXED = new Date(2026, 7, 5, 14, 7, 0);
+
+describe('chart label helpers', () => {
+  it('ports fitness-monitor short-label behaviour, including locale fallback and forced 24-hour time', () => {
+    expect(formatShortDate(FIXED, 'de-CH')).toBe('05.08.');
+    expect(formatShortDate(FIXED, 'de-CH').length).toBeLessThan(10);
+    expect(formatShortTime(FIXED, 'de-CH')).toBe('14:07');
+    expect(formatShortTime(FIXED, 'en-US')).toBe('14:07');
+    expect(formatShortMonth(FIXED, 'de-CH')).toMatch(/26$/);
+    expect(formatShortMonth(FIXED, 'de-CH').length).toBeLessThan(10);
+    expect(formatShortYear(FIXED, 'de-CH')).toBe('2026');
+    expect(formatShortYear(FIXED, 'en-US')).toBe('2026');
+    expect(formatShortDate(FIXED, 'en-US')).toBe('08/05');
+    expect(formatShortDate(FIXED)).toBe(formatShortDate(FIXED, 'de-CH'));
+  });
+
+  it('returns one tick per year and proves dense unfiltered dates produce duplicate year labels', () => {
+    const denseDates = [];
+    for (let year = 2022; year <= 2025; year += 1) {
+      for (let month = 0; month < 12; month += 1) {
+        denseDates.push(new Date(year, month, 1));
+      }
+    }
+
+    const unfilteredLabels = denseDates.map((date) => formatShortYear(date, 'de-CH'));
+    expect(new Set(unfilteredLabels).size).toBeLessThan(unfilteredLabels.length);
+
+    const ticks = yearTickInterval(denseDates);
+    expect(ticks).toHaveLength(4);
+    expect(ticks.every((date) => date.getMonth() === 0 && date.getDate() === 1)).toBe(true);
+    expect(ticks.map((date) => formatShortYear(date, 'de-CH'))).toEqual([
+      '2022',
+      '2023',
+      '2024',
+      '2025',
+    ]);
+  });
+});

package/tests/timeSeriesLegend.test.js

@@ -0,0 +1,99 @@
+// @vitest-environment jsdom
+import React from 'react';
+import i18next from 'i18next';
+import { afterEach, describe, expect, it, vi } from 'vitest';
+import { cleanup, render, screen } from '@testing-library/react';
+import { I18nextProvider } from 'react-i18next';
+import { ThemeProvider, createTheme } from '@mui/material/styles';
+
+const chartSpy = vi.hoisted(() => vi.fn(() => null));
+vi.mock('@mui/x-charts/BarChart', () => ({ BarChart: chartSpy }));
+
+import { TimeSeriesChart } from '../src/components/charts/TimeSeriesChart';
+
+chartSpy.mockImplementation((props) => React.createElement(
+  'div',
+  { 'data-testid': 'mui-bar-chart' },
+  !props.hideLegend
+    ? React.createElement('div', { 'data-testid': 'mui-legend' }, 'MUI legend')
+    : null,
+));
+
+const i18n = i18next.createInstance();
+i18n.init({
+  lng: 'en',
+  resources: {
+    en: {
+      translation: {
+        'TimeSeriesChart.RANGE_LABEL': 'Range',
+        'TimeSeriesChart.RANGE_1_DAY': '1 day',
+        'TimeSeriesChart.RANGE_1_WEEK': '1 week',
+        'TimeSeriesChart.RANGE_1_MONTH': '1 month',
+        'TimeSeriesChart.RANGE_1_YEAR': '1 year',
+        'TimeSeriesChart.SERIES_LABEL': 'Series',
+        'ChartFrame.EMPTY_DEFAULT': 'No data available.',
+        'ChartFrame.LOADING': 'Loading chart.',
+        'ChartFrame.ERROR_DEFAULT': 'The chart could not be loaded.',
+      },
+    },
+  },
+  interpolation: { escapeValue: false },
+});
+
+const MULTI_SERIES = {
+  xLabels: ['Mon', 'Tue'],
+  series: [
+    { key: 'users', label: 'Users', data: [1, 2] },
+    { key: 'hours', label: 'Presence hours', data: [3, 4] },
+  ],
+};
+
+function renderChart(data = MULTI_SERIES) {
+  return render(React.createElement(
+    ThemeProvider,
+    { theme: createTheme() },
+    React.createElement(
+      I18nextProvider,
+      { i18n },
+      React.createElement(TimeSeriesChart, {
+        title: 'Activity',
+        xAxisLabel: 'Day',
+        yAxisLabel: 'Count',
+        data,
+      }),
+    ),
+  ),
+  );
+}
+
+describe('TimeSeriesChart toolbar legend', () => {
+  afterEach(() => {
+    cleanup();
+    vi.clearAllMocks();
+  });
+
+  it('removes the MUI legend when the toolbar names and toggles multiple series', () => {
+    renderChart();
+
+    expect(chartSpy.mock.calls.at(-1)[0].hideLegend).toBe(true);
+    expect(screen.queryByTestId('mui-legend')).toBeNull();
+  });
+
+  it('keeps an accessible name on every toolbar series toggle', () => {
+    renderChart();
+
+    expect(screen.getByRole('checkbox', { name: 'Users' })).toBeTruthy();
+    expect(screen.getByRole('checkbox', { name: 'Presence hours' })).toBeTruthy();
+    expect(screen.getAllByTestId('series-colour-dot')).toHaveLength(2);
+  });
+
+  it('still hides the redundant MUI legend for a single series', () => {
+    renderChart({
+      xLabels: ['Mon', 'Tue'],
+      series: [{ key: 'users', label: 'Users', data: [1, 2] }],
+    });
+
+    expect(chartSpy.mock.calls.at(-1)[0].hideLegend).toBe(true);
+    expect(screen.queryByTestId('mui-legend')).toBeNull();
+  });
+});