Skip to content

Added Description Field Info for Custom Functions and Actions #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 22, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/ff-concepts/adding-customization/custom-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,20 @@ Here's an example of an Action that returns a _nullable_ integer.

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

## Description

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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--also gets added to the function code documentation (reflects in code editor too)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!


![adding-description-on-custom-function-action.avif](imgs/adding-description-on-custom-function-action.avif)

You can view these descriptions as tooltips by hovering over the green note icon when selecting a Custom Function or Custom Action.

![view-description-custom-function-and-custom-action](imgs/view-description-custom-function-and-custom-action.avif)

:::tip
In the generated code, descriptions are added as comments above the custom code. In code editors, they appear as tooltips when you hover over the names of Custom Functions and Actions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In code editors, they appear as tooltips when you hover over the names of Custom Functions and Actions

Is this true though?
I mean its true in actions flow and properties editor, but not in custom code tab. which is what i mean by code editors. it only adds the description as a comment before the function definition.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! My bad—I thought you were referring to IDEs when you said "code editor" No worries though, I’ve updated the text and added an image to make it more clear. Thanks for looking into :)

:::

## Adding a Pubspec Dependency
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.

Expand Down
Binary file not shown.
Binary file not shown.