Skip to content

Commit

Permalink
Update README for multiplatform
Browse files Browse the repository at this point in the history
  • Loading branch information
skydoves committed Dec 17, 2023
1 parent b1533c6 commit 36cdf53
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</p><br>

<p align="center">
🐬 FlexibleBottomSheet is an advanced Jetpack Compose bottom sheet that allows you to implement segmented sizing and non-modal type, similar to Google Maps. It also offers additional conveniences, including specifying sheet sizes, monitoring sheet states, and more customization.
🐬 FlexibleBottomSheet is an advanced Jetpack Compose Multiplatform bottom sheet that allows you to implement segmented sizing and non-modal type, similar to Google Maps. It also offers additional conveniences, including specifying sheet sizes, monitoring sheet states, and more customization.
</p><br>

<p align="center">
Expand All @@ -36,6 +36,22 @@ dependencies {
}
```

For Kotlin Multiplatform, add the dependency below to your **module**'s `build.gradle.kts` file:

```gradle
sourceSets {
val commonMain by getting {
dependencies {
// compose material
implementation("com.github.skydoves:flexible-bottomsheet-material:$version")
// compose material3
implementation("com.github.skydoves:flexible-bottomsheet-material3:$version")
}
}
}
```

## Usage

You can implement a flexible bottom sheet with `FlexibleBottomSheet`, similar to the `ModalBottomSheet` provided by [Compose Material 3](https://developer.android.com/jetpack/androidx/releases/compose-material3). Essentially, you can achieve the same behavior as `ModalBottomSheet` by not altering any properties.
Expand Down

0 comments on commit 36cdf53

Please sign in to comment.