auth

SignInFormProps

Defined in: src/modules/auth/SignInForm/SignInForm.tsx:37

Properties

Property	Type	Description	Defined in
auth	Auth	Firebase's Auth object.	src/modules/auth/SignInForm/SignInForm.tsx:41
providers	object[]	List of SSO providers.	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	src/modules/auth/SignInForm/SignInForm.tsx:56
signInWithPopup	(auth, provider, resolver?) => Promise<UserCredential>	Firebase's signInWithPopup function.	src/modules/auth/SignInForm/SignInForm.tsx:60
signInWithEmailAndPassword	(auth, email, password) => Promise<UserCredential>	Firebase's signInWithEmailAndPassword function.	src/modules/auth/SignInForm/SignInForm.tsx:64
className?	string	-	src/modules/auth/SignInForm/SignInForm.tsx:65
buttonSize?	"default" | "sm" | "lg" | "xs" | "round" | null	Size of submit and SSO buttons.	src/modules/auth/SignInForm/SignInForm.tsx:69

---

UserInfo

type UserInfo = ReturnType<typeof getUserInfo>;

Defined in: src/modules/auth/user.ts:24

---

messages

const messages: object;

Defined in: src/modules/auth/SignInForm/SignInForm.tsx:24

Type Declaration

Name	Type	Default value	Defined in
signIn_title	string	"Sign In"	src/modules/auth/SignInForm/SignInForm.tsx:25
signIn_provider	string	"Sign in with {provider}"	src/modules/auth/SignInForm/SignInForm.tsx:26
signIn_separator	string	"or"	src/modules/auth/SignInForm/SignInForm.tsx:27
signIn_field_email	string	"Email"	src/modules/auth/SignInForm/SignInForm.tsx:28
signIn_field_password	string	"Password"	src/modules/auth/SignInForm/SignInForm.tsx:29
signIn_submit	string	"Sign In"	src/modules/auth/SignInForm/SignInForm.tsx:30
signIn_formError_firebase	string	"Sign in error: {code}. Please try again."	src/modules/auth/SignInForm/SignInForm.tsx:31
signIn_formError_unknown	string	"Unknown error. Please try again."	src/modules/auth/SignInForm/SignInForm.tsx:32
signIn_formError_invalidCredentials	string	"Provided credentials are wrong. Please try again."	src/modules/auth/SignInForm/SignInForm.tsx:33

---

EmailPasswordForm()

function EmailPasswordForm(__namedParameters): Element;

Defined in: src/modules/auth/SignInForm/EmailPasswordForm/EmailPasswordForm.tsx:40

Parameters

Parameter	Type
__namedParameters	EmailPasswordFormProps

Returns

Element

---

SignInForm()

function SignInForm(__namedParameters): Element;

Defined in: 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: src/modules/auth/hooks.ts:18

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: src/modules/auth/user.ts:15

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	src/modules/auth/user.ts:16
email	string | null	user.email	src/modules/auth/user.ts:17
phoneNumber	string | null	user.phoneNumber	src/modules/auth/user.ts:18
photoURL	string | null	user.photoURL	src/modules/auth/user.ts:19
providerId	string	user.providerId	src/modules/auth/user.ts:20
uid	string	user.uid	src/modules/auth/user.ts:21

---

getUserName()

function getUserName(user): Nil<string>;

Defined in: src/modules/auth/user.ts:29

Converts user object to displayable name

Parameters

Parameter	Type
user	{ displayName?: Nil<string>; email?: Nil<string>; uid?: Nil<string>; }
user.displayName?	Nil<string>
user.email?	Nil<string>
user.uid?	Nil<string>

Returns

Nil<string>