aws-amplify / aws-amplify/amplify-ui

Improve exported Vue component typedefs

Open
#5,146 1 comment 0 reactions 0 assignees View on GitHub
Authenticator bug Vue
Dominant language
TypeScript
Stars
1.1k
Forks
347
Avg merge
18h 29m
Merged PRs (30d)
9

Description

### 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?

- [ ] 👋 I may be able to implement this feature request.
- [ ] ⚠️ This feature might incur a breaking change.

Contributor guide

Open the contributing guide

Research direction

Start by reading packages/vue/src/components/authenticator.vue around lines 35–44 and compare that precise Authenticator prop definition with the types exported by @aws-amplify/ui-vue. Check whether the same issue affects other components, as suggested in the request. Done means consumers can access the full Authenticator prop types instead of mostly any or unknown values.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.