Skip to content

Commit eb01d00

Browse files
committed
Addressed review comments
1 parent 4ac6380 commit eb01d00

File tree

10 files changed

+82
-42
lines changed

10 files changed

+82
-42
lines changed

docs/intro/ff-ui/builder.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,27 @@
22
slug: builder
33
title: App Builder
44
tags: []
5+
description: Explore the App Builder in FlutterFlow, featuring a comprehensive interface with four main sections. Navigation Menu, Toolbar, Canvas, and Properties Panel.
56
---
67

78
# App Builder
89

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).
1011

1112
![AppBuilder.avif](imgs/AppBuilder.avif)
1213

13-
## 1. Navigation Menu
14+
## 1. Navigation Menu {#navigation-menu}
1415

1516
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.
1617

17-
## 2. Tool Bar
18+
## 2. Tool Bar {#toolbar}
1819

1920
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.
2021

21-
## 3. Canvas Area
22+
## 3. Canvas Area {#canvas-area}
2223

2324
In the [Canvas Area](canvas), you can see a preview of your mobile device's screen and build your app page.
2425

25-
## 4. Properties Panel
26+
## 4. Properties Panel {#properties-panel}
2627

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.

docs/intro/ff-ui/canvas.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: canvas
33
title: Canvas
44
tags: []
5+
description: Dive into the versatile Canvas in FlutterFlow, where you can effortlessly design and preview your app’s interface.
56
---
67

