Skip to content

Commit 9c8a79a

Browse files
committed
minor fixes
1 parent 2f77ba7 commit 9c8a79a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/ff-concepts/adding-customization/configuration-files.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Here are the key configuration files you can edit:
1717

1818
- [**`AndroidManifest.xml`**](#androidmanifestxml-android) – Configures app permissions, metadata, and intent filters for Android.
1919
- [**`Info.plist`**](#infoplist-ios)– Manages iOS app settings, including permissions and configurations.
20-
- [**`Entitlements.plist`**](#entitlementsplist-ios) – Defines iOS app privileges such as, push notifications and Apple Pay.
20+
- [**`Entitlements.plist`**](#entitlementsplist-ios) – Defines iOS app privileges such as push notifications and Apple Pay.
2121
- [**`main.dart`**](#maindart-flutter) – The entry point of your Flutter app, where you can modify app-level logic.
2222
- [**ProGuard files**](#proguard-file-android) – Used for code shrinking and obfuscation in Android builds.
2323

@@ -35,7 +35,7 @@ FlutterFlow provides two main ways to modify native XML files: [**Add Individual
3535

3636
### Option 1: Add Individual Snippets
3737

38-
**Snippets** are small pieces of code that you can inject into the native files at predefined locations. Instead of opening the whole file to edit, you provide just the fragment you want to add, and FlutterFlow merges it into the file in the correct place. This is safer and easier for small additions such as, a permission line or a meta-data tag.
38+
**Snippets** are small pieces of code that you can inject into the native files at predefined locations. Instead of opening the whole file to edit, you provide just the fragment you want to add, and FlutterFlow merges it into the file in the correct place. This is safer and easier for small additions such as a permission line or a meta-data tag.
3939

4040
#### Snippet Placement for Android
4141

@@ -148,13 +148,13 @@ Once unlocked, the file stays in manual editing mode until you lock it again. Re
148148
:::tip
149149

150150
- Don’t remove FlutterFlow’s existing entries unless you are sure. It’s safer to only add or modify necessary lines and leave the rest as is.
151-
- Use Manual Edit Mode for bulk or complex edits that the snippet can’t easily do, such as, reordering tags, removing something, or pasting in a large chunk of config. Always verify that the app still builds and runs after such edits.
151+
- Use Manual Edit Mode for bulk or complex edits that the snippet can’t easily do, such as reordering tags, removing something, or pasting in a large chunk of config. Always verify that the app still builds and runs after such edits.
152152
- You can also use your Development [**Environment Values**](../../testing-deployment-publishing/development-environments/development-environments.md#environment-values) and [**Library Values**](../../resources/projects/libraries.md#library-values) inside snippets. For more details, refer to the [**Include Variables in Native Code**](#include-variables-in-native-code) section.
153153
:::
154154

155155
## Include Variables in Native Code
156156

157-
When editing native files in FlutterFlow, you may need to include dynamic values, such as, API keys, app configurations, or environment-specific settings. Instead of hardcoding these values directly in **`AndroidManifest.xml`**, **`Info.plist`**, or other native files, you can use FlutterFlow [**Environment Values**](../../testing-deployment-publishing/development-environments/development-environments.md#environment-values) and [**Library Values**](../../resources/projects/libraries.md#library-values) to keep your app flexible and secure.
157+
When editing native files in FlutterFlow, you may need to include dynamic values, such as API keys, app configurations, or environment-specific settings. Instead of hardcoding these values directly in **`AndroidManifest.xml`**, **`Info.plist`**, or other native files, you can use FlutterFlow [**Environment Values**](../../testing-deployment-publishing/development-environments/development-environments.md#environment-values) and [**Library Values**](../../resources/projects/libraries.md#library-values) to keep your app flexible and secure.
158158

159159
To include a variable in a configuration file, start by creating a **file-level variable** and assigning it a value from either your **environment values** or **library values**. Then, reference this variable using a placeholder format (e.g., `{{apiToken}}`) within the configuration file. These placeholders in native files are automatically replaced with their actual values during the app build process.
160160

@@ -272,7 +272,7 @@ FlutterFlow allows editing several key native files. Below, we cover each file
272272

273273
`AndroidManifest.xml` is the master configuration file for your Android app. It is located in the root directory of the app's `android/app/src/main` folder and declares essential app information to the Android OS and Google Play. This includes your app’s package name, components (activities, services, receivers), and the permissions it needs.
274274

275-
It defines hardware and software features the app depends on, such as, Bluetooth, GPS, or sensors. The manifest manages intents and filters, determining how the app responds to system events and deep linking. It also includes metadata and configuration for SDKs and libraries, such as API keys or feature flags.
275+
It defines hardware and software features the app depends on, such as Bluetooth, GPS, or sensors. The manifest manages intents and filters, determining how the app responds to system events and deep linking. It also includes metadata and configuration for SDKs and libraries, such as API keys or feature flags.
276276

277277
In short, the manifest is like an app’s identity card and permission sheet for Android.
278278

@@ -302,7 +302,7 @@ This registers `NewScreenActivity` so the system knows it exists.
302302

303303
**Example 2: Requesting Permissions**
304304

305-
If your app requires access to restricted resources such as, wake locks (to keep the device awake) or audio recording, you must declare the necessary permissions in `AndroidManifest.xml` by [manually editing](#option-2-manual-edit-mode) the file. **Tip:** You can also add custom permissions directly through the [**Permission Settings**](../../resources/projects/settings/project-setup.md#adding-custom-permission) in FlutterFlow.
305+
If your app requires access to restricted resources such as wake locks (to keep the device awake) or audio recording, you must declare the necessary permissions in `AndroidManifest.xml` by [manually editing](#option-2-manual-edit-mode) the file. **Tip:** You can also add custom permissions directly through the [**Permission Settings**](../../resources/projects/settings/project-setup.md#adding-custom-permission) in FlutterFlow.
306306

307307
```xml
308308
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
@@ -399,7 +399,7 @@ You can modify the `AndroidManifest.xml` file by either [**adding a snippet**](#
399399

400400
`Info.plist` (Information Property List) is the configuration file for iOS apps. It’s a structured XML file that provides iOS with essential information about your app’s configuration and requirements.
401401

402-
The `Info.plist`defines things such as, your app’s bundle identifier, display name, version, and most importantly, usage descriptions for permissions and other settings iOS needs at runtime. The file is required for every iOS app and is located in the project’s `/ios/Runner/` directory of your FlutterFlow apps.
402+
The `Info.plist`defines things such as your app’s bundle identifier, display name, version, and most importantly, usage descriptions for permissions and other settings iOS needs at runtime. The file is required for every iOS app and is located in the project’s `/ios/Runner/` directory of your FlutterFlow apps.
403403

404404
Essentially, it’s the blueprint for iOS to understand your app’s capabilities and needs.
405405

@@ -467,15 +467,15 @@ You can modify the `Info.plist` file by either [**adding a snippet**](#snippet-p
467467

468468
### `Entitlements.plist` (iOS)
469469

470-
The `Entitlements.plist` file is a property list in iOS applications that defines the app’s security-related capabilities and permissions. It grants specific privileges to an app, allowing it to access Apple services such as, iCloud, Push Notifications, App Groups, Background Modes, and Keychain access. It is located in the **`/ios/Runner/`** directory of your FlutterFlow app and is named **`Runner.entitlements`**.
470+
The `Entitlements.plist` file is a property list in iOS applications that defines the app’s security-related capabilities and permissions. It grants specific privileges to an app, allowing it to access Apple services such as iCloud, Push Notifications, App Groups, Background Modes, and Keychain access. It is located in the **`/ios/Runner/`** directory of your FlutterFlow app and is named **`Runner.entitlements`**.
471471

472472
This file ensures that only authorized apps can use these features, maintaining security and preventing unauthorized access to sensitive system functions.
473473

474474
Here are some scenarios where you may need to modify the `Entitlements.plist` file:
475475

476476
**Example 1: Enabling iCloud Storage**
477477

478-
If your app integrates **iCloud services**, such as, syncing user data or storing documents, you must add iCloud entitlements.
478+
If your app integrates **iCloud services**, such as syncing user data or storing documents, you must add iCloud entitlements.
479479

480480
```xml
481481
<key>com.apple.developer.icloud-container-identifiers</key>
@@ -538,7 +538,7 @@ You can modify the `Entitlements.plist` file by either [**adding a snippet**](#s
538538

539539
The `main.dart` file is the entry point of every FlutterFlow app. It is the first file that runs when the app starts and is responsible for initializing the application, configuring dependencies, and defining the root widget. Located in the **`lib/`** directory, `main.dart` contains the `main()` function, which is required for every FlutterFlow app.
540540

541-
If you need to execute any custom Dart code at startup — such as, initializing third-party SDKs, setting global configurations, service locators, printing a debug log, or running certain functions once — `main.dart` is the place to do it.
541+
If you need to execute any custom Dart code at startup — such as initializing third-party SDKs, setting global configurations, service locators, printing a debug log, or running certain functions once — `main.dart` is the place to do it.
542542

543543
:::info
544544
[**Adding Snippets**](#option-1-add-individual-snippets) isn't available for `main.dart`. Instead, you can directly modify the file using [**Manual Edit Mode**](#option-2-manual-edit-mode).

0 commit comments

Comments
 (0)