Skip to content

Commit b6ff64c

Browse files
leighajarettpinkeshmarsPoojaB26
authored
Vscode ext (#155)
* Fixing account management page + adding API token info * Adding VSCode extension info * Made some changes on top leigha's * API keys link fix * Fixed broken links * Shuffle the topics, rename titles etc * small img ref fix * fix vs code reference link --------- Co-authored-by: Pinkesh <[email protected]> Co-authored-by: PoojaB26 <[email protected]>
1 parent 0b37d1f commit b6ff64c

File tree

22 files changed

+348
-106
lines changed

22 files changed

+348
-106
lines changed

docs/accounts-billing/account-management.md

Lines changed: 36 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,85 +9,77 @@ sidebar_position: 1
99
# Account Management
1010
This section contains information on changing your password, verifying your email, and deleting your account.
1111

12-
## Password
1312
### I can't log in to my account / I forgot my login info.
14-
1513
To reset your account password:
1614

17-
- From `flutterflow.io` select Login in the top right corner.
18-
19-
- At the bottom of the page, select Reset Password.
20-
21-
- You will receive an email with a link to reset your password.
22-
23-
- Click the reset link and enter your new password.
24-
25-
If you can’t remember your username or are experiencing any other issues, please reach out to us at [email protected]
26-
27-
15+
1. From `flutterflow.io` select Login in the top right corner.
16+
2. At the bottom of the page, select **Reset Password**.
17+
3. You will receive an email with a link to reset your password.
18+
4. Click the reset link and enter your new password.
2819

29-
30-
### How Do I Change My Password?
20+
If you can’t remember your username or are experiencing any other issues, please reach out to us at `[email protected]`
3121

3222

23+
### How do I change my password?
3324
To change your password, please use the following steps:
3425

35-
- Log in to your FlutterFlow account and select Account from the top right.
36-
37-
- Under Personal Info, select Reset Password.
26+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
27+
2. Under Personal Info, select Reset Password.
28+
3. You will receive an email with a link to reset your password.
29+
4. Click the reset link and enter your new password.
3830

39-
- You will receive an email with a link to reset your password.
4031

41-
- Click the reset link and enter your new password.
42-
43-
## Verify Account
44-
### How Do I Check If My Account Is Verified?
32+
### How do I check if my account is verified?
4533
To check if you have verified your account:
4634

47-
1. Log in to your FlutterFlow account and select Account from the top right.
48-
2. Navigate to the Profile Information section.
49-
3. If you have a green checkmark next to your email, your account is verified.
35+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
36+
2. If you have a green checkmark next to your email, your account is verified.
5037

51-
![img_1.png](imgs/img_1.png)
38+
![check-account-verification.png](imgs/check-account-verification.png)
5239

53-
### I Didn't Get The Email To Verify My Account / How Do I Resend The Verification Email?
40+
### I didn't get the email to verify my account, how do I resend the verification email?
5441
If you did not receive a verification email, please follow these steps:
5542

56-
1. Log in to your FlutterFlow account and select Account from the top right.
57-
2. Navigate to the Profile Information section and check that your email address is correct.
58-
3. If your email is incorrect, please reach out to [email protected] to correct this.
59-
4. From the Profile Information section, select Verify Email.
43+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
44+
2. Check that your email address is correct. If your email is incorrect, please reach out to `[email protected]` to correct this.
45+
3. From the **Profile Information** section, select **Verify Email**.
6046

6147
You should receive a new confirmation email. If you do not receive the verification email, please contact us at [email protected].
6248

63-
![img.png](imgs/img.png)
49+
![email-verification.png](imgs/email-verification.png)
6450

65-
## Delete Account
66-
### How Do I Delete My Account
51+
### How do I delete my account?
6752
To delete your FlutterFlow account, please follow these steps:
6853

69-
1. Log in to your FlutterFlow account and select Account from the top right.
70-
71-
2. Scroll down to the My Plan section and select Delete Account (bottom right corner)
54+
1. Log in to your FlutterFlow account and select **Account** from the top right.
55+
2. Scroll down to the **My Plan** section and select **Delete Account** (bottom right corner)
7256

7357
:::danger
7458
This step can not be undone. We will not be able to recover your projects.
7559
:::
7660

7761

78-
## Change/Update Email Address
79-
### Q: How do I change or update my login email address?
62+
### How do I change or update my email address?
8063
To change your login email in FlutterFlow:
8164

8265
1. Log into your FlutterFlow account.
8366
2. Go to the dashboard and select your account tile (showing your name and email).
84-
3. Click on Update Email.
67+
3. Click on **Update Email**.
8568
4. Enter your current email and password.
86-
5. Input your new email and click Confirm & Log Out.
69+
5. Input your new email and click **Confirm & Log Out**.
8770
6. Verify the new email via the link sent to it.
88-
7. Now, you need to create a new password for your new email address. To do so, click on the Forgot Password on the login page and enter your new email address.
71+
7. Now, you need to create a new password for your new email address. To do so, click on the **Forgot Password** on the login page and enter your new email address.
8972
8. You'll receive the password reset link at your new email address. Click the link and reset the password.
9073

9174
Now, you are ready to log in with your new email address and password.
9275

93-
![img_2.png](imgs/img_2.png)
76+
![update-email.png](imgs/update-email.png)
77+
78+
### How do I generate an API Token?
79+
An API token is required to use the [CLI](../testing-deployment-publishing/exporting-code/ff-cli.md) and the [Visual Studio Code Extension](../ff-concepts/adding-customization/vscode-extension.md)
80+
.
81+
82+
To create an API token tied to your account:
83+
84+
1. Navigate to your [account page in FlutterFlow](https://app.flutterflow.io/account).
85+
2. Near the bottom of the page, click **Create Token**

docs/ff-concepts/adding-customization/custom-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /concepts/custom-code/custom-actions
33
title: Custom Actions
44
description: Learn how to create and use custom actions in your FlutterFlow app to enhance functionality.
55
tags: [Custom Actions, Custom Code]
6-
sidebar_position: 3
6+
sidebar_position: 4
77
keywords: [FlutterFlow, Custom Actions, Customizations, Flutter, Dart, Pub.dev]
88
---
99

docs/ff-concepts/adding-customization/custom-code.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,15 @@ toc_max_heading_level: 4
1111
# Custom Code
1212

1313
While FlutterFlow provides a wide range of pre-built components and functionalities, there may be
14-
times when you need to extend your app with custom logic or features that are not readily available.
15-
This
16-
is where writing custom code comes into play. We provide the following features to accommodate
17-
these needs:
18-
19-
* **[Custom Functions](custom-functions.md):** Write custom Dart functions to perform specific tasks or
20-
calculations.
21-
* **[Custom Actions](custom-actions.md):** Implement custom actions that can be triggered by user
22-
interactions or
23-
other action triggers.
24-
* **[Custom Widgets](custom-widgets.md):** Create custom Flutter widgets to achieve unique UI designs or
25-
behaviors.
26-
* **[Custom Files:](custom-files.md)** Ability to edit some parts of the `main.dart` file.
14+
times when you need to extend your app with custom logic or UI components that are not available out of the box.
15+
This is where writing custom code comes into play.
16+
17+
There are a few different ways to make custom code accessible in FlutterFLow:
18+
19+
* **[Custom Functions](custom-functions.md):** Custom Dart functions that can be used to set Widget or Action properties.
20+
* **[Custom Actions](custom-actions.md):** Custom Dart functions that can be triggered by [Action Triggers](https://docs.flutterflow.io/resources/functions/action-triggers/) or used as nodes in an [Action Flow](https://docs.flutterflow.io/resources/functions/action-flow-editor#action-flow-editor). These are usually `async` functions and are able to import custom package dependencies.
21+
* **[Custom Widgets](custom-widgets.md):** Custom Flutter widgets, which can be used in the same way [Components](https://docs.flutterflow.io/resources/ui/components) are used throughout your project.
22+
2723

2824
:::tip[Why Write Custom Code?]
2925

@@ -35,14 +31,29 @@ these needs:
3531
interactions.
3632
:::
3733

38-
## Common Properties
34+
# Writing Custom Code
35+
There are two main ways to write custom code in FlutterFlow:
36+
37+
1. Using the [**In-App Code Editor**](#using-the-in-app-code-editor)
38+
2. Using the [**Visual Studio Code Extension**](vscode-extension.md)
3939

40-
There are several properties and settings that are common to each type of custom code in
41-
FlutterFlow. Most of these common properties are highlighted in the diagram below. For more
42-
information about some of these properties, see the details provided below.
40+
41+
### Using the In-App Code Editor
42+
You can use the In-App Code Editor to view and edit custom code directly in the FlutterFlow application.
4343

4444
![custom-code-common.png](imgs/custom-code-common.png)
4545

46+
:::warning[Using the In-App Code Editor on Desktop]
47+
Note that the desktop version of the In-App Code Editor is limited. We recommend using the Web editor
48+
or the **[VSCode Extension](vscode-extension.md)**.
49+
:::
50+
51+
52+
Beyond the custom code resoureces outlined above, you'll also see an additional section in the left
53+
hand sidebar of the Custom Code page - [Custom Files:](custom-files.md).
54+
55+
Within Custom Files you'll have the ability to edit some parts of the `main.dart` file.
56+
4657
### Code Copilot
4758

4859
Code Copilot is an AI-assisted feature that helps you generate code snippets,
@@ -85,35 +96,43 @@ knowledge, making it especially useful for custom functions and actions.
8596
### Compile Code
8697

8798
When you are done adding your code snippets, you can compile it to ensure there are no
88-
compilation errors. To do so, click the **Compile Code** button.
99+
compilation errors and that your code can be transformed into something that can execute when your app is running.
89100

101+
To do so, click the **Compile Code** button.
90102

91103
<figure>
92104
![compile-errors.png](imgs/compile-errors.png)
93105
<figcaption class="centered-caption">How to recognize compile time errors</figcaption>
94106
</figure>
95107

108+
To run your app, you must make sure **Custom Functions** are compiled.
109+
110+
Custom Widgets and Actions don't need to be compiled to export code or test your app. However, you won't be able to preview Custom Widgets in the builder until they are compiled. You'll see a project warning if you don't compile Custom Widgets or Actions.
111+
112+
Compiling Custom Functions should be pretty fast, but sometimes, compiling Custom Actions and Widgets takes a while.
113+
96114
### Code Analyzer
97115

98116
The code analyzer is available in all your custom code snippets and ensures the quality and
99117
correctness of your custom code. It automatically checks your Dart code for errors and warnings,
100118
providing real-time feedback as you write.
101119
![code-analyzer.png](imgs/code-analyzer.png)
120+
102121
When there is a compilation error, the code analyzer will stop running and display the errors caught
103122
by the compiler. Once fixed, save the code and rerun using the Compile Code button. The code analyzer
104123
should then be reconnected. You can also manually reconnect it if needed.
105124

106125
### Custom Code Automatic Imports
107126

108-
When creating a new custom code snippet (actions, widgets, or functions) in FlutterFlow, some fundamental imports will be automatically added for you. These imports cannot be modified by the developer. Custom Functions do not allow adding any custom imports, but you can add custom imports in Custom Actions and Widgets after the line **"Do not remove or modify the code above"**.
127+
When creating a new custom code snippet (Actions, Widgets, or Functions) in FlutterFlow, some fundamental imports will be automatically added for you. These imports cannot be modified by the developer. Custom Functions do not allow adding any custom imports, but you can add custom imports in Custom Actions and Widgets after the line **"Do not remove or modify the code above"**.
109128

110129
![automatic-imports.png](imgs/automatic-imports.png)
111130

112131
### Custom Code Settings
113132

114133
When you edit a custom code snippet in FlutterFlow, the Settings block will open on the right. This
115-
block may vary slightly depending on the type of custom code (actions, functions, widgets), but here
116-
we will discuss the common settings.
134+
block may vary slightly depending on the type of custom code (Actions, Functions, Widgets), but here
135+
we'll discuss the common settings.
117136

118137
#### Exclude From Compilation
119138

@@ -261,7 +280,7 @@ one.
261280

262281
![Dependency-score.png](imgs/Dependency-score.png)
263282

264-
When adding a pubspec dependency to your custom code in FlutterFlow, you’ll need two pieces of information: the [package name with its version number](#copy-package-name--version-) and the [import statement](#copying-import-statement).
283+
When adding a pubspec dependency to your custom code in FlutterFlow, you’ll need two pieces of information: the [package name with its version number](#copy-package-name--version) and the [import statement](#copying-import-statement).
265284

266285
#### Copy Package Name & Version
267286

docs/ff-concepts/adding-customization/custom-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /concepts/custom-code/custom-functions
33
title: Custom Functions
44
description: Learn how to create and use custom functions in your FlutterFlow app to add custom functionalities.
55
tags: [Custom Functions, Custom Code]
6-
sidebar_position: 2
6+
sidebar_position: 3
77
keywords: [FlutterFlow, Custom Functions, Customizations, Flutter, Dart, Pub.dev]
88
---
99

docs/ff-concepts/adding-customization/custom-widgets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: /concepts/custom-code/custom-widgets
33
title: Custom Widgets
44
description: Learn how to create and use custom widgets in your FlutterFlow app to enhance its user interface.
55
tags: [Custom Widgets, Custom Code]
6-
sidebar_position: 4
6+
sidebar_position: 5
77
keywords: [FlutterFlow, Custom Widgets, Customizations, Flutter, Dart, Pub.dev]
88
---
99

127 KB
Loading
49.6 KB
Loading

0 commit comments

Comments
 (0)