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: docs/intro/ff-ui/builder.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,26 +2,27 @@
2
2
slug: builder
3
3
title: App Builder
4
4
tags: []
5
+
description: Explore the App Builder in FlutterFlow, featuring a comprehensive interface with four main sections. Navigation Menu, Toolbar, Canvas, and Properties Panel.
5
6
---
6
7
7
8
# App Builder
8
9
9
-
On opening the project, you'll see the App Builder, which consists of four main sections: Navigation Menu, Toolbar, Canvas, and Properties panel.
10
+
On opening the project, you'll see the App Builder, which consists of four main sections: [Navigation Menu](#navigation-menu), [Toolbar](#toolbar), [Canvas](#canvas-area), and [Properties panel](#properties-panel).
10
11
11
12

12
13
13
-
## 1. Navigation Menu
14
+
## 1. Navigation Menu {#navigation-menu}
14
15
15
16
The [Navigation Menu](navigation-menu) provides access to the project's widget palette, widget tree, storyboard, and features like Firestore, API calls, asset uploads, app values, integrations, custom functions, theme settings, and more.
16
17
17
-
## 2. Tool Bar
18
+
## 2. Tool Bar {#toolbar}
18
19
19
20
From [Tool Bar](toolbar), you can search for project resources, change canvas size, see project history, branching, optimization and enhancements, view-download code, and run your app.
20
21
21
-
## 3. Canvas Area
22
+
## 3. Canvas Area {#canvas-area}
22
23
23
24
In the [Canvas Area](canvas), you can see a preview of your mobile device's screen and build your app page.
24
25
25
-
## 4. Properties Panel
26
+
## 4. Properties Panel {#properties-panel}
26
27
27
-
The Properties Panel lets you modify both the visual appearance and interactive behavior of UI elements on the canvas. It allows you to add Actions, set up a Backend Query, add Animations and more.
28
+
The Properties Panel lets you modify both the visual appearance and interactive behavior of UI elements on the canvas. It allows you to add [Actions](#), set up a [Backend Query](#), add [Animations](#) and more.
Copy file name to clipboardExpand all lines: docs/intro/ff-ui/resource-hierarchy.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
slug: resource-hierarchy
3
3
title: Resource Hierarchy Overview
4
4
tags: []
5
+
description: Explore the Resource Hierarchy Overview to understand the correlation between traditional Flutter app components and their equivalents in FlutterFlow.
5
6
---
6
7
7
8
# Resource hierarchy overview
@@ -14,7 +15,7 @@ This diagram serves as a useful guide for developers transitioning from a tradit
14
15
15
16
## 1. MyApp to Project
16
17
17
-
In Flutter, `MyApp` typically represents the root of your application, where you set up routes and other global configurations. In FlutterFlow, the equivalent is the "Project," which encompasses the entire application you are building, including its configurations and settings. Learn more about creating a project [here](#).
18
+
In Flutter, `MyApp` typically represents the root of your application, where you set up routes and other global configurations. In FlutterFlow, the equivalent is the "Project," which encompasses the entire application you are building, including its configurations and settings. Learn more about creating a project [here](../../resources/Projects/how-to-create-find-organize-projects#how-to-create-a-project).
Copy file name to clipboardExpand all lines: docs/intro/ff-ui/storyboard.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
slug: storyboard
3
3
title: Storyboard
4
4
tags: []
5
+
description: Master the Storyboard view in FlutterFlow to visualize your app’s design and user navigation. The Storyboard allows you to see screens and interactions, ensuring a seamless user experience.
5
6
---
6
7
7
8
# Storyboard
@@ -30,7 +31,7 @@ We use the following elements inside the storyboard:
30
31
31
32
## Highlight routes on a page
32
33
33
-
With so many pages displayed on a Storyboard, it may be difficult to identify what routes are coming and where they go from a specific page, especially when lines overlap each other. To highlight the incoming and outgoing routes on a specific page, just click on a page, and the routes will be highlighted in blue color.
34
+
With so many pages displayed on a storyboard, it may be difficult to identify which routes are coming and where they go from a specific page, especially when lines overlap each other. To highlight the incoming and outgoing routes on a specific page, simply click on the page, and the routes will be highlighted in blue.
Copy file name to clipboardExpand all lines: docs/intro/ff-ui/toolbar.md
+40-25Lines changed: 40 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
slug: toolbar
3
3
title: Toolbar
4
4
tags: []
5
+
description: Navigate the Toolbar in FlutterFlow for efficient access to essential tools and features. This includes project management, version control, interactive help resources, and direct actions like running your app, reporting issues, and customizing your workspace.
5
6
---
6
7
7
8
# Toolbar
@@ -95,23 +96,14 @@ We allow you to visualize and design your app for various mobile, tablet, and de
95
96
allow="clipboard-write">
96
97
</iframe>
97
98
</div>
99
+
98
100
## 6. Project history
99
101
100
-
Versions
102
+
### Versions
101
103
102
104
Versions enable you to save specific named states of your project. This function is particularly useful for recovery purposes. If you accidentally delete a page or component or change settings, you can easily revert to a saved version.
103
105
104
-
Snapshots
105
-
106
-
Snapshots are automatically saved as you build.
107
-
108
-
:::info
109
-
110
-
Users on the *Free* and *Standard* plans can access only one day of snapshots.
111
-
112
-
:::
113
-
114
-
### 6.1 Saving a version
106
+
#### 6.1 Saving a version
115
107
116
108
Saving the latest changes will store the current state of your app in the version control. In the future, if anything goes wrong, you can restore your app to the currently saved state.
117
109
@@ -142,11 +134,22 @@ Ideally, you should save the version whenever you accomplish something important
142
134
allow="clipboard-write">
143
135
</iframe>
144
136
</div>
145
-
### 6.2 Restoring a version
146
137
147
-
Restoring the previous version will preserve the current version, then load the changes from the version you're restoring. Before restoration, you may want to view the changes in the previous version. To do this, select the Peek option, which opens the previous version in a new tab.
138
+
#### 6.2 Restoring a version
139
+
140
+
Restoring the previous version will preserve the current version, then load the changes from the version you're restoring. Before restoration, you may want to view the changes in the previous version. To do this, select the **Peek** option, which opens the previous version in a new tab.
141
+
142
+

143
+
144
+
### Snapshots
145
+
146
+
Snapshots are automatically saved as you build.
147
+
148
+
:::info
148
149
149
-

150
+
Users on the *Free* and *Standard* plans can access only one day of snapshots.
151
+
152
+
:::
150
153
151
154
## 7. Project comments
152
155
@@ -162,9 +165,9 @@ To tag users, select the @ symbol and choose the project team member(s).
162
165
163
166
We scan and suggest enhancements to elevate your app's design and speed. Imagine having a personal consultant for design and performance dedicated to improving the user experience of your app.
164
167
165
-
Optimizations: We spotlight elements that may slow down your app. For example, a query on a column, unused and duplicate backend query, a widget with unbounded size, etc.
168
+
**Optimizations**: We spotlight elements that may slow down your app. For example, a query on a column, unused and duplicate backend query, a widget with unbounded size, etc.
166
169
167
-
UI Enhancements: We offer tips for a more visually appealing and user-friendly design, like resizing a small tap target of any widget.
170
+
**UI Enhancements**: We offer tips for a more visually appealing and user-friendly design, like resizing a small tap target of any widget.
168
171
169
172
:::info
170
173
@@ -178,6 +181,10 @@ You can control what kind of suggestions you would like to receive by clicking o
178
181
179
182
If there are any issues or warnings present in your current project that might result in a build failure or app crash, they will be displayed in this section. You can click this option to view a short description of each issue and navigate to the place where you can fix the issue by clicking on the respective issue.
180
183
184
+
Errors prevent your app from compiling and running. These must be resolved in order to run the app. They can be due to missing actions, errors in custom code, incorrect data types, and so on.
185
+
186
+
Warnings, while not preventing compilation, indicate potential issues such as incorrect rules setup or performance problems. Although it's possible to ignore warnings, addressing them can enhance the quality of your app and prevent future issues.
@@ -188,24 +195,32 @@ If there are any issues or warnings present in your current project that might r
188
195
189
196
From here, you can view the code for your project, connect to GitHub, and also download the source code for your project.
190
197
191
-
## 11.1 View Code
198
+
###11.1 View Code
192
199
193
200
This option lets you display the *Dart* code for all the pages of your FlutterFlow project. You can also take a look at the dependencies being used by the app here.
194
201
195
-
## 11.2 Connect GitHub Repo (Paid Feature)
202
+
###11.2 Connect GitHub Repo (Paid Feature)
196
203
197
204
You can use this option to connect your project with your [GitHub](https://github.com/) account and upload it to a GitHub repository. When you click this option, you will be navigated to the Settings and Integrations > Integrations > Github section.
198
205
199
206
From there, you can configure your project to add GitHub integration to it. You can get a detailed [step-by-step guide](#) for connecting to GitHub.
200
207
201
-
### 11.3 Download Code (Paid Feature)
208
+
### 11.3 Download Code
202
209
203
210
You can download the entire codebase of the app generated by FlutterFlow using this option. It will download a `.zip` file. You can open the contents using any code editor to make modifications.
204
211
205
-
### 11.4 Download APK (Paid Feature)
212
+
:::note
213
+
This feature requires a paid plan.
214
+
:::
215
+
216
+
### 11.4 Download APK
206
217
207
218
Use this to generate a release build of your app. It will automatically download the `.apk` file after the building process is complete.
208
219
220
+
:::note
221
+
This feature requires a paid plan.
222
+
:::
223
+
209
224
### 11.5 FlutterFlow CLI
210
225
211
226
You can also download the code using *[FlutterFlow CLI](https://pub.dev/packages/flutterflow_cli)*. See instructions [here](#).
@@ -223,12 +238,12 @@ You can make a project public so that others can view and clone your project. Be
223
238
224
239
## 13. Preview
225
240
226
-
You can use the Preview mode to quickly try out your app on a virtual device without waiting for it to build. This helps you to have a good overview of the navigation and animations you have added to your app. You can also preview your app in the Dark/Light mode and visualize it on various mobile, tablet, and desktop devices.
241
+
You can use the [Preview mode](../../resources/Projects/how-to-run-test-projects#preview-mode) to quickly try out your app on a virtual device without waiting for it to build. This helps you to have a good overview of the navigation and animations you have added to your app. You can also preview your app in the Dark/Light mode and visualize it on various mobile, tablet, and desktop devices.
227
242
228
-
This mode has a few limitations; you can't use Firebase or perform API calls in the *Preview* mode. However, the onDoubleTap, onLongPress, and onSubmit works in this mode.
243
+
This mode has a few limitations; you can't use Firebase or perform API calls in the Preview mode. However, the onDoubleTap, onLongPress, and onSubmit works in this mode.
229
244
230
-
A list of unsupported features is displayed in the Known Issues menu in *Preview mode*.
245
+
A list of unsupported features is displayed in the Known Issues menu in Preview mode.
231
246
232
247
## 14. Testing
233
248
234
-
This menu allows you to run your app in [Test](#) or [Run](#) mode.
249
+
This menu allows you to run your app in [Test](../../resources/Projects/how-to-run-test-projects#test-mode) or [Run](../../resources/Projects/how-to-run-test-projects#run-mode) mode.
Copy file name to clipboardExpand all lines: docs/intro/ff-ui/widget-palette.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
slug: widget-palette
3
3
title: Widget Palette
4
4
tags: []
5
+
description: Explore the Widget Palette in FlutterFlow to access a wide range of UI elements. This feature offers an intuitive interface for dragging and dropping Flutter widgets onto your canvas.
Copy file name to clipboardExpand all lines: docs/intro/quickstart.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
slug: quickstart
3
3
title: Quick Start Guide
4
4
tags: []
5
+
description: Jumpstart your FlutterFlow journey with our Quick Start Guide. Learn to build a dynamic app and explore essential FlutterFlow features like UI building, state management, and app execution.
5
6
---
6
7
7
8
# **Quick Start Guide**
@@ -12,7 +13,8 @@ This quickstart is designed to be straightforward and accessible, introducing yo
12
13
<!-- TO DO: add links to resource section later on -->
13
14
14
15
Below is a preview of what your app will look like once completed:
0 commit comments