Skip to content

Commit 8e3c5a5

Browse files
committed
Address review comments
1 parent 05af43b commit 8e3c5a5

File tree

6 files changed

+40
-38
lines changed

6 files changed

+40
-38
lines changed

docs/intro/ff-ui/builder.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ On opening the project, you'll see the App Builder, which consists of four main
1212

1313
![app-builder](imgs/builder.avif)
1414

15-
## 1. Navigation Menu {#navigation-menu}
15+
## Navigation Menu {#navigation-menu}
1616

1717
The Navigation Menu, located on the left side of the builder, allows you to switch between various FlutterFlow features. These include designing the UI, managing databases, setting up API, adjusting app settings, adding integrations, and more.
1818

@@ -34,14 +34,14 @@ Here is a list of all the features accessible from the navigation menu:
3434
14. **Theme settings**: Customize visual appearance.
3535
15. **Settings and Integrations**: Access app-related settings and integrations.
3636

37-
## 2. Tool Bar {#toolbar}
37+
## ToolBar {#toolbar}
3838

39-
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.
39+
From [ToolBar](toolbar), you can search for project resources, change canvas size, see project history, branching, optimization and enhancements, view-download code, and run your app.
4040

41-
## 3. Canvas Area {#canvas-area}
41+
## Canvas Area {#canvas-area}
4242

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

45-
## 4. Properties Panel {#properties-panel}
45+
## Properties Panel {#properties-panel}
4646

4747
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: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,29 @@ It allows zoom level adjustments and previews in light or dark mode. It also inc
1313

1414
![canvas area](imgs/canvas-new.avif)
1515

16-
## 1. Preview Screen
16+
## Preview Screen
1717

