https://github.com/zagum/Android-SwitchIcon

Google launcher-style implementation of switch (enable/disable) icon
https://github.com/zagum/Android-SwitchIcon

android icons material material-ui switch

Last synced: about 2 months ago
JSON representation

Google launcher-style implementation of switch (enable/disable) icon

• Host: GitHub
• URL: https://github.com/zagum/Android-SwitchIcon
• Owner: zagum
• License: apache-2.0
• Created: 2017-01-08T19:56:28.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-16T11:55:35.000Z (8 months ago)
• Last Synced: 2024-10-15T10:42:17.735Z (about 2 months ago)
• Topics: android, icons, material, material-ui, switch
• Language: Kotlin
• Size: 523 KB
• Stars: 2,327
• Watchers: 45
• Forks: 222
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-kotlin - Android-SwitchIcon - Google launcher-style implementation of switch (enable/disable) icon (Libraries)
• awesome-github-android-ui - Android-SwitchIcon - Switch图标的Google启动器风格实现 (SwitchButton)

README

        
Android-SwitchIcon

================

[![](https://jitpack.io/v/zagum/Android-SwitchIcon.svg)](https://jitpack.io/#zagum/Android-SwitchIcon)

[![API](https://img.shields.io/badge/API-15%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=15)

Google launcher-style implementation of switch (enable/disable) icon

![image](https://github.com/zagum/Android-SwitchIcon/blob/master/art/sample.gif)

Compatibility

-------------

This library is compatible from API 15 (Android 4.0.3).

Download

--------

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.zagum:Android-SwitchIcon:1.4.2'

}

```

Usage

-----

SwitchIconView extends from AppCompatImageView so you can set icon with  ```app:srcCompat```

Set any icon (vector or image) to SwitchIconView and enjoy switchable icon in your app :)

Use ```app:si_tint_color``` to set color to icon. Default color is black;

Use ```app:si_disabled_color``` to set color when icon disabled. Default color is equals with ```app:si_tint_color```;

Use ```app:si_disabled_alpha``` to set alpha when icon disabled. Default alpha is ```.5```;

Use ```app:si_no_dash``` if you don't want to draw dash, when icon disabled;

Use ```app:si_animation_duration``` if you want to change switching state animation duration;

Use ```app:si_enabled``` to set initial icon state;

Fully customized implementation:

```xml

    

```

Public methods and fields: 

```kotlin

  var isIconEnabled: Boolean

  fun setIconEnabled(enabled: Boolean, animate: Boolean = true)

  fun switchState(animate: Boolean = true)

  

```

See [sample](https://github.com/zagum/Android-SwitchIcon/tree/master/switchicon-sample) project for more information.

License

-------

    Copyright 2017 Evgenii Zagumennyi

    

    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.