ionic-team / ionic-team/ionic-framework

feat: react, update useIonModal signature to accept all parameters in one object

Open
#27,548 1 comment 0 reactions 0 assignees View on GitHub
package: react type: feature request
Dominant language
TypeScript
Stars
52.7k
Forks
13.3k
Avg merge
1d 15h
Merged PRs (30d)
51

Description

### Prerequisites

- [X] I have read the [Contributing Guidelines](https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#creating-an-issue).
- [X] I agree to follow the [Code of Conduct](https://ionicframework.com/code-of-conduct).
- [X] I have searched for [existing issues](https://github.com/ionic-team/ionic-framework/issues) that already include this feature request, without success.

### Describe the Feature Request

Currently, the `useIonModal` hook has this signature:

```
const [present, dismiss] = useIonModal(component: ReactComponentOrElement, componentProps?: any);
```

A common React paradigm is to enclose all input parameters into one object. This is primarily done to destructure the bits of input/output that you need at any moment in time:

```
const { getAccount } = useAccountsAPI();

const MyComponent = ({ myProp1, myProp2 }) =>

{myProp1}
;
```

### Describe the Use Case

It's also become a pattern developers use as context clues to figure out what something does.

This can make the current `useIonModal()` signature confusing:

```
const [present, dismiss] = useIonModal(MyComponent, { myProp1, myProp2, onDismiss: dismiss() });
```

### Describe Preferred Solution

Adjusting the signature could improve the ergonomics of the hook:

```
const [present, dismiss] = useIonModal({ component: ReactComponentOrElement, props?: any);
```

Taken further, we can use TypeScript's generics to type the component's props:

```
const [present, dismiss] = useIonModal({ component: ReactComponentOrElement, props: T});
```

### Describe Alternatives

_No response_

### Related Code

_No response_

### Additional Information

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.