Skip to content

Commit 7bafed0

Browse files
committed
Added description field info for custom function and actions
1 parent 276bebe commit 7bafed0

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,16 @@ 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+
## Adding 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+
246256
## Adding a Pubspec Dependency
247257
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.
248258

0 commit comments

Comments
 (0)