aws-amplify / amplify-ui

Amplify UI is a collection of accessible, themeable, performant React (and more!) components that can connect directly to the cloud.
https://ui.docs.amplify.aws
Apache License 2.0
887 stars 282 forks source link

Improve exported Vue component typedefs #5146

Open tobz1000 opened 5 months ago

tobz1000 commented 5 months ago

On which framework/platform would you like to see this feature implemented?

Vue

Which UI component is this feature-request for?

Authenticator

Please describe your feature-request in detail.

When using @aws-amplify/ui-vue in a consuming project, the exported type definitions for the Authenticator component props defines most properties as any or unknown. There is a more precise definition available in the codebase:

https://github.com/aws-amplify/amplify-ui/blob/505a4db44e500551aaaca21626829736f75a8d49/packages/vue/src/components/authenticator.vue#L35-L44

Would it be possible to export this full type definition? I imagine this issue might apply to other components as well.

Please describe a solution you'd like.

No response

We love contributors! Is this something you'd be interested in working on?

reesscot commented 5 months ago

Hi @tobz1000, Thank you for submitting this feature request. This would be a breaking change and we will consider adding it to our roadmap.