ionic-team/ionic-framework

feat: Improved types for react useIonModal

Open

#28,680 opened on Dec 11, 2023

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

Repository metrics

Stars
 (52,503 stars)
PR merge metrics
 (Avg merge 4d 6h) (50 merged PRs in 30d)

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

Research direction
Modify the type definition for useIonModal in the React package to add generic parameter and overloads.
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.
1-3 hours
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
TypeScriptReactIonic Framework basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80