Skip to content

User Defined Components Section #29

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 8 commits into from
Jun 6, 2024
Merged

User Defined Components Section #29

merged 8 commits into from
Jun 6, 2024

Conversation

PoojaB26
Copy link
Collaborator

Description

Provide a brief overview of what this documentation update is about. Explain what sections or topics are being added or revised.

Linear ticket and magic word Fixes DEVR-331

Type of change

  • Typo fix
  • New feature
  • Removed outdated references

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot requested a review from pinkeshmars May 21, 2024 05:34
Copy link
Collaborator

@pinkeshmars pinkeshmars left a comment

Choose a reason for hiding this comment

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

Hey @PoojaB26 This looks great in overall. However, I have added some review comments. Mostly they are related to polishing docs.

We could also add this and this (not in detail but just a brief is fine) Also the youtube video and FAQs.

# Components

Components in FlutterFlow are reusable elements you design once and utilize throughout your app
to save time, ensure consistency, and simplify maintenance.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can have a pause somewhere in between (e.g., Components in FlutterFlow are reusable elements. You design once and use them throughout your app to save time, ensure consistency, and simplify maintenance.)

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

importance of reducing repetition within code and design.
:::

Leveraging components effectively helps you build a consistent, efficient, and maintainable app.
Copy link
Collaborator

Choose a reason for hiding this comment

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

'helps' to 'help'

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Why? :/ That would be grammatically incorrect then

out-of-the-box solutions provided by FlutterFlow that can be directly integrated into any project
to offer specific functionalities.

- **User-Defined Components:** Users can also build their own components by assembling multiple
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we change 'Users' to 'You' to make it more direct? (e.g., You can build your own components by assembling multiple widgets using FlutterFlow’s drag-and-drop interface.)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yep, done

Components can be used in various scenarios to accelerate your app development process. Here are
some common use-cases.

1. Design a **standard button once** and reuse it across multiple screens to maintain a cohesive
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can make this unordered list since the use cases are not in specific order.


## Types of Components in FlutterFlow

- **Built-in Widgets:** FlutterFlow includes a variety of built-in pre-defined widgets that
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can:
2. Link 'Built-in Widgets:' to its specific page.
3. Change 'Built-in Widgets' to 'Built-in Components' same as title for its dedicated page.

:::note
You can set the **Data Type** of your Component State variable to any primitive data types such as *
*String,
Integer, Boolean, Double** or to any other complex built-in data types such as **Enum, Custom Data
Copy link
Collaborator

Choose a reason for hiding this comment

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

String, Integer, Boolean, Double shows as it is on a page.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah some issue with formatting pages, it just brings them to next line and then the ** ** is not applied properly.


Follow the steps as below:

<div style={{
Copy link
Collaborator

Choose a reason for hiding this comment

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

This arcade seems to be broken :(

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed it!

component state, call an action called **Update Component State** from the Action Flow Editor
of the component.

In the following demo, we open the Action Flow Editor on the parent widget` Conditional Builder` and
Copy link
Collaborator

Choose a reason for hiding this comment

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

Extra space in code block. should be 'Conditional Builder'

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


#### Rebuild on Update

When updating your component state in Flutter, you'll often come across the **Update
Copy link
Collaborator

Choose a reason for hiding this comment

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

'Flutter' to 'FlutterFlow'

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great catch, thanks!

and use rebuilds judiciously to maintain optimal app performance.

To learn more about what happens behind the scenes, refer to
the [Generated Page] section.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Generated Page in bold and add a link placeholder(#) so later we can target empty links easily.

@PoojaB26
Copy link
Collaborator Author

PoojaB26 commented Jun 1, 2024

@pinkeshmars Addressed all the comments!

Copy link
Collaborator

@pinkeshmars pinkeshmars left a comment

Choose a reason for hiding this comment

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

Thanks @PoojaB26 for addressing comments! LGTM.

@PoojaB26 PoojaB26 merged commit 3949c1f into main Jun 6, 2024
@PoojaB26 PoojaB26 deleted the pooja/components branch June 6, 2024 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants