Skip to content

Commit ff18977

Browse files
committed
add dos donts images for style guide
1 parent 7327c54 commit ff18977

File tree

4 files changed

+6
-0
lines changed

4 files changed

+6
-0
lines changed
57.6 KB
Loading
58 KB
Loading
24.1 KB
Loading

docs/resources/style-guide.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Use **UpperCamelCase** for all widgets, components, pages, and screen names to m
3737

3838
Similarly, for pages and screens, include "Page" or "Screen" in the name to indicate their purpose. This approach aligns with Dart conventions for class names and ensures a well-organized project structure.
3939

40+
![comp-style-guide.png](imgs/comp-style-guide.png)
41+
4042
:::tip[Do's]
4143
- **Use UpperCamelCase for Names:** Always use **UpperCamelCase** for widgets, components, pages, and screens. Examples: `CustomButton`, `UserProfilePage`, `MainViewComponent`.
4244

@@ -68,6 +70,8 @@ Note that the style guidelines for Pages and Components also apply to **[Custom
6870

6971
When naming custom data types and enums, use **UpperCamelCase** for consistency and clarity. Ensure that names are descriptive, providing a clear representation of the entity or purpose.
7072

73+
![dt-style-guide.png](imgs/dt-style-guide.png)
74+
7175
:::tip[Do's]
7276

7377
- **Use UpperCamelCase for Custom Data Types:** Name your custom data types using **UpperCamelCase**. Ensure that names are clear, concise, and descriptive, reflecting the entity they represent. Good Examples: `UserModel`, `ProductDetails`, `OrderItem`.
@@ -123,6 +127,8 @@ This section defines naming conventions for custom functions, actions, and actio
123127

124128
Custom functions and custom actions created in the Custom Code tab of FlutterFlow should follow the **lowerCamelCase** naming convention. These typically reflect an action or behavior.
125129

130+
![func-style-guide.png](imgs/func-style-guide.png)
131+
126132
:::tip[Do's]
127133
- **Be descriptive and concise:** Use clear, meaningful names that describe the action or purpose of the function (e.g., `validateForm` instead of `doCheck`, or `fetchUserData` instead of `userData`).
128134
- **Use action-oriented names:** Start with verbs to indicate behavior (e.g., `submitForm`, `processPayment`).

0 commit comments

Comments
 (0)