1818
This is the canvas of the device screen where you can build the user interface. You can customize the screen by adding widgets using drag and drop from the [Widget Palette](#) and by applying properties present in the [Properties Panel](#).
1919

20-
## 2. Show or hide Navigation Menu
20+
## Show or hide Navigation Menu
2121

2222
From here, you can open or close the [Navigation Menu](#).
2323

24-
## 3. Zoom Controls
24+
## Zoom Controls
2525

2626
There's a zoom in ( + ) and a zoom out ( - ) button to control the zoom level of the canvas. While working on complex user interface designs, this comes in handy to give you a better preview of the widgets by zooming in to a particular area and then zooming out to have an overview.
2727

28-
## 4. AI Generated Page
28+
## AI Generated Page
2929

3030
From here, you can [create a page using AI](#).
3131

32-
## 5. Add App Bar
32+
## Add App Bar
3333

3434
From here, you can add an [App Bar](#) to your page. Clicking this button opens a popup displaying different [App Bar styles](#) for you to choose from. Just select any App Bar style from the list and it will appear in the Preview Screen.
3535

3636
![AddAppBar.avif](imgs/AddAppBar.avif)
3737

38-
## 6. Multi-Language Preview
38+
## Multi-Language Preview
3939

4040
If you've enabled the multi-language feature for your project, you can use this to preview your app in different languages. Just select the language from the dropdown menu, and the text in your app will be translated accordingly.
4141

@@ -69,28 +69,28 @@ This feature is valuable for testing your app across multiple locales without ne
6969
</iframe>
7070
</div>
7171

72-
## 7. Dark/Light Mode
72+
## Dark/Light Mode
7373

7474
This toggle lets you switch between light and dark mode in your app, allowing you to ensure your design looks great in both modes. This feature is only available if you've enabled dark mode support in your project.
7575

76-
## 8. Display Device
76+
## Display Device
7777

78-
You can use this to show the device frame in the preview. This might come in handy if you want to visualize better or capture the user interface on a particular device.
78+
You can use this to show the device frame in the preview. This is particularly useful for checking how your screen will look with device-specific features such as the safe area or notches on iPhones and Android devices.
7979

80-
## 9. Handle Bars
80+
## Handle Bars
8181

82-
Enabling the Resize Handle Bars will show the handle bards at the right and bottom sides of the preview screen. This allows you to change the size of the preview screen to better test your app on a screen with a custom resolution and the overall responsiveness of your app.
82+
Enabling the Resize Handle Bars will show the handle bars at the right and bottom sides of the preview screen. This allows you to change the size of the preview screen to better test your app on a screen with a custom resolution and the overall responsiveness of your app.
8383

8484
![handle-bars](imgs/handle-bars.gif)
8585

86-
## 10. Show or hide Keyboard
86+
## Show or Hide Keyboard
8787
This option, when enabled, displays a virtual keyboard on the device preview screen. This is particularly useful for visualizing the user interface with the keyboard displayed.
8888

89-
## 11. Larger Font Visualization
89+
## Larger Font Visualization
9090

9191
This enables you to simulate how your app appears when users adjust text scale or accessibility settings on their devices. It's vital for developing an app that's visually appealing and also accessible, especially for those requiring larger text sizes.
9292

93-
## 12. Canvas Settings
93+
## Canvas Settings
9494
![canvas-settings](imgs/canvas-settings.avif)
9595
### Safe Area
9696
The Safe Area is a concept in mobile design that prevents content from being obscured by physical features of the device, such as camera notches, sensors, or rounded display edges. In this context, the FlutterFlow offers a Safe Area switch which allows you to enable or disable this feature as needed.
@@ -128,7 +128,7 @@ When resizing a widget, you can snap its size to the specific pixel values or a
128128
### Change canvas color
129129
Changing the canvas color can be helpful when creating components, especially when you want to preview them against the background color of the page. For example, if you have a text component that is black or dark-colored, and the default background is also dark, changing the canvas color to a lighter shade can improve visibility and make the design process easier.
130130

131-
## 13. Add Nav Bar
131+
## Add Nav Bar
132132

133133
This button allows you to add the [Nav Bar](#) to your page. Clicking on this button opens the popup that allows you to enable Nav Bar for your project. Once the Nav Bar is enabled, you can customize it to match your design.
134134

3.07 MB
Loading

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,5 @@ If you are coming from Flutter, it is beneficial for you to understand the Flutt
3131
1. **MyApp to Project**: 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).
3232
2. **MyPage to Page**: `MyPage` in Flutter represents a specific screen in the app. Similarly, In FlutterFlow, each "Page" corresponds to a screen, where you build the layout and functionality specific to that page of the project. Learn more about pages in FlutterFlow [here](../../resources/ui-building-blocks/pages/getting-started#creating-a-page).
3333
3. **Column, Button, Text to Built-in widgets**: In FlutterFlow, widgets are categorized under "Built-in widgets," which users can drag and drop onto their canvas to build the UI. Learn more about widgets [here](../../resources/ui-building-blocks/overview#widgets).
34-
4. **Custom widget to Component**: `CustomWidget` in Flutter indicates user-created widgets that serve specific functions not covered by built-in widgets. FlutterFlow translates this into "Component" allowing you to create and use custom components within your projects. Learn more about creating a component [here](#).
34+
4. **Custom widget to Component**: `CustomWidget` in Flutter indicates user-defined widgets that serve specific functions not covered by built-in widgets. FlutterFlow translates this into "Component" allowing you to create and use custom components within your projects. Learn more about creating a component [here](#).
3535
5. **Theme/style constants to Design System**: In Flutter, theme and style constants are used to ensure consistent styling across an app. FlutterFlow uses a "Design System" to manage and apply uniform styles and themes throughout the application. Learn more about design system [here](#).

docs/intro/ff-ui/toolbar.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ The Toolbar, located at the top of the app builder, provides easy access to nume
1212

1313
![toolbar](imgs/toolbar.avif)
1414

15-
## 1. Project info
15+
## Project info
1616

1717
Hovering over this section reveals the essential information about your project. Here, you can easily check the project name, the current version of FlutterFlow that you're using, along with its release date. Additionally, it shows the Flutter version that your project is currently running on.
1818

19-
## 2. Help
19+
## Help
2020

2121
From here, you will get access to essential resource links that will come in handy while building your apps.
2222

@@ -30,19 +30,19 @@ From here, you will get access to essential resource links that will come in han
3030
8. **Current Status/Known Issues**: We want to keep you informed about the current status of FlutterFlow and provide updates regarding any known issues. We aim to ensure transparency and keep you in the loop about the platform's performance and potential issues.
3131
9. **Show/Hide Chat**: You can use this option to show or hide the chat button at the bottom right of the app builder.
3232

33-
## 3. Keyboard shortcuts
33+
## Keyboard shortcuts
3434

3535
With keyboard shortcuts, you can perform common actions related to widgets and run your project in Test or Run mode with just a few keystrokes, saving you time and effort. Select this option to see all the shortcuts.
3636

3737
![keyboard-shortcut.avif](imgs/keyboard-shortcut.avif)
3838

39-
## 4. Command Palette
39+
## Command Palette
4040

4141
The Command Palette makes it easy to find and use things in the App Builder. Open the Command Palette by clicking the search button or pressing **Cmd/Ctrl + K**. Search for anything, and to find out where it's used, click the right arrow – we'll show you every place. To directly access the item, just click on it.
4242

4343
![command-palette.avif](imgs/command-palette.avif)
4444

45-
## 5. Canvas size
45+
## Canvas size
4646

4747
We allow you to visualize and design your app for various mobile, tablet, and desktop devices. The [canvas](#) size is defined as width (in pixels) x height (in pixels). This size is determined according to the device selected. To set a custom canvas size, click on the Canvas Size and enter the width and height (in pixels) you want.
4848

@@ -72,11 +72,11 @@ We allow you to visualize and design your app for various mobile, tablet, and de
7272
</iframe>
7373
</div>
7474

75-
## 6. Project history
75+
## Project history
7676

7777
Understand the crucial concepts of project history, such as saving and versioning [here](#).
7878

79-
## 7. Project comments
79+
## Project comments
8080

8181
This helps you leave your thoughts, opinions, questions, or feedback on a specific widget with your project team or a client. While adding a comment, you can tag users, and they will be able to respond, creating a thread of conversation.
8282

@@ -86,7 +86,7 @@ To tag users, select the @ symbol and choose the project team member(s).
8686

8787
:::
8888

89-
## 8. Optimizations & Enhancements
89+
## Optimizations & Enhancements
9090

9191
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.
9292

@@ -102,7 +102,7 @@ You can control what kind of suggestions you would like to receive by clicking o
102102

103103
![Optimization.avif](imgs/Optimization.avif)
104104

105-
## 9. Project issues
105+
## Project issues
106106

107107
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.
108108

@@ -114,11 +114,11 @@ If there are any issues or warnings present in your current project that might r
114114

115115
![Warning-and-errors.avif](imgs/Warning-and-errors.avif)
116116

117-
## 10. Branching
117+
## Branching
118118

119119
[Branching](#) enables you to create a separate copy of your existing project, allowing you to develop new features without affecting the current functionality.
120120

121-
## 11. Developer menu
121+
## Developer menu
122122
The Developer Menu provides developers with access to tools such as code viewing, GitHub integration, and source code download capabilities.
123123

124124
1. **View Code**: 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.
@@ -135,7 +135,7 @@ The Developer Menu provides developers with access to tools such as code viewing
135135
_Connect GitHub Repo_, _Download Code_, and _Download APK_ features requires a [**paid plan**](https://flutterflow.io/pricing).
136136
:::
137137

138-
## 12. Share project
138+
## Share project
139139

140140
You can make a project public so that others can view and clone your project. Before you share your project, make sure to remove any sensitive information.
141141

@@ -146,10 +146,10 @@ You can make a project public so that others can view and clone your project. Be
146146

147147
:::
148148

149-
## 13. Preview
149+
## Preview
150150

151151
You can use this option to run your app in [Preview mode](../../resources/Projects/how-to-run-test-projects#preview-mode).
152152

153-
## 14. Testing
153+
## Testing
154154

155155
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: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ Templates are predefined and ready-to-use widgets. These include UI elements tha
2525

2626
## 4. Theme Widgets
2727

28-
Theme Widgets allow you to customize the visual appearance of a single widget and then reuse it throughout the app. Once you [create a theme widget](#), you can access it from here.
28+
Theme Widgets enable you to customize the visual appearance of individual widgets and reuse them consistently throughout your app. They are an integral part of the design system, allowing you to build widgets based on your theme. Once you [create a theme widget](#), you can access it from here.
2929

3030
## 5. Floating Widget Palette
3131

32-
The floating widget palette gives you quick access to widgets directly from the canvas. This feature is useful for swiftly adding widgets without the need to open the widget palette via the navigation menu.
32+
The Floating Widget Palette gives you quick access to widgets directly from the canvas. This feature is useful for swiftly adding widgets without the need to open the widget palette via the navigation menu.
33+
34+
![Floating Widget Palette](imgs/floating-widget-palette.gif)

0 commit comments

Comments
 (0)