react-component / react-component/table

Use DataIndex<RecordType> for better constraints?

Offen
#435 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
1.4k
Forks
618
Ø Merge
10 Std. 19 Min.
Gemergte PRs (30 T.)
2

Beschreibung

I'd like to propose this change:

Before:

export declare type DataIndex = string | number | (string | number)[];

After:

export declare type DataIndex<RecordType> = keyof RecordType | number | (keyof RecordType | number)[];

That way, you get full type checking on dataIndex like here:

const columns : ColumnsType<Client>= [
 {
      title: 'Name',
      dataIndex: 'name',   // If 'name' does not exist for type Client, a Typescript error will occur
      key: 'name',
      render: text => <a>{text}</a>
},
]

If you like it, I can send a PR.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Typdeklarationen von DataIndex und ColumnsType zu finden und zu prüfen, wie dataIndex in den Tabellentypen verwendet wird. Vergleiche die vorgeschlagene generische Einschränkung mit den bestehenden Verwendungen und verifiziere anschließend, dass gültige Schlüssel typgeprüft werden und ungültige Schlüssel TypeScript-Fehler erzeugen, ohne numerische oder Array-Indizes zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
frontend
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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