Code File (Custom Classes) Docs #363

pinkeshmars · 2025-05-26T08:44:16Z

Description

Code File (Custom Classes) Docs

Linear ticket and magic word Fixes DEVR-914

Type of change

bolt-new-by-stackblitz · 2025-05-26T08:44:19Z

Run & review this pull request in StackBlitz Codeflow.

PoojaB26

Requested some fixes, but overall LGTM!

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

PoojaB26 · 2025-05-26T19:08:25Z

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

+
+## Create Class Instance
+
+You need to create an instance of a class so you can work with actual data and use the class’s properties and methods in your app. Here’s a simple explanation:


Mention how it is similar to datatype instance and point to that doc?

Did you mean point to here or here?

I guess we don't have any docs in custom data type about creating a datatype instance?

yes, we don't have it yet.

can you create a linear ticket for the same and reference this PR comment?

Created - https://linear.app/flutterflow/issue/DEVR-945/add-docs-in-custom-data-type-about-creating-a-datatype-instance

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

PoojaB26 · 2025-05-26T19:12:34Z

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

+- An **instance** (or “object”) is a real, usable item made from that blueprint. See the code snippet below:
+
+    ```jsx
+    Review review1 = Review(


THis may be incomplete if we don't show the code for the Review class first. I know its added to the Arcade but its not enough since the rest of the explanations is so tied to the Review class, but we dont show the class definition in code here. I'd suggest add the Review class snippet after the Create Custom Class Arcade

Agree! added.

PoojaB26 · 2025-05-26T19:13:14Z

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

+
+- Store actual review details.
+- Access and update the fields (e.g., `review1.rating` or `review1.comment`).
+- Call methods that do something with that data (e.g., `review1.markHelpful()` or `review1.shortComment()`).


another point where these methods are confusing because we dont have the code for Review class somewhere here where we can reference it.

Ya, now worries. added the code snippet for the Review class.

PoojaB26 · 2025-05-26T19:17:44Z

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

+</div>
+<p></p>
+
+:::tip[When You Don't Need an Instance]


I wouldnt call it a tip rather its a feature. Im afraid this entire section with the description (for e.g "skip instance creation" language) can make non coders feel like this is the easiest approach so lets go with it, and they will have static methods everywhere and more bugs because the logic will not work the way a non static class is expected to work.

We should treat it as its own section and talk about when its useful with more examples

Hmm, in that case, let's remove (comment out) this part and revisit with more detail!

because it will take more time to rewrite this part?

i see a bunch of new actions under custom class, see here: https://linear.app/flutterflow/issue/SUP-2529/custom-class-method-is-not-appearing-in-actions-list#comment-34cd1a72
also some related to static fields. I think it should be covered in the v1 version of the docs (as a separate section)?

When you say this 'should be covered in the v1 version of the docs' you mean in this PR only right? yes, we can do it. Could you please help with that ticket? it is is not opening for me.

Yes in this PR, can you check the linear ticket again?

Done! Added a new 'Using Static Classes' section.

PoojaB26 · 2025-05-26T19:25:22Z

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

+
+![access-fields-methods.avif](imgs/access-fields-methods.avif)
+
+### Call In Action Flows


i think this is more important to show with an Arcade. and if I remember correctly this is not the name of the action. we must have the action name the way we do it for other features.

Yes, you're right. However, there's currently an issue where custom class methods aren't showing up in the actions list, so I’m unable to see any details or record the arcade.

PoojaB26 · 2025-05-26T19:25:33Z

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

+
+You can also add your custom class’s methods directly within an Action Flow. For example, you can trigger the `markHelpful()` method when a user taps a “Mark as Helpful” button to update a field or increment the helpful count of a review.
+
+## Enums


definitely the name shouldnt be just Enums, same reason as Data Types comment. Custom Enums?

Changed the name to "Custom Enums" but kept the heading as ## only to avoid nesting it under "Using Custom Classes." Since enums are different from classes, I think they deserve their section.

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

Co-authored-by: Pooja Bhaumik <[email protected]>

…ow/flutterflow-documentation into feature/custom-classes

pinkeshmars · 2025-05-27T09:35:05Z

Hi @PoojaB26, Most of the review comments are addressed. For some, I left the reply. You can take a look.

pinkeshmars · 2025-05-30T06:56:47Z

Hi @PoojaB26 all review comments are addressed now!

PoojaB26 · 2025-05-30T07:01:40Z

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

@@ -194,7 +194,67 @@ You can use custom class fields to display values directly in the UI, and call i

 ### Call In Action Flows


I dont think we need this, lets just have all actions in h3 and remove this.

…ow/flutterflow-documentation into feature/custom-classes

PoojaB26

Some examples & explanations need fixing

PoojaB26 · 2025-05-30T08:23:28Z

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

+
+### Set Field [Action]
+
+Use the **Set Field** action to update a specific property of a custom class instance. For example, you can set `order.status = 'shipped'` when a user confirms an order, allowing the UI to reflect the change immediately.


The example is different from the text here. May be confusing to users.

not matching the Review class above

PoojaB26 · 2025-05-30T08:27:24Z

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

+
+## Using Static Classes
+
+Sometimes, you just want to run a small piece of logic like formatting text or doing a calculation, without needing to set up anything extra. That’s when `static` data members are helpful. You can access static fields and methods without creating an instance of a class. You can think of them like tools that are always ready to use.


This is incorrect actually. We don't use static classes because its minor logic, but rather when there is "shared logic across app" where calculator / utility functions fit that definition.

Suggested change

Sometimes, you just want to run a small piece of logic like formatting text or doing a calculation, without needing to set up anything extra. That’s when `static` data members are helpful. You can access static fields and methods without creating an instance of a class. You can think of them like tools that are always ready to use.

Sometimes, you just want to run a small piece of logic like formatting text or doing a calculation, without needing to set up anything extra. That’s when `static` data members are helpful. You can access static fields and methods without creating an instance of a class. Because they're tied to the class rather than an instance, static members are accessible globally.

ok, updated it.

PoojaB26 · 2025-05-30T08:31:34Z

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

+- This `StringFormatter` class below provides reusable static methods to capitalize text, convert it to lowercase, or format it in snake_case.
+
+  ```jsx
+  class StringFormatter {


indentation is off on this one

PoojaB26 · 2025-05-30T08:35:58Z

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

+</div>
+<p></p>
+
+## Using Static Classes


I'm confused on this one. technically Dart doesnt allow a "static class" per se. What people often do instead is create a class that contains only static members or mix static and instance members in the same class. So the title might be a bit misleading in this context? Maybe just call it Using Static Members or just Static Members if you agree?

ok updated to 'Using Static Members'

PoojaB26 · 2025-05-30T08:36:33Z

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

+
+:::warning
+
+Static classes are powerful, but they should be used carefully. Overusing static methods can lead to less flexible code and potential issues, especially when the logic requires access to state or needs to evolve over time. Stick to static methods only when the logic is truly independent and doesn’t rely on instance-specific data.


can fix the first line based on the feedback about "static classes"

also mention somewhere that static and instance fields can be mixed in a class as well?

Addressed both of comments!

PoojaB26 · 2025-05-30T08:39:19Z

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

+</div>
+<p></p>
+
+### Call Static Method [Action]


The example in the text not matching the example in the Arcade. You can add multiple examples, but the main one should reflect the Arcade

pinkeshmars · 2025-05-30T10:42:30Z

@PoojaB26 you can take a look again.

Code File Docs

a838d13

pinkeshmars requested review from PoojaB26 and wenkaifan0720 May 26, 2025 08:44

Link from custom code section

30c9540

PoojaB26 requested changes May 26, 2025

View reviewed changes

pinkeshmars and others added 4 commits May 27, 2025 13:19

Apply suggestions from code review

1536c98

Co-authored-by: Pooja Bhaumik <[email protected]>

Address review comment

6520f26

Merge branch 'feature/custom-classes' of https://github.com/FlutterFl…

d106a3e

…ow/flutterflow-documentation into feature/custom-classes

Address review comment

02fbbbb

pinkeshmars and others added 3 commits May 28, 2025 12:47

Add static class info

d161407

Address review comments

af033f0

Merge branch 'main' into feature/custom-classes

49c9d8e

PoojaB26 reviewed May 30, 2025

View reviewed changes

pinkeshmars added 2 commits May 30, 2025 12:51

Actions into H3

82a68fa

Merge branch 'feature/custom-classes' of https://github.com/FlutterFl…

d056348

…ow/flutterflow-documentation into feature/custom-classes

pinkeshmars requested a review from PoojaB26 May 30, 2025 08:18

PoojaB26 requested changes May 30, 2025

View reviewed changes

Review comments addressed!

8340dd8

PoojaB26 approved these changes May 30, 2025

View reviewed changes

PoojaB26 merged commit 4164e3c into main May 30, 2025
1 check passed

PoojaB26 deleted the feature/custom-classes branch May 30, 2025 12:07


		## Create Class Instance

		You need to create an instance of a class so you can work with actual data and use the class’s properties and methods in your app. Here’s a simple explanation:


		![access-fields-methods.avif](imgs/access-fields-methods.avif)

		### Call In Action Flows


		You can also add your custom class’s methods directly within an Action Flow. For example, you can trigger the `markHelpful()` method when a user taps a “Mark as Helpful” button to update a field or increment the helpful count of a review.

		## Enums

		@@ -194,7 +194,67 @@ You can use custom class fields to display values directly in the UI, and call i

		### Call In Action Flows


		### Set Field [Action]

		Use the Set Field action to update a specific property of a custom class instance. For example, you can set `order.status = 'shipped'` when a user confirms an order, allowing the UI to reflect the change immediately.


		## Using Static Classes

		Sometimes, you just want to run a small piece of logic like formatting text or doing a calculation, without needing to set up anything extra. That’s when `static` data members are helpful. You can access static fields and methods without creating an instance of a class. You can think of them like tools that are always ready to use.


		:::warning

		Static classes are powerful, but they should be used carefully. Overusing static methods can lead to less flexible code and potential issues, especially when the logic requires access to state or needs to evolve over time. Stick to static methods only when the logic is truly independent and doesn’t rely on instance-specific data.

Code File (Custom Classes) Docs #363

Code File (Custom Classes) Docs #363

Uh oh!

Conversation

pinkeshmars commented May 26, 2025

Description

Type of change

Uh oh!

bolt-new-by-stackblitz bot commented May 26, 2025

Uh oh!

PoojaB26 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pinkeshmars commented May 27, 2025

Uh oh!

pinkeshmars commented May 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PoojaB26 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PoojaB26 May 30, 2025 •

edited

Loading