Type alias LoginFormProps<T>

LoginFormProps<T>: {
    color?: DevfiveColorKey;
    findTextProps?: TextProps;
    findUrl?: string;
    logo?: string | ReactNode;
    logoTo?: To;
    onLogin?: ((username, password, snsType?) => Promise<void> | void);
    passwordLabel?: string;
    passwordPlaceholder?: string;
    passwordRule?: FormItemProps["rules"] | null;
    prefix?: keyof DevfiveAuthPrefix;
    rootData?: T;
    signupTextProps?: TextProps;
    signupUrl?: string;
    snsButtonPosition?: "top" | "bottom";
    snsState?: string;
    successUrl?: string | number;
    title?: string;
    usernameLabel?: string;
    usernamePlaceholder?: string;
    usernameRule?: FormItemProps["rules"] | null;
    width?: ResponsiveValue<string | number>;
} & ({
    redirectUrl: StartWith<"http">;
    sns: SnsType[];
} | {
    redirectUrl?: never;
    sns?: never;
})

LoginForm 컴포넌트의 props interface 입니다.

Type Parameters

Type declaration

  • Optional color?: DevfiveColorKey

    로그인 폼 색상

  • Optional findTextProps?: TextProps
  • Optional findUrl?: string

    계정 찾기 URL

  • Optional logo?: string | ReactNode

    로그인 Form 상단 로고

  • Optional logoTo?: To

    로그인 Form 상단 로고 클릭시 이동할 URL

  • Optional onLogin?: ((username, password, snsType?) => Promise<void> | void)

    로그인 성공 콜백, await 로 로직이 완전히 끝날때 까지 대기합니다. 만약, onLogin 이 없다면, useAuth 를 통하여 로그인을 시도합니다.

    Param: username

    유저명

    Param: password

    비밀번호

    Param: snsType

    sns 로그인 타입

      • (username, password, snsType?): Promise<void> | void

      • 로그인 성공 콜백, await 로 로직이 완전히 끝날때 까지 대기합니다. 만약, onLogin 이 없다면, useAuth 를 통하여 로그인을 시도합니다.

        Parameters

        • username: string

          유저명

        • password: string

          비밀번호

        • Optional snsType: SnsType

          sns 로그인 타입

        Returns Promise<void> | void

  • Optional passwordLabel?: string

    비밀번호 라벨

  • Optional passwordPlaceholder?: string

    비밀번호 입력 플레이스 홀더

  • Optional passwordRule?: FormItemProps["rules"] | null

    비밀번호 검증 규칙, null 일 경우 규칙을 제거합니다.

  • Optional prefix?: keyof DevfiveAuthPrefix

    로그인 URL의 접두사, 일반적으로 서버가 생성합니다.

  • Optional rootData?: T

    Root 계정일 경우 임의로 Root 계정의 정보를 설정합니다.

  • Optional signupTextProps?: TextProps

    로그인 성공시 이동 URL

    Default Value

    /

  • Optional signupUrl?: string

    회원가입 URL

  • Optional snsButtonPosition?: "top" | "bottom"

    sns 로그인 버튼 위치

  • Optional snsState?: string

    sns 로그인 타입

  • Optional successUrl?: string | number
  • Optional title?: string

    로그인 Form 상단 타이틀

  • Optional usernameLabel?: string

    유저명 라벨

  • Optional usernamePlaceholder?: string

    유저명 입력 플레이스 홀더

  • Optional usernameRule?: FormItemProps["rules"] | null

    유저명 검증 규칙, null 일 경우 규칙을 제거합니다.

  • Optional width?: ResponsiveValue<string | number>

    로그인 Form 반응형 폭

Settings

Member Visibility

Theme

Generated using TypeDoc