Skip to content

Added On Dispose Info #228

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 4 commits into from
Dec 12, 2024
Merged

Added On Dispose Info #228

merged 4 commits into from
Dec 12, 2024

Conversation

pinkeshmars
Copy link
Collaborator

Description

Added On Dispose Info

Linear ticket and magic word Fixes DEVR-715

Type of change

  • Typo fix
  • New feature
  • Enhancement to current docs
  • Removed outdated references
  • Update assets

Copy link

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

@github-actions github-actions bot requested a review from PoojaB26 December 11, 2024 11:10
Copy link
Collaborator

@PoojaB26 PoojaB26 left a comment

Choose a reason for hiding this comment

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

Some of the examples dont work for FlutterFlow because if the creation of them is not allowed in FF, the disposal of them wont make sense to users. We must remember the distinction between Flutter and FlutterFlow in such examples so we dont confuse the users.

@@ -71,6 +71,13 @@ created.
Your component can also respond to certain keypress events. For more details on setting this up, see [this section on
keyboard shortcuts](/resources/ui/pages/page-lifecycle#on-shortcut-press-action-trigger).

### On Dispose [Action Trigger]
The **On Dispose** action trigger for components allows you to define actions that execute when the page containing the component is navigated away or removed from memory. This is particularly useful for performing cleanup tasks specific to the component, such as closing streams, canceling subscriptions, or releasing resources, ensuring efficient memory and resource management.
Copy link
Collaborator

Choose a reason for hiding this comment

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

closing streams, canceling subscriptions --> we cant create streams or subscriptions in FlutterFlow anyway (from actions I mean), so this wont make sense for our users. A better example would be with actions that are a start or stop action, like start periodic action that goes throughout the lifecycle of the component should be stopped in onDispose trigger.

@@ -150,6 +150,18 @@ For instance, if you have a shortcut assigned to the letter "C" and a user tries
To handle this, you can enable the option on the `TextField` widget to bypass keyboard shortcuts. However, it’s generally better to assign more unique combinations, like Cmd + C, which are less likely to conflict with normal typing in a text field.
:::

### On Dispose [Action Trigger]

The **On Dispose** action trigger allows you to define actions that execute when a page is navigated away from or removed from memory. It is particularly useful for performing cleanup tasks, such as closing long-lived connections, canceling subscriptions, or releasing resources, to prevent memory leaks and ensure efficient resource management.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same comment for this.


:::tip[Possible Use Cases]

- **Cleaning Up Resources:** Use this action trigger to cancel timers, close database connections, or unsubscribe from streams to prevent memory leaks and unnecessary processing.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Only first example makes sense. The rest are in relation to Flutter.

@pinkeshmars
Copy link
Collaborator Author

@PoojaB26 you can take a look again.

Copy link
Collaborator

@PoojaB26 PoojaB26 left a comment

Choose a reason for hiding this comment

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

Typo fix required. Thanks for working on these fixes!

@pinkeshmars pinkeshmars merged commit 02d0506 into main Dec 12, 2024
1 check passed
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