Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/GwonHyeok/StickySwitch
⭐️ beautiful switch widget with sticky animation ⭐️
https://github.com/GwonHyeok/StickySwitch
android android-library animation beautiful library material-design sticky switch
Last synced: about 2 months ago
JSON representation
⭐️ beautiful switch widget with sticky animation ⭐️
- Host: GitHub
- URL: https://github.com/GwonHyeok/StickySwitch
- Owner: GwonHyeok
- License: mit
- Created: 2017-03-13T10:18:01.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T10:33:10.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T01:30:35.338Z (4 months ago)
- Topics: android, android-library, animation, beautiful, library, material-design, sticky, switch
- Language: Kotlin
- Homepage:
- Size: 956 KB
- Stars: 773
- Watchers: 18
- Forks: 91
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kotlin - StickySwitch - ⭐️ beautiful switch widget with sticky animation ⭐️ (Libraries)
- awesome-kotlin-android - StickySwitch - 漂亮的切换开关🔥🔥🔥 (开源库 / UI)
- awesome-list - GwonHyeok/StickySwitch - ⭐️ beautiful switch widget with sticky animation ⭐️ (Kotlin)
README
# StickySwitch
[]()
[](https://android-arsenal.com/api?level=15)
[](https://android-arsenal.com/details/1/5433)
[](https://jitpack.io/#GwonHyeok/StickySwitch)
StickySwitch library for android
this library is beautiful switch widget with sticky animation
## Requirements
- Android SDK 15+
## Usage
Add it in your root build.gradle at the end of repositories
```Groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Add the dependency
```Groovy
dependencies {
implementation 'com.github.GwonHyeok:StickySwitch:0.0.16'
}
```
## How to use this library
Add `StickySwitch` to your xml layout
```xml
```
## Available attributes
| Name | Type | Description |
|:-------------------------:|:---------:|:-------------:|
| ss_iconPadding | dimension | - |
| ss_iconSize | dimension | - |
| ss_leftIcon | integer | - |
| ss_leftText | string | - |
| ss_rightIcon | integer | - |
| ss_rightText | string | - |
| ss_selectedTextSize | dimension | - |
| ss_textSize | dimension | - |
| ss_switchColor | color | - |
| ss_sliderBackgroundColor | color | - |
| ss_textColor | color | - |
| ss_animationDuration | integer | - |
| ss_textVisibility | enum | - |
| ss_animationType | enum | line or curved|
## Status change notification
StickySwitch.Direction has two value (LEFT, RIGHT)
onSelectedChange method called when you touch the switch.
When the switch is moved to the right, the direction variable is `StickySwitch.Direction.RIGHT`
also switch is moved to the left, that variable is `StickySwitch.Direction.LEFT`
Java Code Example
```java
// Set Selected Change Listener
StickySwitch stickySwitch = (StickySwitch) findViewById(R.id.sticky_switch);
stickySwitch.setOnSelectedChangeListener(new StickySwitch.OnSelectedChangeListener() {
@Override
public void onSelectedChange(@NotNull StickySwitch.Direction direction, @NotNull String text) {
Log.d(TAG, "Now Selected : " + direction.name() + ", Current Text : " + text);
}
});
```
## Direction
### Methods
```kotlin
fun setDirection(direction: Direction, isAnimate: Boolean = true, shouldTriggerSelected: Boolean = true)
```
### if you want switch button direction to left
```java
stickySwitch.setDirection(StickySwitch.Direction.LEFT);
```
### if you want switch button direction to right without animation
```java
stickySwitch.setDirection(StickySwitch.Direction.RIGHT, false);
```
### if you want switch button direction to right with animation and prevent call selectedChangeListener
```java
stickySwitch.setDirection(StickySwitch.Direction.RIGHT, false, false);
```
### Get current Direction
```java
stickySwitch.getDirection(); // StickySwitch.Direction.LEFT
```
## Text
### get current status text
```java
stickySwitch.getText()
```
### get specific status text
```java
stickySwitch.getText(StickySwitch.Direction.LEFT) // Get leftText
```
### set left or right text
```java
stickySwitch.setLeftText("Left");
stickySwitch.setRightText("Right");
```
### set text typeface
```java
stickySwitch.setTypeFace(Typeface.DEFAULT_BOLD);
```
### text visibility
```java
stickySwitch.setTextVisibility(StickySwitch.TextVisibility.VISIBLE); // Visible Text
stickySwitch.setTextVisibility(StickySwitch.TextVisibility.INVISIBLE); // Invisible Text
stickySwitch.setTextVisibility(StickySwitch.TextVisibility.GONE); // GONE Text
```
## Icon
### set left icon with drawableRes
```java
stickySwitch.setLeftIcon(R.mipmap.ic_launcher);
```
### set left icon with drawable
```java
Drawable drawable = getDrawable(R.mipmap.ic_launcher);
stickySwitch.setLeftIcon(drawable);
```
## Color
### set colors
```java
// The color format must be (0xAARRGGBB)
stickySwitch.setSliderBackgroundColor(0xFF181821);
stickySwitch.setSwitchColor(0xFF2371FA);
stickySwitch.setTextColor(0xFFFFFFFF);
```
## Animation
### custom duration
```java
// Animation duration to 1000ms (default duration is 600ms)
stickySwitch.setAnimationDuration(1000);
```
### set different animation type
```java
// Set animation type to curved (default is line)
stickySwitch.setAnimationType(StickySwitch.AnimationType.CURVED);
```
# Reference
#### Talos Onboarding
- [dribbble](https://dribbble.com/shots/3047204-Talos-Onboarding)
- [material-uplabs](https://material.uplabs.com/posts/talos-onboarding)
# License
```
MIT License
Copyright (c) 2017 GwonHyeok
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.
```