78
# Canvas
@@ -48,7 +49,7 @@ This becomes really helpful in testing your app design with translated text with
4849
width: '100%'
4950
}}>
5051
<iframe
51-
src="https://demo.arcade.software/ViB374dOSglo4Z1afa0o?embed&show_copy_link=true"
52+
src="https://demo.arcade.software/E6otMpbcKewMYCfkjl9d?embed&show_copy_link=true"
5253
title="Sharing a Project with a User"
5354
style={{
5455
position: 'absolute',
141 KB
Loading

docs/intro/ff-ui/navigation-menu.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: navigation-menu
33
title: Navigation Menu
44
tags: []
5+
description: Explore the Navigation Menu in FlutterFlow, your central hub for accessing a wealth of development features and tools.
56
---
67

78
# Navigation Menu

docs/intro/ff-ui/resource-hierarchy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: resource-hierarchy
33
title: Resource Hierarchy Overview
44
tags: []
5+
description: Explore the Resource Hierarchy Overview to understand the correlation between traditional Flutter app components and their equivalents in FlutterFlow.
56
---
67

78
# Resource hierarchy overview
@@ -14,7 +15,7 @@ This diagram serves as a useful guide for developers transitioning from a tradit
1415

1516
## 1. MyApp to Project
1617

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).
1819

1920
## 2. MyPage to Page
2021

docs/intro/ff-ui/storyboard.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: storyboard
33
title: Storyboard
44
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.
56
---
67

78
# Storyboard
@@ -30,7 +31,7 @@ We use the following elements inside the storyboard:
3031

3132
## Highlight routes on a page
3233

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.
3435

3536
![highlight-routes.avif](imgs/highlight-routes.avif)
3637

docs/intro/ff-ui/toolbar.md

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: toolbar
33
title: Toolbar
44
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.
56
---
67

78
# Toolbar
@@ -95,23 +96,14 @@ We allow you to visualize and design your app for various mobile, tablet, and de
9596
allow="clipboard-write">
9697
</iframe>
9798
</div>
99+
98100
## 6. Project history
99101

100-
Versions
102+
### Versions
101103

102104
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.
103105

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
115107

116108
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.
117109

@@ -142,11 +134,22 @@ Ideally, you should save the version whenever you accomplish something important
142134
allow="clipboard-write">
143135
</iframe>
144136
</div>
145-
### 6.2 Restoring a version
146137

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+
![restore-version.png](imgs/restore-version.png)
143+
144+
### Snapshots
145+
146+
Snapshots are automatically saved as you build.
147+
148+
:::info
148149

149-
![Screenshot 2024-05-06 at 10.57.51 AM.png](https://prod-files-secure.s3.us-west-2.amazonaws.com/09694bda-16f5-490f-aaac-3601b64ca6a2/62cabaee-ff75-496b-be7e-6df40a3cd8f2/Screenshot_2024-05-06_at_10.57.51_AM.png)
150+
Users on the *Free* and *Standard* plans can access only one day of snapshots.
151+
152+
:::
150153

151154
## 7. Project comments
152155

@@ -162,9 +165,9 @@ To tag users, select the @ symbol and choose the project team member(s).
162165

163166
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.
164167

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.
166169

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.
168171

169172
:::info
170173

@@ -178,6 +181,10 @@ You can control what kind of suggestions you would like to receive by clicking o
178181

179182
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.
180183

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.
187+
181188
![Warning-and-errors.avif](imgs/Warning-and-errors.avif)
182189

183190
## 10. Branching
@@ -188,24 +195,32 @@ If there are any issues or warnings present in your current project that might r
188195

189196
From here, you can view the code for your project, connect to GitHub, and also download the source code for your project.
190197

191-
## 11.1 View Code
198+
### 11.1 View Code
192199

193200
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.
194201

195-
## 11.2 Connect GitHub Repo (Paid Feature)
202+
### 11.2 Connect GitHub Repo (Paid Feature)
196203

197204
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.
198205

199206
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.
200207

201-
### 11.3 Download Code (Paid Feature)
208+
### 11.3 Download Code
202209

203210
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.
204211

205-
### 11.4 Download APK (Paid Feature)
212+
:::note
213+
This feature requires a paid plan.
214+
:::
215+
216+
### 11.4 Download APK
206217

207218
Use this to generate a release build of your app. It will automatically download the `.apk` file after the building process is complete.
208219

220+
:::note
221+
This feature requires a paid plan.
222+
:::
223+
209224
### 11.5 FlutterFlow CLI
210225

211226
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
223238

224239
## 13. Preview
225240

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.
227242

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.
229244

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.
231246

232247
## 14. Testing
233248

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.

docs/intro/ff-ui/widget-palette.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: widget-palette
33
title: Widget Palette
44
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.
56
---
67
# Widget Palette
78

docs/intro/quickstart.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: quickstart
33
title: Quick Start Guide
44
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.
56
---
67

78
# **Quick Start Guide**
@@ -12,7 +13,8 @@ This quickstart is designed to be straightforward and accessible, introducing yo
1213
<!-- TO DO: add links to resource section later on -->
1314

1415
Below is a preview of what your app will look like once completed:
15-
<img src="../../static/img/flutterflow-quick-start-app-demo.avif" alt="flutterflow-quick-start-app-demo.avif" />
16+
17+
![Quick start demo app](../../static/img/flutterflow-quick-start-app-demo.avif)
1618

1719
## **What you'll learn**
1820
- Creating layouts (add widgets)

sidebars.ts

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,30 @@ const sidebars: SidebarsConfig = {
99
type: 'category',
1010
label: 'Getting Started',
1111
collapsed: false,
12-
items: ['index', {
13-
type: 'category', label: "Before You Begin", items: [
14-
'intro/before-you-begin/setting-up-flutterflow', 'intro/before-you-begin/app-architecture', 'intro/quickstart'
15-
]
16-
},{type: 'category', label: "FlutterFlow UI", items: [
17-
'intro/ff-ui/builder', 'intro/ff-ui/navigation-menu','intro/ff-ui/widget-palette','intro/ff-ui/storyboard','intro/ff-ui/toolbar','intro/ff-ui/canvas','intro/ff-ui/resource-hierarchy'
18-
]}],
12+
items: ['index'],
13+
},
14+
,'intro/quickstart',
15+
{
16+
type: 'category',
17+
label: 'Before You Begin',
18+
collapsed: false,
19+
items: [
20+
{
21+
type: 'autogenerated',
22+
dirName: 'intro/before-you-begin'
23+
}
24+
],
25+
},
26+
{
27+
type: 'category',
28+
label: 'Understanding the FlutterFlow UI',
29+
collapsed: false,
30+
items: [
31+
{
32+
type: 'autogenerated',
33+
dirName: 'intro/ff-ui'
34+
}
35+
],
1936
},
2037
{
2138
type: 'category',

0 commit comments

Comments
 (0)