Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
kareemradwan committed Jul 1, 2020
2 parents 0819deb + 8b44a0a commit 22a70aa
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Stepper-Library V0.2

## Screenshots
![Image Result](https://scontent.fgza6-1.fna.fbcdn.net/v/t1.0-9/106503813_693000678211700_2733733955416928403_n.jpg?_nc_cat=102&_nc_sid=07e735&_nc_ohc=4NiB_Ur8XbAAX9iQAH0&_nc_ht=scontent.fgza6-1.fna&oh=9c30aefb155035a8e040691afc145f9c&oe=5F22F65B)
![Image Result](https://media.giphy.com/media/f6micojJP1dpgwnB3E/giphy.gif)
## How Add Library To Your Project
##### in `build.gradle` on Project Level you should add
in `build.gradle` on Project Level you should add

``` kotlin
allprojects {
Expand All @@ -12,37 +12,39 @@ allprojects {
}
}
```
##### After Thet add `implementation 'com.github.kareemradwan:Stepper-Library:0.2'` in `build.gradle` in App Level
##### in `dependencies` Tag

After Thet add Library in `build.gradle` in App Level
in `dependencies` Tag

``` kotlin
implementation 'com.github.kareemradwan:Stepper-Library:0.3'
```

## How Library Work

##### We Need Create Step Class for Example `Order` and `OrderAdapter`
##### The Class `Order` Must Be Implements Interface `IStep` and Implementaion Require Method `isChecked()`
##### The Class `OrderAdapter` must be inherited class `StepAdapter` with Generic Type `Order`
##### The Class `OrderAdapter` Require List of Any Class Implements Interface `IStep` in Our Example `Order`
## How Library Work
We Need Create Step Class for Example `Order` and `OrderAdapter`
The Class `Order` Must Be Implements Interface `IStep` and Implementaion Require Method `isChecked()`
The Class `OrderAdapter` must be inherited class `StepAdapter` with Generic Type `Order`
The Class `OrderAdapter` Require List of Any Class Implements Interface `IStep` in Our Example `Order`

`
StepAdapter<Order>(list)
`

##### In `OrderAdapter` We Should Override `onCreateView` Method
##### The Method `onCreateView` take a Model of `Order` and Sould be Return `View`

##### After Adapter Ready You Can Assign Adapter For `SteeperView`

##### You can Register The Activity as Controller to Notifiy When `SteeoerView` Finish ( in Last Step )
In `OrderAdapter` We Should Override `onCreateView` Method
The Method `onCreateView` take a Model of `Order` and Sould be Return `View`
After Adapter Ready You Can Assign Adapter For `SteeperView`
You can Register The Activity as Controller to Notifiy When `SteeoerView` Finish ( in Last Step )



## What is Next:
##### - The Developer Can Custmise Color of Step. (DONE)
##### - Add Animation for `CheckBox` When be Selected
- The Developer Can Custmise Color of Step. (DONE)
- Add Animation for `CheckBox` When be Selected


## Sample Code
#### In Xml
In Xml
```xml
<com.kradwan.stepeer.view.SteeperView
android:id="@+id/steeper"
Expand All @@ -53,7 +55,7 @@ StepAdapter<Order>(list)
android:layout_height="wrap_content" />

```
#### In Kotlin
In Kotlin
```kotlin
val mList = listOf(
Order(1, "Step1", true),
Expand All @@ -71,6 +73,6 @@ val mList = listOf(


## About Developer:
##### Name: Kareem E Radwan
##### Email: [email protected]
Name: Kareem E Radwan
Email: [email protected]

0 comments on commit 22a70aa

Please sign in to comment.