Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jelic98/dynamico
Android library for inflating dynamic layouts in runtime based on JSON configuration fetched from server
https://github.com/jelic98/dynamico
Last synced: 5 days ago
JSON representation
Android library for inflating dynamic layouts in runtime based on JSON configuration fetched from server
- Host: GitHub
- URL: https://github.com/jelic98/dynamico
- Owner: jelic98
- License: apache-2.0
- Created: 2018-04-07T00:26:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-11-20T10:50:21.000Z (almost 4 years ago)
- Last Synced: 2024-07-24T05:46:04.748Z (3 months ago)
- Language: Java
- Size: 237 KB
- Stars: 46
- Watchers: 6
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-android - Dynamico - Android library for inflating dynamic layouts in runtime based on JSON configuration fetched from server. (Uncategorized / Uncategorized)
README
[](https://opensource.org/licenses/Apache-2.0)
[](https://jitpack.io/#jelic98/dynamico)
[](https://android-arsenal.com/api?level=19)
[]( https://android-arsenal.com/details/1/6926)
# Dynamico
Android library for inflating dynamic layouts in runtime based on JSON configuration fetched from server. Useful in situations when layouts need to change without updating the app.
## Advanced features
* Targeting specific devices by brand, model and Android API version
* Layout changes based on configuration fields
## Installing
1. Add repository in root ```build.gradle```
```gradle
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
2. Add the dependency
```gradle
dependencies {
compile 'com.github.jelic98:dynamico:1.2.0'
}
```
## Usage
1. Create JSON layout and upload it somewhere
```json
{
"views":[
{
"class":"android.widget.ImageView",
"attributes":{
"layout_width":"wrap_content",
"layout_height":"wrap_content",
"src":"https://lazarjelic.com/ecloga/projects/dynamico/logo.png",
"cache":true
}
},
{
"class":"android.widget.TextView",
"attributes":{
"text":"Yo!",
"textColor":"#FF69B4"
}
}
]
}
```
2. Create XML wrapper layout that will contain loaded views
```xml
```
3. Initialize Dynamico by passing it:
* URL = Link to JSON layout **directory**
* name = Name of JSON layout **file**
* layout = Wrapper layout that will contain loaded views
```java
new Dynamico("https://lazarjelic.com/ecloga/projects/dynamico",
"activity_main",
findViewById(R.id.mainLayout))
.initialize();
```
## Manual
For advanced usage, take a look at this awesome [manual](https://github.com/jelic98/dynamico/blob/master/MANUAL.md).
## Additional features
* Event listener
```java
setListener(new LayoutStateListener() {
@Override
public void onSuccess(String message) {
// everything is okay
}
@Override
public void onError(String message) {
// notify user
}
})
```
* Loading from cache (skip layout fetching from server)
```java
setOptions(CACHE_ONLY)
```
* Non-stop layout fetching
```java
setOptions(NON_STOP) // use with setAsyncPause(long millis)
```
## Documentation
###### `public Dynamico(String url, String name, ViewGroup layout) throws DynamicoException`
One and only constructor
* **Parameters:**
* `url` — URL of directory where JSON layout file is located (for example, "https://lazarjelic.com/ecloga/projects/dynamico")
* `name` — JSON layout file name with or without extension (for example, "activity_main")
* `layout` — wrapper layout that will contain inflated layout from JSON file (for example, findViewById(R.id.mainLayout))
* **Exceptions:** `DynamicoException` — if any of passed parameters is null
###### `public Dynamico setListener(DynamicoListener listener)`
Attaches event listener to Dynamico object
* **Parameters:** `listener` — listener for success and error events caused by network, storage, etc.
* **Returns:** Dynamico object ready for initialization
###### `public Dynamico setOptions(DynamicoOptions.Option ... options)`
Attaches options to Dynamico object
* **Parameters:** `options` — options for Dynamico (for example, ONLY_CACHE)
* **Returns:** Dynamico object ready for initialization
###### `public void initialize()`
Starts layout fetching from cache/server depending on provided options
## TODO
* Support vector drawables
* Support more views