ionic-team/ionic-framework

feat: Improved types for react useIonModal

Open

Aperta il 11 dic 2023

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)TypeScript (52.503 star) (13.381 fork)batch import
help wantedpackage: reacttype: feature request

Descrizione

Prerequisites

Describe the Feature Request

useIonModal should type props parameter.

Describe the Use Case

useIonModal currently allows any for component props. This is dangerous and has caused many crashes and unintended behaviors in my experience.

Currently:

export declare function useIonModal(component: ReactComponentOrElement, componentProps?: any): UseIonModalResult;

Describe Preferred Solution

export declare function useIonModal<P>(component: React.ComponentClass<P> | React.FC<P>, componentProps?: P): UseIonModalResult;
export declare function useIonModal(component: React.ReactElement, componentProps?: any): UseIonModalResult;

Describe Alternatives

Leaving as-is

Related Code

No response

Additional Information

If you would accept this change, I would happily make a PR

Guida contributor

Tech stack
typescriptreact
Dominio
frontend
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
TypeScript genericsReact component typesIonic Framework contributing guidelines
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
Find the declaration file for useIonModal in the Ionic Framework React package (likely in packages/react/src/components/IonModal.tsx or similar). Modify the function signature to use generics as described: add an overloaded signature that accepts React.ComponentClass<P> or React.FC<P> with componentProps typed as P. Ensure consistency with existing type patterns and update any relevant test or type files. The issue is clear and the author has offered to submit a PR, but no PR is currently linked.