Skip to content

docs(*): Readme updates for Configuration and dependencies #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 41 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,22 @@ FirebaseUI requires the `firebase` package to be installed:
npm install firebase
```

(Since the packages are not published, the peer dependencies are not installed automatically from source (core & styles). This will not be required once published.)
**Note**: Since the packages are not yet published to npm, you must manually install them from GitHub releases. Once published, these steps will be simplified.

Next, follow the installation flow for your framework:
###  Framework-specific Installation

Packages have created for both `React` and `Angular`.

<details>
<summary>React</summary>

```json
{
"dependencies": {
"@firebase-ui/core": "path-to-repo/releases/firebase-ui-core-0.0.1.tgz",
"@firebase-ui/styles": "path-to-repo/releases/firebase-ui-styles-0.0.1.tgz",
"@firebase-ui/react": "path-to-repo/releases/firebase-ui-react-0.0.1.tgz"
"@firebase-ui/react": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Freact%400.0.1/firebase-ui-react-0.0.1.tgz",
"@firebase-ui/core": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Fcore%400.0.1/firebase-ui-core-0.0.1.tgz",
"@firebase-ui/styles": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Fstyles%400.0.1/firebase-ui-styles-0.0.1.tgz",
"@firebase-ui/translations": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Ftranslations%400.0.1/firebase-ui-translations-0.0.1.tgz",
}
}
```
Expand All @@ -39,10 +42,12 @@ Next, follow the installation flow for your framework:
```json
{
"dependencies": {
"@firebase-ui/core": "path-to-repo/releases/firebase-ui-core-0.0.1.tgz",
"@firebase-ui/styles": "path-to-repo/releases/firebase-ui-styles-0.0.1.tgz",
"@firebase-ui/amgular": "path-to-repo/releases/firebase-ui-angular-0.0.1.tgz",
"@firebase-ui/angular": "[path-to-repo/releases/firebase-ui-angular-0.0.1.tgz](https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Fcore%400.0.1/firebase-ui-angular-0.0.1.tgz)",
"@angular/fire": "^19.0.0"
"@firebase-ui/core": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Fcore%400.0.1/firebase-ui-core-0.0.1.tgz",
"@firebase-ui/styles": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Fstyles%400.0.1/firebase-ui-styles-0.0.1.tgz",
"@firebase-ui/translations": "https://github.com/invertase/firebaseui-web/releases/download/%40firebase-ui%2Ftranslations%400.0.1/firebase-ui-translations-0.0.1.tgz",

}
}
```
Expand All @@ -51,7 +56,7 @@ Next, follow the installation flow for your framework:

</details>

## Setup
## Getting Started

FirebaseUI requires that your Firebase app is setup following the [Getting Started with Firebase](https://firebase.google.com/docs/web/setup) flow for Web:

Expand All @@ -73,7 +78,7 @@ const ui = initializeUI();

> To learn more about configuring FirebaseUI, view the [configuration](#configuration) section.

Next, follow the flow for your framework to setup FirebaseUI:
### Framework Setup

<details>
<summary>React</summary>
Expand Down Expand Up @@ -118,7 +123,7 @@ Next, follow the flow for your framework to setup FirebaseUI:
...
],
...
})
}
```

</details>
Expand All @@ -142,7 +147,7 @@ If you are not using Tailwind, import the distributable CSS in your project:

To learn more about theming, view the [theming](#theming) section.

## Authentication Components
### Authentication Components

FirebaseUI provides a number of opinionated components designed to drop into your application which handle common user flows, such as signing in or registration.

Expand Down Expand Up @@ -192,11 +197,34 @@ Allows users to sign in with an email and password:
})
export class AppComponent { }
```

</details>

## Configuration

TODO: Update once configuration is finalized.
The initializeUI function accepts an options object that allows you to customize FirebaseUI’s behavior.

### Type Definition

```js
type FirebaseUIConfigurationOptions = {
app: FirebaseApp;
locale?: Locale | undefined;
translations?: RegisteredTranslations[] | undefined;
behaviors?: Partial<Behavior<keyof BehaviorHandlers>>[] | undefined;
recaptchaMode?: 'normal' | 'invisible' | undefined;
};
```

**App**: The initialized Firebase app instance. This is required.

**Locale**: Optional locale string to override the default language (e.g., 'en', 'fr', 'es').

**Translations**: Add or override translation strings for labels, prompts, and errors.

**Behaviors**: Customize UI behavior such as automatic sign-in or error handling.

**RecaptchaMode**:Set the reCAPTCHA mode for phone auth (default is 'normal').

## Theming

Expand Down
3 changes: 3 additions & 0 deletions examples/angular/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Firebase UI Angular Example

The example application for this framework can be found in the [packages](https://github.com/invertase/firebaseui-web/tree/d851cd6b38ca061845b202c1073ed7ca538022e1/packages/angular) folder.