UNPKG

2.54 kBTypeScriptView Raw
1import * as React from 'react';
2export interface LoginFormProps extends React.HTMLProps<HTMLFormElement> {
3 /** Flag to indicate if the first dropdown item should not gain initial focus */
4 noAutoFocus?: boolean;
5 /** Additional classes added to the Login Main Body's Form */
6 className?: string;
7 /** Flag indicating the Helper Text is visible * */
8 showHelperText?: boolean;
9 /** Content displayed in the Helper Text component * */
10 helperText?: React.ReactNode;
11 /** Icon displayed to the left in the Helper Text */
12 helperTextIcon?: React.ReactNode;
13 /** Label for the Username Input Field */
14 usernameLabel?: string;
15 /** Value for the Username */
16 usernameValue?: string;
17 /** Function that handles the onChange event for the Username */
18 onChangeUsername?: (value: string, event: React.FormEvent<HTMLInputElement>) => void;
19 /** Flag indicating if the Username is valid */
20 isValidUsername?: boolean;
21 /** Label for the Password Input Field */
22 passwordLabel?: string;
23 /** Value for the Password */
24 passwordValue?: string;
25 /** Function that handles the onChange event for the Password */
26 onChangePassword?: (value: string, event: React.FormEvent<HTMLInputElement>) => void;
27 /** Flag indicating if the Password is valid */
28 isValidPassword?: boolean;
29 /** Flag indicating if the user can toggle hiding the password */
30 isShowPasswordEnabled?: boolean;
31 /** Accessible label for the show password button */
32 showPasswordAriaLabel?: string;
33 /** Accessible label for the hide password button */
34 hidePasswordAriaLabel?: string;
35 /** Label for the Log in Button Input */
36 loginButtonLabel?: string;
37 /** Flag indicating if the Login Button is disabled */
38 isLoginButtonDisabled?: boolean;
39 /** Function that is called when the Login button is clicked */
40 onLoginButtonClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
41 /** Label for the Remember Me Checkbox that indicates the user should be kept logged in. If the label is not provided, the checkbox will not show. */
42 rememberMeLabel?: string;
43 /** Flag indicating if the remember me Checkbox is checked. */
44 isRememberMeChecked?: boolean;
45 /** Function that handles the onChange event for the Remember Me Checkbox */
46 onChangeRememberMe?: (checked: boolean, event: React.FormEvent<HTMLInputElement>) => void;
47}
48export declare const LoginForm: React.FunctionComponent<LoginFormProps>;
49//# sourceMappingURL=LoginForm.d.ts.map
\No newline at end of file