Skip to content

Commit 2a83099

Browse files
committed
Leigha changes
1 parent fe99221 commit 2a83099

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

docs/resources/projects/libraries.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ slug: libraries
33
title: Libraries
44
tags: [Libraries]
55
keywords: [Libraries, Share, Reuse, Collaborate, Modularize, Dependency]
6-
description: Learn how to share and reuse entire FlutterFlow projects suing libraries.
7-
sidebar_position: 4
6+
description: Learn how to share and reuse entire FlutterFlow projects using libraries.
7+
sidebar_position: 6
88
---
99
import Tabs from '@theme/Tabs';
1010
import TabItem from '@theme/TabItem';
@@ -46,7 +46,7 @@ To publish a FlutterFlow project as a library, start by creating a FlutterFlow p
4646
width: '100%'}}>
4747
<iframe
4848
src="https://demo.arcade.software/CTuBPgISjpRWy5TT6rRD?embed&show_copy_link=true"
49-
title=""
49+
title="Publishing a Library"
5050
style={{
5151
position: 'absolute',
5252
top: 0,
@@ -68,6 +68,8 @@ To publish a FlutterFlow project as a library, start by creating a FlutterFlow p
6868
:::info
6969
- You can only publish libraries if you have access to branching, which is available to Pro+ users.
7070
- Libraries can only be published from the main branch, and each published version is linked to a specific commit, ensuring robust version control.
71+
- You must commit your changes before publishing a new version of the library.
72+
- It's recommended to include a message that tells users what has changed in the version your are publishing.
7173
:::
7274

7375
### Disabled Features in a Library
@@ -92,7 +94,7 @@ When a project is converted into a library, the following features are disabled
9294

9395
## Importing a Library
9496

95-
Open the FlutterFlow project where you'd like to import a library, then follow these steps:
97+
To import a library project into another FlutterFlow project, you must go to the **Project Dependencies** page in **App Settings**. Here you can specify the library project and version you are importing.
9698

9799
<div style={{
98100
position: 'relative',
@@ -101,7 +103,7 @@ Open the FlutterFlow project where you'd like to import a library, then follow t
101103
width: '100%'}}>
102104
<iframe
103105
src="https://demo.arcade.software/DrzjKuhTWZXOxBB5yGJn?embed&show_copy_link=true"
104-
title=""
106+
title="Importing a Library"
105107
style={{
106108
position: 'absolute',
107109
top: 0,
@@ -121,7 +123,14 @@ Open the FlutterFlow project where you'd like to import a library, then follow t
121123
<p></p>
122124

123125
:::info
124-
You can only select a library if you have been added as a collaborator in that library project. To use a library, you must have one of these roles in the library project: Owner, Manager, Editor, or Read-Only.
126+
127+
- You can only select a library if you have at least read access on the library project.
128+
- For a library project to show in the drop down, you must be added as a collaborator on the project and the library project must have a published version.
129+
- You can import publicly accessible libraries by specifying the project ID in the text field when adding a library dependency.
130+
- By default, the latest published version of the library is imported, but you can choose to depend on an earlier version if needed.
131+
- You can also import the `current` version of the library to use the latest state of the library on the main branch - however, this is not recommended.
132+
- You must have a paid plan to import a library.
133+
125134
:::
126135

127136

@@ -222,19 +231,19 @@ You can easily upgrade to newer versions of the libraries as they become availab
222231
<details>
223232
<summary>What will happen to existing team libraries?</summary>
224233
<p>
225-
Team code and API libraries will be migrated to Library Projects. These projects will be imported as a library with the latest version specified as the version. The components within team design systems will move into their own projects, while design systems will continue to exist but only containing the theme settings.
234+
Team code and API libraries will be migrated to library Projects. These projects will be imported as a library with the latest version specified as the version. The components within team design systems will move into their own projects, while design systems will continue to exist but only containing the theme settings.
226235
</p>
227236
</details>
228237

229238
<details>
230-
<summary>Will Libraries work with Marketplace?</summary>
239+
<summary>Will libraries work with Marketplace?</summary>
231240
<p>
232241
We plan to allow users to import a marketplace project as a library, making it easier to integrate marketplace resources into your projects.
233242
</p>
234243
</details>
235244

236245
<details>
237-
<summary>How do Libraries work with themes?</summary>
246+
<summary>How do libraries work with themes?</summary>
238247
<p>
239248
The parent project's design system takes precedence over the imported library's design system. For example, if a library uses the standard FlutterFlow color scheme, the values defined in the parent project will override those in the library. However, if the library project has a custom color that the parent project does not have, it will be used as-is in the parent project.
240249
</p>
@@ -243,13 +252,13 @@ The parent project's design system takes precedence over the imported library's
243252
<details>
244253
<summary>How are API keys shared?</summary>
245254
<p>
246-
We're planning to leverage environment variables, as part of the Development Environment features, to allow users to add their API keys to their own projects. This ensures that the API key is not shared when the project is published as a library.
255+
We're working on Library Values, which will allow users to set specific values when they import a library. This feature will be available soon.
247256
</p>
248257
</details>
249258

250259
<details>
251260
<summary>How does nested dependencies work?</summary>
252261
<p>
253-
Projects can import Libraries that themselves have imported other Libraries as dependencies. However, if the project and the Library share the same dependency, the version must match exactly to avoid conflicts.
262+
Projects can import libraries that themselves have imported other Libraries as dependencies. However, if the project and the library share the same dependency, the version must match exactly to avoid conflicts.
254263
</p>
255264
</details>

0 commit comments

Comments
 (0)