Skip to content

Commit d0a60dc

Browse files
committed
Added use cases and examples
1 parent f298a60 commit d0a60dc

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/resources/projects/refactor-project.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,20 @@ sidebar_position: 7
99

1010
# Refactor Project
1111

12-
**Refactor Project** is a developer‑focused mode that opens your FlutterFlow project as a set of YAML files so you can perform large-scale edits, such as renaming data types, pages, enums, or components, in a single, consistent operation.
12+
**Refactor Project** is a developer‑focused mode that opens your FlutterFlow project as a set of YAML files so you can perform large-scale edits in a single, consistent operation.
1313

1414
For example, if you want to use a custom data type from a Library and update all references, you don’t have to manually edit each page or component. With this mode enabled, you can update all references at once using a single refactor pass.
1515

1616
It makes managing large projects easier and more reliable. You can make changes across hundreds of references in just seconds, saving time and effort compared to manual edits. It also lets you preview changes and dismiss anything you don’t want to update.
1717

18+
:::tip[possible use cases]
19+
- **Type Refactoring**: Rename a custom data type (e.g., `OrderDetails``OrderInfo`) across all bindings, forms, and logic in a single pass.
20+
- **String Replacement**: Find and replace hardcoded (magic) strings like `"admin"`, `"true"`, or `"completed"` to improve clarity and maintainability.
21+
- **Library Migration**: Replace a project-based custom data type (e.g., `UserProfile`) with its Library counterpart throughout the app without manually editing each reference.
22+
- **Key Updates**: Update outdated keys—for example, replace all instances of `old_api_key` with the new `new_api_key` value.
23+
- **Cleanup Unused Items**: Locate and remove unused fields or stale references (e.g., `oldFieldName`) from your YAML files to keep your project clean.
24+
:::
25+
1826
:::info
1927

2028
You can refactor the project only if you're on a [**paid plan**](https://www.flutterflow.io/pricing).

0 commit comments

Comments
 (0)