Update README.md

This commit is contained in:
David Peters 2020-09-23 10:26:59 +02:00 committed by GitHub
parent 646e022cd7
commit 198bd9ffce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 21 deletions

View File

@ -2,7 +2,7 @@
A lightweight flutter package to simplify the creation of a miniplayer by providing a builder function with the current height and percentage progress. The widget responds to tap and drag gestures and is highly customizable. A lightweight flutter package to simplify the creation of a miniplayer by providing a builder function with the current height and percentage progress. The widget responds to tap and drag gestures and is highly customizable.
**What is a miniplayer?** **What is a miniplayer?**
Miniplayers are commonly used in media applications(e.g. Spotify, Youtube). A miniplayer can be expanded and minified and remains on the screen when minified until dismissed by the user. Miniplayers are commonly used in media applications like Spotify and Youtube. A miniplayer can be expanded and minified and remains on the screen when minified until dismissed by the user.
See the demo below for an example. See the demo below for an example.
## Demo ## Demo
@ -23,12 +23,12 @@ Miniplayer(
), ),
``` ```
##Options ## Options
<table> <table>
<tr> <tr>
<td>onDismiss</td> <td>onDismiss</td>
<td width="33%"> <td>
<pre lang="dart"> <pre lang="dart">
Miniplayer( Miniplayer(
onDismiss: () { onDismiss: () {
@ -39,27 +39,10 @@ Miniplayer(
), ),
</pre> </pre>
</td> </td>
<td width="66%"> <td ">
<img src="./example/demo_gif/demo_dismiss.gif"/> <img src="./example/demo_gif/demo_dismiss.gif"/>
</td> </td>
</tr> </tr>
<tr>
<td>onDismiss</td>
<td width="33%">
<pre lang="dart">
Miniplayer(
onDismiss: () {
//If onDismiss is set,
//the miniplayer can be dismissed
//Handle onDismissed here e.g.
},
),
</pre>
</td>
<td width="66%">
<img src="./example/demo_gif/demo.gif"/>
</td>
</tr>
</table> </table>
### Usage without BottomNavigationBar ### Usage without BottomNavigationBar