Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anoop44/AwesomeSwitch
AwesomeSwitch is a replacement for the standard Switch(View) android offers, and it offers much more customization than the standard switch component.
https://github.com/anoop44/AwesomeSwitch
List: AwesomeSwitch
android customview kotlin kotlin-android widgets
Last synced: about 2 months ago
JSON representation
AwesomeSwitch is a replacement for the standard Switch(View) android offers, and it offers much more customization than the standard switch component.
- Host: GitHub
- URL: https://github.com/anoop44/AwesomeSwitch
- Owner: anoop44
- License: apache-2.0
- Created: 2019-10-14T04:02:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-10T02:20:13.000Z (almost 5 years ago)
- Last Synced: 2024-05-18T19:56:45.045Z (4 months ago)
- Topics: android, customview, kotlin, kotlin-android, widgets
- Language: Kotlin
- Size: 3.42 MB
- Stars: 32
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android-ui - AwesomeSwitch - 2.0) | <img src="/art/awesome-switch.gif" height="50%"> (Index)
README
# AwesomeSwitch [  ](https://bintray.com/anoop44/maven/awesome-switch/_latestVersion)
AwesomeSwitch is a replacement for the standard Switch(View) android offers, and it offers much more customization than the standard switch component.
## Adding to project
### Gradle
Add below code to your **root** `build.gradle` file (if you have multiple modules and only one of them require `AwesomeSwitch`, add the `jcenter()` repository only in that module's `build.gradle`).
```gradle
allprojects {
repositories {
jcenter()
}
}
```
And add the following dependency code to your **module**'s `build.gradle` file.
```gradle
dependencies {
implementation "ss.anoop:awesome-switch:${latest-version}"
}
```
AwesomeSWitch can be included in your layout xml like any other view. Below is a simple example
## Usage
```xml
```
### Customization
Table below descripes the properties available to customize the AwesomeSwitch
| Property Name | Format | Description |
|------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| radius | dimension | Defines the size of the circle in the AwesomeSwitch |
| checkedColor | color | defines the color of the circle when the switch is in checked (on) state. Default color is white. If checked and unchecked(off) have different colors, there will be color transition animation when states change |
| uncheckedColor | color | defines the color of the circle when the switch is in unchecked (off) state. Default color is white. If checked(on) and unchecked have different colors, there will be color transition animation when states change |
| backgroundColor | color | defines the color of the switch background shape. The same will be used for checked and unchecked state unless checkedBackgroundColor is mentioned |
| checkedBackgroundColor | color | defines the color of the switch background shape in checked(on) state. |
| innerPadding | dimension | defines the padding applied to the background shape, ie, the space between the circle and the background shape |
| isChecked | boolean | to set the state to checked(on) or unchecked(off) at the time of inflation. Default value of this field is false |
| animationDuration | integer | defines the duration of unchecked to checked or the opposite animation duration in milliseconds. By default it is 300 milliseconds |
### Change Listener
AwesomeSwitch offers an `OnCheckedListener` that informs when checked state is changed. The callback has a boolean field which indicates checked(on) state when value is true, false indicates unchecked(off) state.
`awesomeSwitch.setOnCheckedListener { state -> processState(state) }`
## Find this library useful? :heart:
Support it by joining __[stargazers](https://github.com/anoop44/AwesomeSwitch/stargazers)__ for this repository. :star:
# License
```xml
Copyright 2019 anoop44 (Anoop)
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.
```