Skip to content

Update en-US.mdx #5

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

01000001x01001110x01010011x01001000

docs: enhance didChangeDependencies() & didUpdateWidget() explanations

  • Simplify definitions for beginners with concrete examples
  • Clarify where to place custom code (before/after super call) when overriding

docs: enhance didChangeDependencies() & didUpdateWidget() explanations

- Simplify definitions for beginners with concrete examples  
- Clarify where to place custom code (before/after `super` call) when overriding
@thisissandipp thisissandipp self-requested a review July 7, 2025 17:13
@@ -1,19 +1,99 @@
---
title: What are `StatefulWidget` Lifecycle methods. Explain briefly.
---

Copy link
Owner

Choose a reason for hiding this comment

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

Please add the title, it is required for the Dart script to run.


- **setState() method:** This method notifies the framework that the internal state of this object has changed. The provided callback must be synchronous which might impact the user interface in the subtree. The framework schedules a build() for this current State object.

- **deactivate() method:** The framework calls this method when the State is removed from the tree, temporarily or permanently.

- **dispose() method:** This method is called when the State is removed from the tree, permanently. After the dispose() method is called, the State object is considered unmounted. Subclasses should override this method to release any resources retained by this object.

# NOTE -
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the # syntax because they are typically reserved for README section headings. Use bold or underline, or blockquote instead in the answers.

- **Initialization methods**: `super` **first**, then your code
- **Teardown methods**: your code **first**, then `super`

## Initialization Methods
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the ## syntax because they are typically reserved for README section sub-headings. Use bold or underline, or blockquote instead in the answers.


# NOTE -
- When overriding Flutter lifecycle methods, it’s crucial to know **where** to place your own code relative to the `super.methodName()` call.
## The rule of thumb is:
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the ## syntax because they are typically reserved for README section sub-headings. Use bold or underline, or blockquote instead in the answers.


These methods prepare both Flutter’s internals and your own state. Always let Flutter finish its setup before you start:

### `initState()`
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the ### syntax because they are typically reserved for README question titles. Use bold or underline, or blockquote instead in the answers.

}
````

### `didChangeDependencies()`
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the ### syntax because they are typically reserved for README question titles. Use bold or underline, or blockquote instead in the answers.

}
```

### `didUpdateWidget()`
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the ### syntax because they are typically reserved for README question titles. Use bold or underline, or blockquote instead in the answers.


---

## Teardown Methods
Copy link
Owner

Choose a reason for hiding this comment

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

Don't use the ## syntax because they are typically reserved for README section sub-headings. Use bold or underline, or blockquote instead in the answers.


- **createState() method:** Whenever a StatefulWidget is created, the framework calls this method to create fresh State objects. This method must be overridden.

- **initState() method:** This method is the first method that is called while creating a StatefulWidget class. Here we allocate our resources, which means we can initialize our variable, data, and properties.

- **didChangeDependencies() method:** This method is called just after initState() method when a dependency of this State object changes. For example, if the previous build was referencing an InheritedWidget that changes, this method notifies the object to change. Generally, subclasses don't override didChangeDependencies() method because the framework calls build() methods after dependency change. But to do some expensive work, let's say some network calls, the method is preferred over doing everything on build() method itself.
- **didChangeDependencies() method:** Called immediately after `initState()` and again whenever an `InheritedWidget` that this `State` depends on changes (e.g., `MediaQuery`, `Theme`, or a localized resource). Ideal for context-dependent initialization or expensive work that shouldn’t run on every build.
```dart
Copy link
Owner

Choose a reason for hiding this comment

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

Please add a line break before the code block.


- **build() method:** Every time the widget is rebuilt, the build() method is used. This can happen after calling initState(), didChangeDependencies(), or didUpdateWidget(), or after changing the state with a call to setState().

- **didUpdateWidget() method:** This method is called whenever the widget configuration changes. This method exists for triggering side-effects when one of the parameters in the StatefulWidget changes. A typical example is implicitly animated widgets.
- **didUpdateWidget() method:** Called whenever the parent widget rebuilds and supplies a new instance of this widget with updated properties. Override it to compare oldWidget vs. widget and trigger side-effects when specific parameters change, without recreating the whole State.
```dart
Copy link
Owner

Choose a reason for hiding this comment

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

Please add a line break before the code block.

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