Skip to content

Improve exported Vue component typedefs #5146

Open
@tobz1000

Description

@tobz1000

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    AuthenticatorAn issue or a feature-request for an Authenticator UI ComponentVueAn issue or a feature-request for Vue platformbugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions