Skip to content

Commit

Permalink
fixed readme image sizes wrapping on pub
Browse files Browse the repository at this point in the history
  • Loading branch information
akshathjain committed Apr 5, 2019
1 parent ff59bfd commit b7fdf36
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 48 deletions.
71 changes: 43 additions & 28 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
## [0.1.0] - March 31, 2019

This is the initial release of the sliding_up_panel package. This includes features such as
- A sliding up panel that responds to user gestures
- Customizing the look and feel of the sliding panel
- Manually controlling the sliding panel via the PanelController
## [0.3.2] - [April 5, 2019]

## [0.1.1] - March 31, 2019

- Added a CHANGELOG file
#### Documentation
- Fixed problem where images would wrap on pub (instead of displaying on one line)

## [0.1.2] - March 31, 2019
## [0.3.1] - [April 5, 2019]

- Updated documentation to be more comprehensive
#### Features
- Configuration options to `SlidingUpPanel`
- `parallaxEnabled`
- `parallaxOffset`

## [0.2.0] - April 1, 2019
#### Documentation
- Created a new example app (Maps)
- Updated documentation to reflect new features

Added the backdrop feature:
- Body darkens as the panel opens
- The backdrop color is customizable
- The backdrop opacity is also customizable
- Off by default

Other changes:
- Removed the README from the example app (pub will display the code on the website now)
- Specified Dart as the language in the README code snippets

## [0.3.0] - April 2, 2019

Expand Down Expand Up @@ -52,13 +43,37 @@ Other changes:
- Added clarification on `PanelController` lifecycle
- Added an explanation about nesting the `Scaffold` when displaying a backdrop

## [0.3.1] - [April 5, 2019]

#### Features
- Configuration options to `SlidingUpPanel`
- `parallaxEnabled`
- `parallaxOffset`

#### Documentation
- Created a new example app (Maps)
- Updated documentation to reflect new features
## [0.2.0] - April 1, 2019

Added the backdrop feature:
- Body darkens as the panel opens
- The backdrop color is customizable
- The backdrop opacity is also customizable
- Off by default

Other changes:
- Removed the README from the example app (pub will display the code on the website now)
- Specified Dart as the language in the README code snippets



## [0.1.2] - March 31, 2019

- Updated documentation to be more comprehensive



## [0.1.1] - March 31, 2019

- Added a CHANGELOG file



## [0.1.0] - March 31, 2019

This is the initial release of the sliding_up_panel package. This includes features such as
- A sliding up panel that responds to user gestures
- Customizing the look and feel of the sliding panel
- Manually controlling the sliding panel via the PanelController
39 changes: 20 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# sliding_up_panel
[![pub package](https://img.shields.io/pub/v/sliding_up_panel.svg)](https://pub.dartlang.org/packages/sliding_up_panel)
[![GitHub Star](https://img.shields.io/github/stars/akshathjain/sliding_up_panel.svg)](https://github.com/akshathjain/sliding_up_panel)

A draggable Flutter widget that makes implementing a SlidingUpPanel much easier!

Expand All @@ -15,7 +16,7 @@ A draggable Flutter widget that makes implementing a SlidingUpPanel much easier!
Add the following to your `pubspec.yaml` file:
```
dependencies:
sliding_up_panel: ^0.3.1
sliding_up_panel: ^0.3.2
```

<br>
Expand Down Expand Up @@ -76,9 +77,9 @@ Widget build(BuildContext context) {
Both methods produce the same result:

<p float="left">
<img alt="Panel Closed" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/simpleusageclosed.png">
<img alt="Panel Midway" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/simpleusagemidway.png">
<img alt="Panel Open" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/simpleusageopen.png">
<img alt="Panel Closed" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/simpleusageclosed.png">
<img alt="Panel Midway" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/simpleusagemidway.png">
<img alt="Panel Open" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/simpleusageopen.png">
</p>

<br>
Expand Down Expand Up @@ -144,9 +145,9 @@ Widget build(BuildContext context){
Notice how the `Scaffold` is nested inside of the `SlidingUpPanel`. This because the backdrop is rendered only over the `body` of the `SlidingUpPanel`. As a result, if we want the `backdrop` to appear over the `AppBar`, then we *must* nest the `Scaffold` this way.

<p float="left">
<img alt="Panel Closed" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/backdropclosed.png">
<img alt="Panel Midway" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/backdropmidway.png">
<img alt="Panel Open" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/backdropopen.png">
<img alt="Panel Closed" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/backdropclosed.png">
<img alt="Panel Midway" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/backdropmidway.png">
<img alt="Panel Open" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/backdropopen.png">
</p>

<br>
Expand Down Expand Up @@ -184,9 +185,9 @@ Widget build(BuildContext context) {
```

<p float="left">
<img alt="Panel Closed" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/collapsedpanelclosed.png">
<img alt="Panel Midway" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/collapsedpanelmidway.png">
<img alt="Panel Open" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/collapsedpanelopen.png">
<img alt="Panel Closed" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/collapsedpanelclosed.png">
<img alt="Panel Midway" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/collapsedpanelmidway.png">
<img alt="Panel Open" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/collapsedpanelopen.png">
</p>

<br>
Expand Down Expand Up @@ -237,9 +238,9 @@ Widget build(BuildContext context) {
```

<p float="left">
<img alt="Panel Closed" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/borderclosed.png">
<img alt="Panel Midway" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/bordermidway.png">
<img alt="Panel Open" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/borderopen.png">
<img alt="Panel Closed" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/borderclosed.png">
<img alt="Panel Midway" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/bordermidway.png">
<img alt="Panel Open" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/borderopen.png">
</p>

<br>
Expand Down Expand Up @@ -305,9 +306,9 @@ Widget _floatingPanel(){
Note that a similar effect can be created by simply adding a `margin` to the `SlidingUpPanel`.

<p float="left">
<img alt="Panel Closed" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/floatingclosed.png">
<img alt="Panel Midway" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/floatingmidway.png">
<img alt="Panel Open" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/floatingopen.png">
<img alt="Panel Closed" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/floatingclosed.png">
<img alt="Panel Midway" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/floatingmidway.png">
<img alt="Panel Open" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/floatingopen.png">
</p>

<br>
Expand Down Expand Up @@ -354,9 +355,9 @@ Widget _scrollingList(){
```

<p float="left">
<img alt="Panel Closed" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/scrollclosed.png">
<img alt="Panel Midway" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/scrollmidway.png">
<img alt="Panel Open" width="220px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/scrollopen.png">
<img alt="Panel Closed" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/scrollclosed.png">
<img alt="Panel Midway" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/scrollmidway.png">
<img alt="Panel Open" width="217px" src="https://raw.githubusercontent.com/akshathjain/sliding_up_panel/master/screenshots/scrollopen.png">
</p>

<br>
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: sliding_up_panel
description: A draggable Flutter widget that makes implementing a SlidingUpPanel much easier!
version: 0.3.1
version: 0.3.2
author: Akshath Jain <[email protected]>
homepage: https://github.com/akshathjain/sliding_up_panel

Expand Down

0 comments on commit b7fdf36

Please sign in to comment.