DiamondLightSource / DiamondLightSource/sci-react-ui

Change Proposal: Apply `DiamondDSIntegrations` MRT styling automatically to all tables, not just opted-in ones

Offen
#280 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
needs-triage
Vorherrschende Sprache
TypeScript
Sterne
8
Forks
3
Ø Merge
3 T. 15 Std.
Gemergte PRs (30 T.)
5

Beschreibung

## What is being proposed?

A wrapper or a component that pre-merges `DiamondDSIntegrations.mrtTheme` / `mrtOptions()` so every Material React Table instance in a consuming app picks up DiamondDS styling by default, instead of requiring each call site to use it individually.

## Why is this needed?

#249 added `DiamondDSIntegrations.mrtTheme` / `mrtOptions()`, but they only apply if a developer remembers to use them into a given `useMaterialReactTable` call. If they don't, the table silently falls back to MRT's unstyled defaults, with no error or warning, so styling drifts table-by-table across an app instead of being guaranteed by the design system. This was flagged as a follow-up TODO directly in `src/themes/DiamondDSIntegrations.ts`.

## What will change?

- **Behaviour:** DiamondDS table styling becomes the default for MRT tables rather than opt-in per instance.
- **Component props or usage:** likely a new hook/wrapper is introduced; existing manual `mrtOptions()`/`mrtTheme` spreading should keep working for anyone not yet migrated.
- **New component:** possibly a thin wrapper around `useMaterialReactTable` or `MaterialReactTable`.

## Interface changes (if any)

```ts
// wraps useMaterialReactTable and merges DiamondDS defaults automatically
const table = useDiamondMaterialReactTable({
columns,
data,
// any options here still override the DiamondDS defaults
});
```

## Breaking change?

- [ ] Yes
- [x] No

Additive: existing code that manually uses `mrtOptions()`/`mrtTheme` continues to work; the new hook/wrapper is the recommended path going forward.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start with the TODO in src/themes/DiamondDSIntegrations.ts and inspect how useMaterialReactTable and MaterialReactTable are used. Compare the proposed hook or wrapper options, preserving manual mrtOptions()/mrtTheme usage and ensuring caller options override the DiamondDS defaults; done means MRT tables can consistently receive the styling through the new recommended path.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
frontend
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.