https://github.com/kofigyan/soronkostepper
Intuitive and user-friendly implementation of a stepper
https://github.com/kofigyan/soronkostepper
android kotlin-android stepper stepper-library
Last synced: 2 months ago
JSON representation
Intuitive and user-friendly implementation of a stepper
- Host: GitHub
- URL: https://github.com/kofigyan/soronkostepper
- Owner: kofigyan
- Created: 2019-11-21T11:47:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-18T11:55:58.000Z (almost 5 years ago)
- Last Synced: 2025-01-19T05:09:22.008Z (4 months ago)
- Topics: android, kotlin-android, stepper, stepper-library
- Language: Kotlin
- Homepage:
- Size: 4.47 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SoronkoStepper
SoronkoStepper is an Android library implementation of a stepper to indicate the various states and transitions in an app.
## Quick Start
Get a feel of how it works:
### Gradle
Add the following dependency to your build.gradle :
```
dependencies {
implementation 'com.kofigyan.soronkostepper:soronkostepper:0.0.3'
}
```
### XML
```
```
To add description data to SoronkoStepper :
```
private val descriptionData = arrayOf("Details", "Status", "Photo", "Confirm", "Done")
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(your_layout)
mStepper = findViewById(R.id.soronko_stepper)
mStepper.descriptionData = descriptionData
}
```
## XML Attributes
ssv_currentStepperNumber => Current stepper number. Must be one of the following constant values : one , two , three , four .
Related method : setCurrentStepperNumber(StepperNumber)
ssv_maxStepperNumber => Maximum stepper number. Must be one of the following constant values : one , two , three , four .
Related method : setMaxStepperNumber(StepperNumber)
ssv_stepperBackgroundColor => Stepper background color. Should be a color value. Possible forms are "#rgb", "#argb", "#rrggbb", or "#aarrggbb".
Related method : stepperBackgroundColor(int)
ssv_stepperForegroundColor => Stepper foreground color. Should be a color value. Possible forms are "#rgb", "#argb", "#rrggbb", or "#aarrggbb".
Related method : stepperForegroundColor(int)
ssv_stepperNumberBackgroundColor => Stepper number background color. Should be a color value. Possible forms are "#rgb", "#argb", "#rrggbb", or "#aarrggbb".
Related method : stepperNumberBackgroundColor(int)
ssv_stepperNumberForegroundColor => Stepper number foreground color. Should be a color value. Possible forms are "#rgb", "#argb", "#rrggbb", or "#aarrggbb".
Related method : stepperNumberForegroundColor(int)
ssv_currentStepperDescriptionColor => Current stepper description color. Should be a color value. Possible forms are "#rgb", "#argb", "#rrggbb", or "#aarrggbb".
Related method : currentStepperDescriptionColor(int)
ssv_stepperDescriptionColor => Stepper description color. Should be a color value. Possible forms are "#rgb", "#argb", "#rrggbb", or "#aarrggbb".
Related method : stepperDescriptionColor(int)
ssv_stepperSize => Stepper size . Must be a dimension value with preferrable unit of dp eg. 25dp
Related method : stepperSize(float)
ssv_stepperTextSize => Stepper text(number) size . Must be a dimension value with preferrable unit of sp eg. 15sp
Related method : stepperNumberTextSize(float)
ssv_stepperDescriptionSize => Stepper description size . Must be a dimension value with preferrable unit of dp eg. 20dp
Related method : stepperDescriptionSize(Int)
ssv_checkStepperCompleted => Check completed steppers . Must be a boolean value,either "true" or "false"
Related method : checkStepperCompleted(Boolean)
ssv_animationStartDelay => Stepper animation start delay . Must be an integer value eg. "500" , "1000" , "2000" , "5000" , "10000" etc
Related method : animStartDelay(int)
## KOTLIN/JAVA
SoronkoStepper mStepper = findViewById(R.id.soronko_stepper)
mStepper.stepperForegroundColor = ContextCompat.getColor(this, R.color.demo_stepper_foreground_color)
mStepper.stepperBackgroundColor = ContextCompat.getColor(this, android.R.color.darker_gray)
mStepper.stepperNumberForegroundColor = ContextCompat.getColor(this, android.R.color.white)
mStepper.stepperNumberBackgroundColor = ContextCompat.getColor(this, android.R.color.background_dark)
mStepper.stepperSize = 40f
mStepper.stepperNumberTextSize = 20f
setCurrentStepperNumber(SoronkoStepper.StepperNumber.TWO)
mStepper.stepperNumberTypeface = "fonts/RobotoSlab-Light.ttf"
mStepper.checkStepperCompleted = true
mStepper.stepperDescriptionSize = 18
currentStepperDescriptionColor =
ContextCompat.getColor(this , R.color.description_foreground_color)
stepperDescriptionColor =
ContextCompat.getColor(this , R.color.description_background_color)
mStepper.stepperDescriptionTypeface = "fonts/RobotoSlab-Light.ttf"
mStepper.descriptionTruncateEnd = true
mStepper.descriptionMultilineTruncateEnd = 2
### EXTRA DEMOS(WITH CODES)
- A One-Stepper SoronkoStepper
```
```
- A Two-Stepper SoronkoStepper
```
```
- A Three-Stepper SoronkoStepper
```
```
- A Four-Stepper SoronkoStepper
```
```
- A Five-Stepper SoronkoStepper
```
```
- Check Steppers Completed
```
```
- Add Description Data to SoronkoStepper
```
private val descriptionData = arrayOf("Details", "Status", "Photo", "Confirm", "Done")
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(your_layout)
mStepper = findViewById(R.id.soronko_stepper)
mStepper.descriptionData = descriptionData
}
```
- Add Custom Font to Stepper Items and Stepper Description Data
```
private val descriptionData = arrayOf("Details", "Status", "Photo", "Confirm", "Done")
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(your_layout)
mStepper = findViewById(R.id.soronko_stepper)
mStepper.descriptionData = descriptionData
mStepper.stepperNumberTypeface = "fonts/RobotoSlab-Light.ttf"
mStepper.stepperDescriptionTypeface = "fonts/RobotoSlab-Light.ttf"
}
```
- Change Colors (Stepper Background , Stepper Foreground, Stepper Number Background ,Stepper Number Foreground, Current Stepper Description, Stepper Description)
```
```
- Change Dimensions (Stepper, Stepper Number and Stepper Description sizes)
```
```
- Add Multiline Description Data to SoronkoStepper
```
private val descriptionData = arrayOf("Details\nPlace", "Status\nPrice", "Photo\nShoot", "Confirm\nResponse", "Buy\nDone")
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(your_layout)
mStepper = findViewById(R.id.soronko_stepper)
mStepper.descriptionData = descriptionData
}
```
- Ellipsized Description Data
```
private val descriptionData4 = arrayOf("encyclopedia", "dictionaries", "bibliography", "librarian" ,"hostorian")
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(your_layout)
mStepper = findViewById(R.id.soronko_stepper)
mStepper.descriptionData = descriptionData
mStepper.descriptionTruncateEnd = true
}
```
## Developer
Kofi Gyan
([email protected]) Currently opened to android engineer positions(remote/relocation)
## License
Copyright 2016 Kofi Gyan.
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.