Skip to content

Easily create views with a background of repeating dashes ๐Ÿ

License

Notifications You must be signed in to change notification settings

MackHartley/DashedView

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

76 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

DashedView

The easiest way to create a dashed or striped background on Android

ktlint Featured in Android Weekly

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.

Screen Shot 2021-05-21 at 11 42 53 PM Screen Shot 2021-05-21 at 11 42 18 PM
card1 card2

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:

Get it on Google Play

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:

<com.mackhartley.dashedview.DashedView
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:dvDashAngle="45"
    app:dvDashColor="#777"
    app:dvDashWidth="4dp"
    app:dvSpaceBetweenDashes="4dp"
    app:dvViewCornerRadius="0dp" />

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)

heropic hero2 Screen Shot 2021-05-21 at 11 44 19 PM Screen Shot 2021-05-23 at 3 48 04 PM
Screen Shot 2021-05-23 at 3 47 38 PM

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.