Material Shadow 9-Patch
This library provides 9-patch based drop shadow for view elements. Works on API level 9 or later.
Target platforms
- API level 9 or later
Latest version
- Version 0.6.5 (Oct. 20, 2015)
Getting started
This library is published on jCenter. Just add these lines to build.gradle.
dependencies {
compile 'com.h6ah4i.android.materialshadowninepatch:materialshadowninepatch:0.6.5'
}
Usage
Layout XML
<com.h6ah4i.android.materialshadowninepatch.MaterialShadowContainerView
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
style="@style/ms9_DefaultShadowStyle"
android:id="@+id/shadow_item_container"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:ms9_shadowTranslationZ="2dp"
app:ms9_shadowElevation="4dp">
<!-- NOTE 1: only 1 child can be accepted -->
<!-- NOTE 2: margins are required to draw shadow properly -->
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="8dp"
android:layout_marginTop="8dp"
android:layout_marginRight="8dp"
android:layout_marginBottom="8dp"
android:background="@android:color/white"
android:text="Inner content view" /> </com.h6ah4i.android.materialshadowninepatch.MaterialShadowContainerView>Java code
MaterialShadowContainerView shadowView =
(MaterialShadowContainerView) findViewById(R.id.shadow_item_container);
float density = getResources().getDisplayMetrics().density; shadowView.setShadowTranslationZ(density * 2.0f);
// 2.0 dp shadowView.setShadowElevation(density * 4.0f);
// 4.0 dpAdvanced Usages
<com.h6ah4i.android.materialshadowninepatch.MaterialShadowContainerView
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
style="@style/ms9_DefaultShadowStyle"
android:id="@+id/shadow_item_container"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
app:ms9_shadowTranslationZ="2dp"
app:ms9_shadowElevation="4dp"
app:ms9_useAmbientShadow="true"
app:ms9_useSpotShadow="true"
app:ms9_forceUseCompatShadow="true"
app:ms9_affectsDisplayedPosition="true"
app:ms9_spotShadowDrawablesList="@array/ms9_spot_shadow_drawables_z18"
app:ms9_ambientShadowDrawablesList="@array/ms9_ambient_shadow_drawables_z18">
... </com.h6ah4i.android.materialshadowninepatch.MaterialShadowContainerView>| Property name | Default | Description |
|---|---|---|
ms9_shadowTranslationZ | 0dp | Compatibility version of android:translationZ |
ms9_shadowElevation | 0dp | Compatibility version of android:elevation |
ms9_forceUseCompatShadow | false | Enforces to use compatibility shadow on Lollipop or later |
ms9_affectsDisplayedPosition | true | Specify whether the shadow position is affected by the target view's position (emulates Lollipop's behavior) |
app:ms9_useAmbientShadow | true | Specify whether to use ambient shadow |
app:ms9_useSpotShadow | true | Specify whether to use spot shadow |
ms9_spotShadowDrawablesList | @array/ms9_spot_shadow_drawables | Specify Spot shadow (Key shadow) 9-patch resources |
ms9_ambientShadowDrawablesList | @array/ms9_ambient_shadow_drawables | Specify Ambient shadow 9-patch resources |
| Style name | |
|---|---|
ms9_DefaultShadowStyle([ Z6 or Z9 orZ18 ]) | Default style (uses spot & ambient shadow, position affects) |
ms9_DefaultShadowStyle([ Z6 or Z9 or Z18 ])CompatOnly | Default style with ms9_forceUseCompatShadow="true" |
ms9_NoDisplayedPositionAffectShadowStyle([ Z6 or Z9 or Z18 ]) | No displayed position affects style |
ms9_NoDisplayedPositionAffectShadowStyle([ Z6 or Z9 or Z18 ])CompatOnly | No displayed position affects style with ms9_forceUseCompatShadow="true" |
ms9_CompositeShadowStyle([ Z6 or Z9 ]) | Pre-composite shadow style ( less overdraws) |
ms9_CompositeShadowStyle([ Z6 or Z9 ])CompatOnly | Pre-composite shadow style with ms9_forceUseCompatShadow="true" |
NOTE: You can specify Z[6|9|18] suffix for style names. This limits the deepest limit of shadow nine patch resources and it makes resource shrinking ( shrinkResources true) work more effectively!
License
This library is licensed under the Apache Software License, Version 2.0.
See LICENSE for full of the license text.
Copyright (C) 2015 Haruki Hasegawa 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.