Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
André Sousa committed Oct 23, 2020
2 parents e4c875e + dd4ba6a commit a599f45
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 27 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/android.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Android CI

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]

jobs:
build:

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- name: set up JDK 1.8
uses: actions/setup-java@v1
with:
java-version: 1.8
- name: Build with Gradle
run: ./gradlew build assembleDebug
49 changes: 23 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@

This library allows you to display the bottom sheets in your application with the bonus of **animating the color of the status bar** and the **upper rounded corners** while scrolling.

It was written **100% in Kotlin** ❤️.

## Download

This library is available in **jitpack**, so to use it you will need to add the above instruction to your root *build.gradle*:
This library is available in **jitpack**, so to use it you need to add the above statement to your root *build.gradle*:

```groovy
allprojects {
Expand All @@ -31,17 +30,17 @@ Add the dependency:

```groovy
dependencies {
implementation 'com.github.andrefrsousa:SuperBottomSheet:1.5.0'
implementation 'com.github.andrefrsousa:SuperBottomSheet:2.0.0'
}
```

## Sample Project

We have a sample project in Kotlin that demonstrates the use of the Lib [here](https://github.com/andrefrsousa/SuperBottomSheet/blob/master/demo/src/main/java/com/andrefrsousa/superbottomsheet/demo/MainActivity.kt).
We have a sample project in Kotlin that demonstrates the use of the library [here](https://github.com/andrefrsousa/SuperBottomSheet/blob/master/demo/src/main/java/com/andrefrsousa/superbottomsheet/demo/MainActivity.kt).

![](/raw/example.gif)

## Usage
## Use

It is recommended that you review the sample project to get a full understanding of all the features offered by the library.
To create a bottom sheet in your project, you only need to extend *SuperBottomSheetFragment*.
Expand All @@ -58,7 +57,7 @@ class MySheetFragment : SuperBottomSheetFragment() {
}
```

## Customization
## Adjustments

This is a group of general properties that you can define. These properties are applied to the entire *SuperBottomSheet* in your project.

Expand Down Expand Up @@ -143,29 +142,27 @@ fun animateStatusBar(): Boolean {
// Your code goes here
}

fun getExpandedHeight(): Int {
// Your code goes here
}


```

## License

```
The MIT License (MIT)
Copyright (c) 2018 André Sousa
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h1 class="title is-1"><a href="https://github.com/andrefrsousa/SuperBottomSheet
<h2 class="subtitle">Android native bottom sheet on steroids 💪</h2>
<div class="call-to-action content">
<p class="install-text is-size-5">
<code><span>implementation &#39;com.github.andrefrsousa:SuperBottomSheet:1.5.0&#39;</span></code>
<code><span>implementation &#39;com.github.andrefrsousa:SuperBottomSheet:2.0.0&#39;</span></code>
</p>
<div class="notification is-link is-hidden copy-notification">Copied to clipboard!</div>
</div>
Expand Down

0 comments on commit a599f45

Please sign in to comment.