Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kennyc1012/MultiStateView
Android View that displays different content based on its state
https://github.com/Kennyc1012/MultiStateView
Last synced: 3 months ago
JSON representation
Android View that displays different content based on its state
- Host: GitHub
- URL: https://github.com/Kennyc1012/MultiStateView
- Owner: Kennyc1012
- Created: 2015-04-21T22:19:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-02-13T14:21:40.000Z (almost 4 years ago)
- Last Synced: 2024-10-03T21:37:05.086Z (3 months ago)
- Language: Kotlin
- Size: 302 KB
- Stars: 1,224
- Watchers: 39
- Forks: 177
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-kotlin - MultiStateView - Android View that displays different content based on its state (Libraries)
- awesome-github-android-ui - MultiStateView - 基于状态显示不同内容的Android视图 (空白页)
README
# MultiStateView
[](http://android-arsenal.com/details/1/1726)
Android View that displays different content based on its state.
Based off of [MeetMe/MultiStateView](https://github.com/MeetMe/Android-MultiStateView)
The four different states the view can be in are:
- Content
- Empty
- Error
- Loading
# Using MultiStateView
MultiStateView can be used the same as any other view by adding it as a layout file via XML
```xml
```
The attributes to set for MultiStateView are
```xml
```
`msv_loadingView` is the view to be used for `VIEW_STATE_LOADING`
`msv_emptyView` is the view to be used for `VIEW_STATE_EMPTY`
`msv_errorView` is the view to be used for `VIEW_STATE_ERROR`
`msv_viewState` is the [ViewState](https://github.com/Kennyc1012/MultiStateView/blob/master/library/src/main/java/com/kennyc/view/MultiStateView.kt#L34) for the MultiStateView
`msv_animateViewChanges` is a flag to set whether the views should animate in and out when switching states. `false` by default
`VIEW_STATE_CONTENT` is determined by whatever is inside of the tags via XML. NOTE a Content view must be set for the view to function, this is by design.
To switch the state of MultiStateView, simply call
```kotlin
multiStateView.viewState = state: ViewState
```
or in java
```java
multiStateView.setViewState(@NonNull ViewState state)
```
You can also get the View for the accompanying ViewState by calling
```kotlin
multiStateView.getView(state: ViewState):View?
```
or in java
```java
@Nullable
public View getView(@NonNull ViewState state)
```
# Including in your project
To include MultiStateView in your project, make the following changes to your build.gradle file
## Add repository
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
```
## Add dependency
```groovy
dependencies {
implementation 'com.github.Kennyc1012:MultiStateView:2.2.0'
}
```
# Contribution
Pull requests are welcomed and encouraged. If you experience any bugs, please file an [issue](https://github.com/Kennyc1012/MultiStateView/issues)
License
=======
Copyright 2015 Kenny Campagna
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.