-
Notifications
You must be signed in to change notification settings - Fork 110
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
Changes from 2 commits
7bafed0
39b6298
cfdf3db
83c340f
412b803
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -243,6 +243,20 @@ Here's an example of an Action that returns a _nullable_ integer. | |
|
||
 | ||
|
||
## 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. | ||
|
||
 | ||
|
||
You can view these descriptions as tooltips by hovering over the green note icon when selecting a Custom Function or Custom Action. | ||
|
||
 | ||
|
||
:::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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Is this true though? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
||
|
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!