https://github.com/MackHartley/DashedView
Easily create views with a background of repeating dashes 🐝
https://github.com/MackHartley/DashedView
android android-library dashed rounded-corners view
Last synced: 26 days ago
JSON representation
Easily create views with a background of repeating dashes 🐝
- Host: GitHub
- URL: https://github.com/MackHartley/DashedView
- Owner: MackHartley
- License: apache-2.0
- Created: 2021-05-15T03:34:09.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-28T23:56:42.000Z (over 1 year ago)
- Last Synced: 2024-11-18T05:38:07.398Z (7 months ago)
- Topics: android, android-library, dashed, rounded-corners, view
- Language: Kotlin
- Homepage:
- Size: 278 KB
- Stars: 69
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-android-ui - DashedView - 2.0) | <img src="https://user-images.githubusercontent.com/10659285/119430672-cccde180-bcd6-11eb-8c70-9342ae486944.png" width="50%"> (Index)
- fucking-awesome-android-ui - DashedView - 2.0) | <img src="https://user-images.githubusercontent.com/10659285/119430672-cccde180-bcd6-11eb-8c70-9342ae486944.png" width="50%"> (Index)
- fucking-awesome-android-ui - DashedView - 2.0) | <img src="https://user-images.githubusercontent.com/10659285/119430672-cccde180-bcd6-11eb-8c70-9342ae486944.png" width="50%"> (Index)
README
DashedView
The easiest way to create a dashed or striped background on Android
The `DashedView` library allows you to create views with a dashed (or striped) background. Below are some examples of views created with this library. You can click on any example to see its code.
There is also a demo app for this library which allows you to see the look and feel of the `DashedView` on your own device:
Quick Start Guide
If you don't have this already, add it to your **root** build.gradle file:
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
Then you can add the dependency to your **app** build.gradle file:
```
dependencies {
...
implementation 'com.github.MackHartley:DashedView:1.0.0'
}
```
Once that's finished you can declare a `DashedView` via XML:
```
```
Usage ⚙️
The table below explains the 5 XML attributes you can set on the `DashedView` class:
| XML Attribute | Use |
|---|---|
| `dvDashAngle` | Sets the angle of the dashes. The angle is measured from the X axis of the view. |
| `dvDashColor` | Sets the color of the dashes. |
| `dvDashWidth` | Sets the width of the dashes. |
| `dvSpaceBetweenDashes` | Sets the width of the space between each dash. |
| `dvViewCornerRadius` | Sets the corner radius value for the `DashedView`. Useful when working with other views that have rounded corners. |
The `DashedView` also has a public method that allows you to set custom coloring for individual dashes:
| Public Method | Use |
|---|---|
| `setDashColorGenerator(...)` | This method takes a `DashColorGenerator` instance as a parameter which gives you access to the index of the current dash being drawn. Using that information you can specify logic for how each dash should be colored. |
```
interface DashColorGenerator {
@ColorInt fun getPaintColor(curIndex: Int, numDashes: Int): Int
}
```
To see an example of the `DashColorGenerator` click here.
More Examples 🖼️
Click on any example to see it's code (You also need to look at MainActivity which sets custom dash coloring)
# Contributing 🤝
Feel free to open issues on this repo to report bugs or request features. Additionally if you'd like to contribute you can create a pull request (make sure to read contributing.mk).
**Special thanks to all those who have supported this repo thus far!**
# License 📄
```
Copyright 2021 Mack Hartley
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.
```