Skip to content

Commit

Permalink
Initial Release.
Browse files Browse the repository at this point in the history
  • Loading branch information
jdsdhp authored and jsaura committed Sep 8, 2020
0 parents commit 7fdec04
Show file tree
Hide file tree
Showing 72 changed files with 2,375 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
*.iml
.gradle
/local.properties
/.idea/caches
/.idea/libraries
/.idea/modules.xml
/.idea/workspace.xml
/.idea/navEditor.xml
/.idea/assetWizardSettings.xml
.DS_Store
/build
/captures
.externalNativeBuild
.cxx
1 change: 1 addition & 0 deletions .idea/.name

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

138 changes: 138 additions & 0 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions .idea/codeStyles/codeStyleConfig.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/copyright/jesusd0897.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions .idea/copyright/profiles_settings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/dictionaries/jesusd0897.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions .idea/gradle.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

30 changes: 30 additions & 0 deletions .idea/jarRepositories.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/runConfigurations.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Change Log
==========
Version 0.1.1 *(2020-08-04)*
----------------------------
Change visibility of util classes to internal.

Version 0.1.0 *(2020-07-17)*
----------------------------
Initial release.

13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright (c) 2020 jesusd0897.

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.
90 changes: 90 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
Pictish
=======

An Android component to display image preloading, with the possibility of manual downloading, automatic cache processing and transformation with a Blur effect.

[![JitPack](https://jitpack.io/v/jdsdhp/pictish.svg)](https://jitpack.io/#jdsdhp/pictish)
[![API](https://img.shields.io/badge/API-17%2B-red.svg?style=flat)](https://android-arsenal.com/api?level=17)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/jdsdhp/pictish/blob/master/LICENSE)
[![Twitter](https://img.shields.io/badge/[email protected])](https://twitter.com/jdsdhp)

## Screenshots
Idle State | Loading State | Loaded State
:-:|:-:|:-:
![](art/art-01.jpg) | ![](art/art-02.jpg) | ![](art/art-03.jpg)

## Including in your project

#### Gradle

```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
dependencies {
implementation 'com.github.jdsdhp:pictish:$version'
}
```

## Usage

### Kotlin
Simple Usage from Activity or Fragment. Images in this example have been loaded from [Lorem Picsum](https://picsum.photos).
```kotlin
val id = 100

val imageDownloadView: ImageViewDownloader = findViewById(R.id.image_view_downloader)
imageDownloadView.preLoad(
thumbUrl = "https://picsum.photos/id/$id/50",
fullUrl = "https://picsum.photos/id/$id/1000"
)
```
### XML
Adding the component in layout file.
```xml
<com.jesusd0897.pictish.ImageViewDownloader
android:id="@+id/image_view_downloader"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:ivd_image_border_radius="16dp" />
```

### Styling
For styling colors and shapes.
```xml
<style name="AppTheme" parent="Theme.MaterialComponents.Light.NoActionBar">
<!-- Your app style here...... -->

<item name="colorPictishProgress">#00695C</item>
<item name="colorPictishIconStatus">#FFFFFF</item>
<item name="colorPictishDefaultPlaceholder">#B3B3B3</item>
<item name="colorPictishControlNormal">#FFFFFF</item>
<item name="colorPictishControlSoft">#80FFFFFF</item>
</style>
```

## Sample project

It's very important to check out the sample app. Most techniques that you would want to implement are already implemented in the examples.

View the sample app's source code [here](https://github.com/jdsdhp/pictish/tree/master/app)

License
=======

Copyright (c) 2020 jesusd0897.

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.
Loading

0 comments on commit 7fdec04

Please sign in to comment.