Skip to content

Commit

Permalink
Refresh README (#97)
Browse files Browse the repository at this point in the history
* Refresh README
  • Loading branch information
Shi-Hao Hong authored Feb 18, 2020
1 parent caefcef commit 5f901fb
Show file tree
Hide file tree
Showing 17 changed files with 55 additions and 29 deletions.
5 changes: 5 additions & 0 deletions packages/animations/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## [1.0.0+3] - February 18, 20200

* Update README.md to better describe Material motion


## [1.0.0+2] - February 18, 20200

* Fixes to pubspec.yaml
Expand Down
77 changes: 49 additions & 28 deletions packages/animations/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fancy pre-built Animations for Flutter
# High quality pre-built Animations for Flutter

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.

Expand All @@ -9,42 +9,63 @@ cd example/
flutter run --release
```

## Available Animations
## Material motion for Flutter

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

### Material's Open Container Transitions
1. [Container transform](#container-transform)
2. [Shared axis](#shared-axis)
3. [Fade through](#fade-through)
4. [Fade](#fade)

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

| Card with Fade Transition | Card with Fade Through Transition |
:------------------------------------:|:------------------------------------:
|![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)
| **Floating Action Button with Fade Transition** | **Floating Action Button with Fade Through Transition** |
|![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)
### Material's Shared Axis Transitions
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.

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

| Horizontal (x-axis) | Vertical (y-axis) | Scaled (z-axis) |
:-------------------------:|:-----------------------:|:--------------------:|
|![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)
1. _A card into a details page_
2. _A list item into a details page_
3. _A FAB into a details page_
4. _A search bar into expanded search_

### Material's Fade Through Transition
### Shared axis

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

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

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

The fade pattern is used for UI elements that enter or exit from within
the screen bounds.
### Fade through

| Modal Fade Transition | Floating Action Button Fade Transition |
:----------------------------------:|:----------------------------------------:
|![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)
The **fade through** pattern is used for transitions between UI elements that do
not have a strong relationship to each other.

!["Fade through gallery - normal speed and slow motion"](example/demo_gifs/fade_through_lineup.gif)
_Examples of the fade through pattern:_

1. _Tapping destinations in a bottom navigation bar_
2. _Tapping a refresh icon_
3. _Tapping an account switcher_

### Fade

The **fade** pattern is used for UI elements that enter or exit within the
bounds of the screen, such as a dialog that fades in the center of the screen.

!["Fade gallery - normal speed and slow motion"](example/demo_gifs/fade_lineup.gif)
_Examples of the fade pattern:_

1. _A dialog_
2. _A menu_
3. _A snackbar_
4. _A FAB_
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/animations/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: animations
description: Fancy pre-built animations that can easily be integrated into any Flutter application.
version: 1.0.0+2
version: 1.0.0+3
homepage: https://github.com/flutter/packages/tree/master/packages/animations

environment:
Expand Down

0 comments on commit 5f901fb

Please sign in to comment.