https://github.com/comcast/blueprint
Blueprint is a compact framework for constructing mvp architecture within a scrollable, multi-view-type list UI. It uses the Android RecyclerView library, and currently only supports LinearLayouts
https://github.com/comcast/blueprint
android recyclerview
Last synced: 3 months ago
JSON representation
Blueprint is a compact framework for constructing mvp architecture within a scrollable, multi-view-type list UI. It uses the Android RecyclerView library, and currently only supports LinearLayouts
- Host: GitHub
- URL: https://github.com/comcast/blueprint
- Owner: Comcast
- License: apache-2.0
- Created: 2017-09-11T14:53:42.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T19:40:46.000Z (almost 3 years ago)
- Last Synced: 2025-04-11T21:08:15.527Z (about 1 year ago)
- Topics: android, recyclerview
- Language: Kotlin
- Homepage:
- Size: 735 KB
- Stars: 21
- Watchers: 15
- Forks: 15
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
[![Maven Central][mavenbadge-svg]][mavencentral]
# Blueprint
Blueprint is a library that provides a compact framework for constructing mvp architecture within a multi-view type recycling, scrollable
list UI. It uses the Android RecyclerView library, and currently only support LinearLayouts
## Design
### Presenter
There are two presentation layers, the ScreenPresenter, and the ComponentViewPresenter. The ScreenPresenter is repsonsible for creating two things : the list of
view types the screen will show (in the correct order), and a map of ComponentViewPresenters, one for each
view type in the list
### View
There are, analogously, two view layers, the ScreenView and the ComponentViews. The ScreenView's only responsibility is
adding and holding the component view types specified by the ScreenPresenter. A ScreenViewDelegate is provided as a default
implementation. The ScreenViewDelegate also contains a convenience function for instantiating the Adapter. ComponentViews are POJOs
representing the views of the different components. ComponentViews are
### ComponentRegistry
Each Component should have a view class that implements ComponentView. The concrete ComponentViews must be registered with
a ComponentRegistry that maps ComponentView classes with view types. Optionally, clients can also mark presenters with the
annotation @DefaultPresenter, and pass the annotation a ComponentView class to be associated with. ScreenPresenters then only
need to specify presenters in the presenterMap if they wish to override the default.
### Adapter
The ComponentAdapter is a RecyclerView Adapter that delegates presentation of each item to the appropriate ComponentViewPresenter,
based on the view type. To create one, you need a list of view types in order, and a map of ComponentViewPresenters to view types
with which to present each view. in onCreateViewHolder, the Adapter queries the ComponentRegistry and instantiates a concrete
ComponentView class for the view type, and holds that instance in a List. Then, in onBindViewHolder, the adapter gets the ComponentView class
at the bind position, retrieves the ComponentViewPresenter for that ComponentView's view type, and asks the presenter to
present the data for that bind position into that ComponentView.
### Setup
To use Blueprint, in your project build.gradle add
```xml
compile 'com.xfinity:blueprint-library:'
compile 'com.xfinity:blueprint-annotations:'
```
and either
```xml
annotationProcessor "com.xfinity:blueprint-compiler:"
```
or, if you're using kotlin,
```xml
kapt "com.xfinity:blueprint-compiler:"
```
[mavenbadge-svg]: https://maven-badges.herokuapp.com/maven-central/com.xfinity/blueprint-library/badge.svg
[mavencentral]: https://search.maven.org/artifact/com.xfinity/blueprint-library
### Usage
#### Creating Components
After creating your layout, create a view holder class and annotate with @ComponentViewHolder(viewType = R.layout.layout_name)
Next, create a view class and annotate it with @ComponentViewClass(viewHolderClass = yourViewHolderClass). Blueprint will generate a base class for you, based on your viewholder. If your view class is call MyComponentView, then the generated base class will be called MyComponentViewBase. This class will have auto-generated view control methods, and auto-generated view-holder creation and bind methods. Your view class should extend from your base class, e.g.
```java
MyComponentView extends MyComponentViewBase
```
The base class will be generated the first time you compile after creating the view class.
Finally, if you have a model that you wish to use in the component, you can simply extend from ComponentModel. To create your component presenter, you need to extend from ComponentPresenter by passing view and model as Type parameters.
At this point, the your component presenter should give you the view and model with present(view, model) method.
To display this component, simply add to your screenView in any of your screen presenter.