https://github.com/scacap/rubberbandview
A custom view that simulates the behaviour of a rubber band for Android
https://github.com/scacap/rubberbandview
Last synced: about 1 month ago
JSON representation
A custom view that simulates the behaviour of a rubber band for Android
- Host: GitHub
- URL: https://github.com/scacap/rubberbandview
- Owner: ScaCap
- License: apache-2.0
- Created: 2018-02-13T21:29:24.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T07:55:26.000Z (over 2 years ago)
- Last Synced: 2025-01-13T09:38:09.850Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 1.17 MB
- Stars: 3
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RubberBandView
A custom view that simulates the behaviour of a rubber band for Android. More details [here](https://engineering.scalable.capital/2018/02/25/rubberbandview-a-custom-view.html).
## Usage
### Minimum setup
In your layout file:
```
```
### Max selectable value
The API of the custom view is similar to that of Android's [ProgressBar](https://developer.android.com/reference/android/widget/ProgressBar.html). You must set the max selectable value, using:
```
RubberBandView rubberbandView = findViewById(R.id.rubberBandView);
rubberBandView.setMaxSelection(10);
```
This way, the user can select any value from the range [0,10].
### RubberBandListener
To receive updates to the selected value:
```
rubberBandView.setListener(new RubberBandListener() {
@Override
public void onSelectionChanged(int value) {
Toast.makeText(MainActivity.this, "Selection changed to " + value, Toast.LENGTH_SHORT).show();
}
@Override
public void onSelectionFinished(int value) {
Toast.makeText(MainActivity.this, "Selection ended with value " + value, Toast.LENGTH_SHORT).show();
}
});
```
The `onSelectionFinished` event is triggered as soon as the user has lifted their finger off the view. Note that the value returned in that case is the final selected one.
### Vibration animation
The view comes with a nudge animation, that encourages the user to interact with it.
The default animation uses a [ValueAnimator](https://developer.android.com/reference/android/animation/ValueAnimator.html), which looks like this:
```
vibrationAnimator = ValueAnimator.ofFloat(-1f, 1f, -0.5f, 0.5f, 0);
vibrationAnimator.setInterpolator(new DecelerateInterpolator());
vibrationAnimator.setRepeatCount(3);
vibrationAnimator.setDuration(200 / 3);
vibrationAnimator.setStartDelay(5000);
```
You can supply your own animator, using:
`rubberBandView.setVibrationAnimator(customAnimator)`
To turn the animation off completely, simply set the vibration animator to `null`.
### UI Customization
These are the parameters that can be modified through xml:
```
```
- `loosenessRatio`: how loose the rubber needs to be. Must be in [0, 1] range. Defaults to 0.4
- `rubberColor`: the color of the rubber. Defaults to the theme's `colorAccent`
- `minRubberWidth`: the minimum width of the rubber band, in dp. This will be the width when the rubber band is pulled to its max.
- `maxRubberWidth`: the maximum width of the rubber band, in dp. This will be the width when the rubber band is at rest.
- `vibrationPeakAmplitude`: the maximum displacement of the rubber band when vibrating, in dp.
## Installation
``` groovy
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
implementation "com.github.ScaCap:RubberBandView:1.0.0"
}
```
## License
RubberBandView is Open Source software released under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html).