Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve exported Vue component typedefs #5146

Open
2 tasks
tobz1000 opened this issue Apr 11, 2024 · 1 comment
Open
2 tasks

Improve exported Vue component typedefs #5146

tobz1000 opened this issue Apr 11, 2024 · 1 comment
Labels
Authenticator An issue or a feature-request for an Authenticator UI Component bug Something isn't working Vue An issue or a feature-request for Vue platform

Comments

@tobz1000
Copy link

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:

interface AuthenticatorProps {
hideSignUp?: boolean;
initialState?: AuthenticatorMachineOptions['initialState'];
loginMechanisms?: AuthenticatorMachineOptions['loginMechanisms'];
services?: AuthenticatorMachineOptions['services'];
signUpAttributes?: AuthenticatorMachineOptions['signUpAttributes'];
variation?: 'default' | 'modal';
socialProviders?: SocialProvider[];
formFields?: AuthFormFields;
}

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.
@tobz1000 tobz1000 added the feature-request Request a new feature label Apr 11, 2024
@github-actions github-actions bot added the pending-triage Issue is pending triage label Apr 11, 2024
@reesscot
Copy link
Contributor

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

@hbuchel hbuchel removed the pending-triage Issue is pending triage label Apr 12, 2024
@reesscot reesscot added bug Something isn't working Vue An issue or a feature-request for Vue platform Authenticator An issue or a feature-request for an Authenticator UI Component and removed feature-request Request a new feature labels Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Authenticator An issue or a feature-request for an Authenticator UI Component bug Something isn't working Vue An issue or a feature-request for Vue platform
Projects
None yet
Development

No branches or pull requests

3 participants