Skip to content
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

Libraries support for Firebase #249

Merged
merged 5 commits into from
Jan 15, 2025
Merged
Changes from 1 commit
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
20 changes: 17 additions & 3 deletions docs/resources/projects/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,6 @@ To publish a FlutterFlow project as a library, start by creating a FlutterFlow p
When a project is converted into a library, the following features are disabled to ensure compatibility and functionality limitations:

- App settings
- Firebase
- Supabase
- Development environments
- Authentication
Expand All @@ -98,8 +97,6 @@ When a project is converted into a library, the following features are disabled
- Google Analytics
- OneSignal
- Mux
- Cloud functions
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leighajarett just fyi, I have removed this as well.

- Firestore Collections

## Importing a Library

Expand Down Expand Up @@ -318,6 +315,23 @@ To set library values, navigate to **Settings and Integrations > Project Setup >
For different [**development environments**](../../testing-deployment-publishing/development-environments/development-environments.md) (e.g., development vs. production), you can bind Library Values to [**environment values**](../../testing-deployment-publishing/development-environments/development-environments.md#use-environment-values). For instance, you could have two different Library Values for an API key, such as `DEV_OPENAI_API_KEY` and `PROD_OPENAI_API_KEY`, and bind them to the development and production environments to track API usage separately.
:::

## Libraries with Firebase
You can create collections and enable various Firebase features in library projects without connecting a separate Firebase project.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about marketplace Library projects? Will they also have Firebase project enabled and marketplace users can use that directly ? Shouldn't be the case, right? @pinkeshmars


In library projects, you won’t see an option to link to a Firebase project. Instead, the project that imports the library handles the actual Firebase connection.

Any indexes or security rules defined in the library are recognized by the importing project and deployed accordingly.

:::warning
PoojaB26 marked this conversation as resolved.
Show resolved Hide resolved
Libraries work with Firebase but have **some limitations**. The **Firebase Auth** and **Firebase Storage** are not directly supported in library projects at this time. If you need these features in your library’s functionality, you can include an action that accomplishes this task as a [**callback**](../../resources/ui/components/callbacks.md).
:::

Here are some examples of library projects you can build with Firebase:

- **Notes or Reminders Lists**: A library that manages basic collections for notes, tasks, or reminders.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is a good example. But rather we can say if your team is working on multiple projects and all of them have a common feature that uses Firebase such as XYZ then its a great usecase to convert that into a Library so it can have the same logic and connect to the same Firestore project.

- **Basic Analytics or Tracking**: A library that logs events to Firestore; useful for aggregating usage data at an application level.
- **Configuration or Settings**: A library that serves app-wide configurations (like feature flags, UI themes, or layout choices) is handled in Firebase Remote Config.

## FAQs

<details>
Expand Down
Loading