DiamondLightSource / DiamondLightSource/sci-react-ui

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

Aperta
#280 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
needs-triage
Lingua principale
TypeScript
Stelle
8
Fork
3
Merge medio
3g 15h
PR unite (30g)
5

Descrizione

## 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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
react, typescript
Ambito
frontend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.