https://github.com/sephiroth74/tri-state-checkbox

3 State Checkbox for android in pure Material Style
https://github.com/sephiroth74/tri-state-checkbox

android android-library android-ui animation checkbox checkbox-component material-design

Last synced: about 2 months ago
JSON representation

3 State Checkbox for android in pure Material Style

• Host: GitHub
• URL: https://github.com/sephiroth74/tri-state-checkbox
• Owner: sephiroth74
• License: mit
• Created: 2019-01-14T23:46:09.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-06-13T14:46:18.000Z (over 3 years ago)
• Last Synced: 2023-07-28T10:18:48.454Z (over 1 year ago)
• Topics: android, android-library, android-ui, animation, checkbox, checkbox-component, material-design
• Language: Java
• Size: 496 KB
• Stars: 59
• Watchers: 5
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Animated Tri State Checkbox

3 State Checkbox for **Android** in pure Material Style, with animation between the states.

[![](https://jitpack.io/v/sephiroth74/Tri-State-Checkbox.svg)](https://jitpack.io/#sephiroth74/Tri-State-Checkbox)



# Usage

In your layout:

    

In Kotlin:

    // set both the checked and indeterminate state

    checkbox.setChecked(true, true)

    // set the indeterminate state only

    checkBox.isIndeterminate = false

## Cycles:

Change the cycle used to determine the next state of the checkbox when the user click the component, or when the **toggle()** method is called.


The value passed is an array of 4 integer elements, representing the state of the checkbox.


The value of each element can be 0 or 1, with 0 to disable the state and 1 to enable the state.


The states are (in order):

- Checked

- Indeterminate (checked)

- Unchecked

- Indeterminate (unchecked)

     

So if a cycle like this one is used:

    int[] cycle = new int[]{1,0,1,0}

the checkbox will only cycle between checked and unchecked state.


The method throws an exception if the array is not valid.


A valid array must match the following rules:

- If not null, must have 4 elements

- At least 2 elements must be equal to 1

In Kotlin:

    

    checkBox1.setCycle(intArrayOf(1, 0, 1, 0))

In xml layout:

    app:sephiroth_checkbox3_checkableCycle="@array/sephiroth_checkbox3_cycleCheckedUncheckedOnly"

# Installation

## Maven

    implementation 'it.sephiroth.android.library:tri-state-checkbox:{version}'

## JitPack

**Step 1.** Add the JitPack repository to your build file:

	allprojects {

		repositories {

			...

			maven { url 'https://jitpack.io' }

		}

	}

**Step 2.** Add the dependency

	dependencies {

	        implementation 'com.github.sephiroth74:AndroidUIGestureRecognizer:Tag'

	}

Get the latest version  on [JitPack](https://jitpack.io/#sephiroth74/Tri-State-Checkbox)

# License

MIT License

Copyright (c) 2019 Alessandro Crugnola

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.