ionic-team/ionic-framework

feat: Improved types for react useIonModal

Open

#28680 opened on Dec 11, 2023

View on GitHub
 (8 comments) (0 reactions) (0 assignees)TypeScript (52,503 stars) (13,381 forks)batch import
help wantedpackage: reacttype: feature request

Description

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

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript genericsReact component typesIonic Framework contributing guidelines
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.