auth
SignInFormProps
Defined in: packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:37
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
auth | Auth | Firebase's Auth object. | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:41 |
providers | object[] | List of SSO providers. | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:45 |
enableEmailPassword? | boolean | If false, the email/password form will not be displayed. Can be used for showing email/password form just for dev environments. Default true | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:56 |
signInWithPopup | (auth, provider, resolver?) => Promise<UserCredential> | Firebase's signInWithPopup function. | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:60 |
signInWithEmailAndPassword | (auth, email, password) => Promise<UserCredential> | Firebase's signInWithEmailAndPassword function. | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:64 |
className? | string | - | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:65 |
buttonSize? | NonNullable<"default" | "sm" | "lg" | "xs" | "round" | null | undefined> | Size of submit and SSO buttons. | packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:69 |
UserInfo
type UserInfo = ReturnType<typeof getUserInfo>;
Defined in: packages/design-system/src/modules/auth/user.ts:23
messages
const messages: object;
Defined in: packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:24
Type Declaration
EmailPasswordForm()
function EmailPasswordForm(__namedParameters): Element;
Defined in: packages/design-system/src/modules/auth/SignInForm/EmailPasswordForm/EmailPasswordForm.tsx:40
Parameters
| Parameter | Type |
|---|---|
__namedParameters | EmailPasswordFormProps |
Returns
Element
SignInForm()
function SignInForm(__namedParameters): Element;
Defined in: packages/design-system/src/modules/auth/SignInForm/SignInForm.tsx:75
Complete Sign In Form component for Firebase.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | SignInFormProps |
Returns
Element
useAuthUser()
function useAuthUser(auth): User | null | undefined;
Defined in: packages/design-system/src/modules/auth/hooks.ts:17
Returns currently authenticated user. null = no user is authenticated. undefined = initial state.
Parameters
| Parameter | Type |
|---|---|
auth | Auth |
Returns
User | null | undefined
getUserInfo()
function getUserInfo(user): object;
Defined in: packages/design-system/src/modules/auth/user.ts:14
Converts complete Firebase UserInfo to plain object with properties
Parameters
| Parameter | Type |
|---|---|
user | UserInfo |
Returns
object
| Name | Type | Default value | Defined in |
|---|---|---|---|
displayName | string | null | user.displayName | packages/design-system/src/modules/auth/user.ts:15 |
email | string | null | user.email | packages/design-system/src/modules/auth/user.ts:16 |
phoneNumber | string | null | user.phoneNumber | packages/design-system/src/modules/auth/user.ts:17 |
photoURL | string | null | user.photoURL | packages/design-system/src/modules/auth/user.ts:18 |
providerId | string | user.providerId | packages/design-system/src/modules/auth/user.ts:19 |
uid | string | user.uid | packages/design-system/src/modules/auth/user.ts:20 |
getUserName()
function getUserName(user): string | null | undefined;
Defined in: packages/design-system/src/modules/auth/user.ts:28
Converts user object to displayable name
Parameters
| Parameter | Type |
|---|---|
user | { displayName?: string | null; email?: string | null; uid?: string | null; } |
user.displayName? | string | null |
user.email? | string | null |
user.uid? | string | null |
Returns
string | null | undefined