Skip to content

Commit 5f901fb

Browse files
author
Shi-Hao Hong
authored
Refresh README (#97)
* Refresh README
1 parent caefcef commit 5f901fb

17 files changed

+55
-29
lines changed

packages/animations/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## [1.0.0+3] - February 18, 20200
2+
3+
* Update README.md to better describe Material motion
4+
5+
16
## [1.0.0+2] - February 18, 20200
27

38
* Fixes to pubspec.yaml

packages/animations/README.md

Lines changed: 49 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Fancy pre-built Animations for Flutter
1+
# High quality pre-built Animations for Flutter
22

33
This package contains pre-canned animations for commonly-desired effects. The animations can be customized with your content and dropped into your application to delight your users.
44

@@ -9,42 +9,63 @@ cd example/
99
flutter run --release
1010
```
1111

12-
## Available Animations
12+
## Material motion for Flutter
1313

14-
Currently, the following animated effects are available in this library:
14+
Material motion is a set of transition patterns that help users understand and navigate an app. Currently,
15+
the following transition patterns are available in this library:
1516

16-
### Material's Open Container Transitions
17+
1. [Container transform](#container-transform)
18+
2. [Shared axis](#shared-axis)
19+
3. [Fade through](#fade-through)
20+
4. [Fade](#fade)
1721

18-
Tapping on a container (e.g. a card or a button) will expand the container to reveal more information.
22+
### Container transform
1923

20-
| Card with Fade Transition | Card with Fade Through Transition |
21-
:------------------------------------:|:------------------------------------:
22-
|![Open Container Card Fade Transition Demo](example/demo_gifs/open_container_fade_card_demo.gif)|![Open Container Card Fade Through Transition Demo](example/demo_gifs/open_container_fade_through_card_demo.gif)
23-
| **Floating Action Button with Fade Transition** | **Floating Action Button with Fade Through Transition** |
24-
|![Open Container Card Fade Transition Demo](example/demo_gifs/open_container_fade_floating_action_button_demo.gif)|![Open Container Floating Action Button Fade Through Transition Demo](example/demo_gifs/open_container_fade_through_floating_action_button_demo.gif)
25-
### Material's Shared Axis Transitions
24+
The **container transform** pattern is designed for transitions between UI elements that include a container. This pattern creates a visible connection between two UI elements.
2625

27-
A transition animation between UI elements that have a spatial or navigational
28-
relationship.
26+
!["Container transform gallery - normal speed and slow motion"](example/demo_gifs/container_transform_lineup.gif)
27+
_Examples of the container transform:_
2928

30-
| Horizontal (x-axis) | Vertical (y-axis) | Scaled (z-axis) |
31-
:-------------------------:|:-----------------------:|:--------------------:|
32-
|![Shared Axis Horizontal Transition Demo](example/demo_gifs/shared_axis_horizontal_demo.gif)|![Shared Axis Vertical Transition Demo](example/demo_gifs/shared_axis_vertical_demo.gif)|![Shared Axis Scaled Transition Demo](example/demo_gifs/shared_axis_scaled_demo.gif)
29+
1. _A card into a details page_
30+
2. _A list item into a details page_
31+
3. _A FAB into a details page_
32+
4. _A search bar into expanded search_
3333

34-
### Material's Fade Through Transition
34+
### Shared axis
3535

36-
A transition animation between UI elements that have do not have a strong
37-
relationship to one another.
36+
The **shared axis** pattern is used for transitions between UI elements that
37+
have a spatial or navigational relationship. This pattern uses a shared
38+
transformation on the x, y, or z axis to reinforce the relationship between
39+
elements.
3840

39-
| Fade Through Page Transition |
40-
:-----------------------------:|
41-
|![Fade Through Transition Demo](example/demo_gifs/fade_through_demo.gif)|
41+
!["Shared axis gallery - normal speed and slow motion"](example/demo_gifs/shared_axis_lineup.gif)
42+
_Examples of the shared axis pattern:_
4243

43-
### Material's Fade Transition
44+
1. _An onboarding flow transitions along the x-axis_
45+
2. _A stepper transitions along the y-axis_
46+
3. _A parent-child navigation transitions along the z-axis_
4447

45-
The fade pattern is used for UI elements that enter or exit from within
46-
the screen bounds.
48+
### Fade through
4749

48-
| Modal Fade Transition | Floating Action Button Fade Transition |
49-
:----------------------------------:|:----------------------------------------:
50-
|![Fade Modal Transition Demo](example/demo_gifs/fade_modal_demo.gif)|![Fade Floating Action Button Transition Demo](example/demo_gifs/fade_floating_action_button_demo.gif)
50+
The **fade through** pattern is used for transitions between UI elements that do
51+
not have a strong relationship to each other.
52+
53+
!["Fade through gallery - normal speed and slow motion"](example/demo_gifs/fade_through_lineup.gif)
54+
_Examples of the fade through pattern:_
55+
56+
1. _Tapping destinations in a bottom navigation bar_
57+
2. _Tapping a refresh icon_
58+
3. _Tapping an account switcher_
59+
60+
### Fade
61+
62+
The **fade** pattern is used for UI elements that enter or exit within the
63+
bounds of the screen, such as a dialog that fades in the center of the screen.
64+
65+
!["Fade gallery - normal speed and slow motion"](example/demo_gifs/fade_lineup.gif)
66+
_Examples of the fade pattern:_
67+
68+
1. _A dialog_
69+
2. _A menu_
70+
3. _A snackbar_
71+
4. _A FAB_
Loading
Binary file not shown.
Loading
Binary file not shown.
Binary file not shown.
Loading
Binary file not shown.

0 commit comments

Comments
 (0)