Skip to content

Enhance SizeTransition docs - #19721

Merged
gspencergoog merged 4 commits into
flutter:masterfrom
gspencergoog:size_transition_docs
Jul 25, 2018
Merged

gspencergoog merged 4 commits into
flutter:masterfrom
gspencergoog:size_transition_docs

Conversation

@gspencergoog

@gspencergoog gspencergoog commented Jul 24, 2018 •

Copy link
Copy Markdown
Contributor

Updated documentation of SizeTransition, since I found it less than intuitive.

I added some constructor asserts to make the (existing) contract more clear.

@gspencergoog
gspencergoog force-pushed the size_transition_docs branch from 3231546 to 5d32e7b Compare July 24, 2018 19:20
///
/// For a widget that automatically animates between the sizes of two children,
/// fading between them, see [AnimatedCrossFade].
/// `SizeTransition` acts as a clip region that animates either its width or

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[]

///
/// For a widget that automatically animates between the sizes of two children,
/// fading between them, see [AnimatedCrossFade].
/// `SizeTransition` acts as a clip region that animates either its width or

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

clip region?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

clip rect, I mean.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i guess @liyuqian will change that when he does his patch to remove clipping everywhere

/// For a widget that automatically animates between the sizes of two children,
/// fading between them, see [AnimatedCrossFade].
/// `SizeTransition` acts as a clip region that animates either its width or
/// height, depending upon the value of [axis]. The alignment of the child along

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

or its height

/// given, so be sure to put it in a context where it can change size. For
/// instance, if you place it into a [Container] with a fixed size, then the
/// `SizeTransition` will not be able to change size, and will appear to do
/// nothing.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[] instead of `` throughout

@Hixie

Hixie commented Jul 24, 2018

Copy link
Copy Markdown
Contributor

LGTM

@gspencergoog
gspencergoog merged commit ed0f4e0 into flutter:master Jul 25, 2018
@gspencergoog
gspencergoog deleted the size_transition_docs branch October 5, 2018 01:30
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Aug 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants