Skip to content

Commit 5adaafb

Browse files
authored
Merge pull request #319 from FlutterFlow/feature/custom-code-description
Added Description Field Info for Custom Functions and Actions
2 parents fdf8eb0 + 412b803 commit 5adaafb

File tree

4 files changed

+16
-0
lines changed

4 files changed

+16
-0
lines changed

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,22 @@ Here's an example of an Action that returns a _nullable_ integer.
243243

244244
![return-value-actions.png](imgs/return-value-actions.png)
245245

246+
## Description
247+
248+
You can add a [**Description**](../../intro/ff-ui/resource-hierarchy.md#resource-description) note on Custom Functions and Custom Actions to briefly explain their purpose, usage, or important details. This helps clarify what the function or action is intended for, making your project more understandable and maintainable—especially in libraries and collaborative environments.
249+
250+
![adding-description-on-custom-function-action.avif](imgs/adding-description-on-custom-function-action.avif)
251+
252+
You can view these descriptions as tooltips by hovering over the green note icon when selecting a Custom Function or Custom Action.
253+
254+
![view-description-custom-function-and-custom-action](imgs/view-description-custom-function-and-custom-action.avif)
255+
256+
:::tip
257+
In the generated code, descriptions are added as comments before the function definition, and they also appear in the custom code editor.
258+
259+
![description-in-custom-code](imgs/description-in-custom-code.avif)
260+
:::
261+
246262
## Adding a Pubspec Dependency
247263
To utilize community-built Flutter solutions in your FlutterFlow projects, you can add a "pubspec dependency". The **pubspec file** is the configuration file in Flutter projects that lists external packages or libraries, along with other project configurations.
248264

Binary file not shown.

0 commit comments

Comments
 (0)