Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ioki-mobility/progressbutton
https://github.com/ioki-mobility/progressbutton
android hacktoberfest jetpack-compose kotlin
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ioki-mobility/progressbutton
- Owner: ioki-mobility
- License: mit
- Created: 2022-07-26T18:30:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-21T15:24:44.000Z (15 days ago)
- Last Synced: 2024-12-21T16:28:44.382Z (15 days ago)
- Topics: android, hacktoberfest, jetpack-compose, kotlin
- Language: Kotlin
- Homepage:
- Size: 5.11 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ProgressButton
[](https://github.com/ioki-mobility/ProgressButton/actions/workflows/build.yml)
[](https://central.sonatype.com/namespace/com.ioki.progressbutton)
[](https://s01.oss.sonatype.org/content/repositories/snapshots/com/ioki/progressbutton/)
[](https://javadoc.io/doc/com.ioki.progressbutton/progressbutton)
[](https://github.com/ioki-mobility/ProgressButton/blob/main/LICENSE.md)
## What?
We needed an Button that uses a progress state as background.
As we didn't found something like that in Jetpack Compose
we decided to build it on our own and open source it.
## How?
The following creates a `ProgressButton` which starts the progress after 1 seconds while the
progress will take 10 seconds.
```kotlin
ProgressButton(
modifier = Modifier,
startDelay = 1.seconds,
duration = 10.seconds,
onClick = {
// Do something on click
},
onFinished = {
// Do something after progress finished
}
) {
Box(
modifier = Modifier
.padding(start = 26.dp, end = 26.dp)
.fillMaxSize(),
contentAlignment = Alignment.Center
) {
Text("Hello World")
}
}
```
You can also checkout
the [`SampleActivity`](sample/src/main/java/com/ioki/progressbutton/sample/SampleActivity.kt)
for more code snippets.
## Docs
```kotlin
fun ProgressButton(
modifier: Modifier,
backgroundColor: Color = Color.Transparent,
progressColor: Color = MaterialTheme.colors.primary,
contentColor: Color = contentColorFor(progressColor),
contentColorDisabled: Color = MaterialTheme.colors.primaryVariant,
enabled: Boolean = true,
startDelay: Duration = Duration.ZERO,
duration: Duration = 10L.seconds,
restDuration: Duration = duration,
onClick: () -> Unit = {},
onFinished: () -> Unit = {},
content: @Composable () -> Unit
)
```
| Parameter | Description |
|----------------------|--------------------------------------------------------------------------------|
| Modifier | Modifier to be applied to the button |
| backgroundColor | The color *behind* the progress |
| progressColor | The progress color which which will animate away after `duration` reaches zero |
| contentColor | Color of the content of the button |
| contentColorDisabled | Color of the content of the button when its disabled |
| enabled | Enables or disable the button |
| startDelay | An delay before the progress actually starts |
| duration | The duration of the progress |
| restDuration | The duration which is left of `duration` to reach zero |
| onClick | Will be called when the button got clicked and `enabled` is `true` |
| onFinished | Will be called when the `duration` reaches zero |
| content | The content of the button |
## Download
ProgressButton is hosted on Maven Central.
Here's how you include it in your gradle project:
**Step 1.** Add the Maven Central repository to your build file:
```groovy
repositories {
// Other repositories
mavenCentral()
}
```
Snapshot versions can be download over the sonatype snapshot repository:
```kotlin
repositories {
// Other repositories
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots")
}
```
**Step 2.** Add the dependency:
```groovy
dependencies {
implementation 'com.ioki.progressbutton:progressbutton:'
}
```
## Releasing
### Continuous release
By default, each merge to the `main` branch will create a new SNAPSHOT release.
If you want to use the latest and greatest use the SNAPSHOT version of the library.
But please be aware that they might contain bugs or behaviour changes.
To use the SNAPSHOT version you have to include the sonatype snapshot repository which in the *Download* section above.
### Proper release
1. Checkout `main` branch and pull latest changes.
2. Add the changes to the top of the [`CHANGELOG.md`](CHANGELOG.md) file.
3. Update the version in the [`progressbutton/build.gradle.kts`](progressbutton/build.gradle.kts)
file.
4. Commit.
* `git commit -m "Prepare next relaese" .`
5. Create a git tag with the version of the [`CHANGELOG.md`](CHANGELOG.md) and push.
* `git tag [X.Y.Z]`
* `git push origin [X.Y.Z]`
6. Update the version [`progressbutton/build.gradle.kts`](progressbutton/build.gradle.kts) to the **next patch version** +`-SNAPSHOT`
7. Commit and push the changes
* `git push origin main .`