shuding/nextra

`components` theme configuration to accept generic

Open

Aperta il 18 giu 2023

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (13.807 star) (1413 fork)user submission
enhancementgood first issue

Descrizione

Hi 👋

Context

I would like to create a custom component to be reusable inside all the documentation 😍

type IframeProps = {
  url: string;
};

export const Iframe: FunctionComponent<IframeProps> = ({ url }) => {
  return <iframe src={url} allowFullScreen className={styles.main} />;
};

Problem

Regarding the following documentation 👀

Capture d’écran 2023-06-18 à 09 57 24

In the code, type is define as components?: Record<string, FC> | undefined; but it's a little bit to strict because we can't pass any additional props.

Cannot assign type 'FC<OptionTableProps>' to type 'FC'.
  Parameter types 'props' and 'props' are incompatible.
    Unable to assign type '{}' to type 'OptionTableProps'. ts(2322)

Proposal solution

What about the possibility to accept a generic to pass additional props ? Is there any side effect for this improvement ?

components?: Record<string, FC<T>> | undefined;

I could open a PR if needed to support 😇 Thanks for it 🙏

Guida contributor

Tech stack
typescriptreactnextjs
Dominio
frontenddocumentationdeveloper experience
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
TypeScript genericsReactNextra project structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
The issue proposes adding a generic type parameter to the `components` configuration in Nextra's theme. The current type is `components?: Record<string, FC> | undefined;` which is too restrictive. To implement, locate the type definition (likely in `packages/nextra/src/types.ts` or similar). The change would be to make the type generic: `components?: Record<string, FC<T>> | undefined;`. Consider side effects on theme component usage and ensure backward compatibility. No linked PRs or assignees, so first time contributors can pick this up.