You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This repository contains the source code for the FirebaseUI for Web project rewr
7
7
FirebaseUI requires the `firebase` package to be installed:
8
8
9
9
```bash
10
-
npm intall firebase
10
+
npm install firebase
11
11
```
12
12
13
13
Next, follow the installation flow for your framework:
@@ -18,23 +18,26 @@ Next, follow the installation flow for your framework:
18
18
```bash
19
19
npm install @firebase-ui/react
20
20
```
21
+
21
22
</details>
22
23
23
24
<details>
24
25
<summary>Angular</summary>
25
26
26
-
FirebaseUI for Angular dependes on the [AngularFire](https://github.com/angular/angularfire) package:
27
+
FirebaseUI for Angular depends on the [AngularFire](https://github.com/angular/angularfire) package:
27
28
28
29
```bash
29
30
npm install @firebase-ui/angular @angular/fire
30
31
```
31
-
</details>
32
32
33
+
</details>
33
34
34
35
## Setup
35
36
36
37
FirebaseUI requires that your Firebase app is setup following the [Getting Started with Firebase](https://firebase.google.com/docs/web/setup) flow for Web:
37
38
39
+
### Initialization
40
+
38
41
```ts
39
42
import { initializeApp } from'firebase/app';
40
43
@@ -56,7 +59,7 @@ Next, follow the flow for your framework to setup FirebaseUI:
56
59
<details>
57
60
<summary>React</summary>
58
61
59
-
FirebaseUI for React requires that your application be wrapped in the `ConfigProvider`, providing the initalized UI configuration. React expects the `FirebaseApp` instance be provided to the `initializeUI` configuration:
62
+
FirebaseUI for React requires that your application be wrapped in the `ConfigProvider`, providing the initialized UI configuration. React expects the `FirebaseApp` instance be provided to the `initializeUI` configuration:
60
63
61
64
```tsx
62
65
import { initializeApp } from'firebase/app';
@@ -74,6 +77,7 @@ Next, follow the flow for your framework to setup FirebaseUI:
74
77
</StrictMode>
75
78
);
76
79
```
80
+
77
81
</details>
78
82
79
83
<details>
@@ -97,8 +101,11 @@ Next, follow the flow for your framework to setup FirebaseUI:
97
101
...
98
102
})
99
103
```
104
+
100
105
</details>
101
106
107
+
### Styling
108
+
102
109
Next, import the CSS styles for the FirebaseUI project.
103
110
104
111
If you are using [TailwindCSS](https://tailwindcss.com/), import the base CSS from the `@firebase-ui/styles` package after your Tailwind import:
@@ -114,7 +121,7 @@ If you are not using Tailwind, import the distributable CSS in your project:
114
121
@import"@firebase-ui/styles/dist.css";
115
122
```
116
123
117
-
> To learn more about theming, view the [theming](#theming) section.
124
+
To learn more about theming, view the [theming](#theming) section.
118
125
119
126
## Authentication Components
120
127
@@ -150,6 +157,7 @@ Allows users to sign in with an email and password:
150
157
);
151
158
}
152
159
```
160
+
153
161
</details>
154
162
155
163
<details>
@@ -180,6 +188,7 @@ Allows users to sign in with an email and password:
0 commit comments