Repository files navigation

Synth is CRED's inbuilt library for using Neumorphic components in your app.

What really is Neumorphism? It's an impressionistic style, playing with light, shadow, and depth to create a digital experience inspired by the physical world. That's the definition anyway. Our recommendation is you try it out to see what you make of it. If you do create something with Synth, let us know. We're excited to see where you take it.

A note for the curious: if you wish to learn more about Synth, we have a post detailing the concept and CRED's philosophy behind ithere.

For iOS, checkoutSynth-iOS

You can install synth by adding this to your build.gradle file:

dependencies {  implementation 'club.cred.android:synth:1.0.0'}

To use synth, the parent layout which contains the synth views must specify:

android:clipChildren="false"

Synth renders neumorphic components only on devices running API 28 (Pie) or later. This is because Synth internally usesBlurMaskFilter to render shadows and highlights which are drawn outside of the view bounds — this allows you to align Synth views with other views easily.

The issue below API 28, is, to makeBlurMaskFilter work, we need to usehardware acceleration on the view which causes the shadows and highlights to be clipped. We could solve for this by adding padding to the views (similar to how CardView does it) but chose not to because of alignment issues.

In lieu of this, we decided to introduce "compat" version of all our views which render a simple single colored background on the view on devices below API 28.

Soft button renders the elevated neumorphic platform on which the text is drawn. this elevated platform can be customized in two ways:

1. By specifying a color for the platform, synth will attempt to compute the light and dark shadow colors

<club.cred.synth.views.SynthButtonapp:neuButtonType="elevated_soft"app:neuPlatformColor="@color/button_platform_color"    ... />

2. By specifying a complete appearance for all aspects of the elevated platform

<club.cred.synth.views.SynthButtonapp:neuButtonType="elevated_soft"    ... />    <stylename="button_platform_appearance">    <itemname="neuLightShadowColor">...</item>    <itemname="neuDarkShadowColor">...</item>    <itemname="neuFillStartColor">...</item>    <itemname="neuFillEndColor">...</item>    <itemname="neuFillPressedStartColor">...</item>    <itemname="neuFillPressedEndColor">...</item>    <itemname="neuBorderStartColor">...</item>    <itemname="neuBorderEndColor">...</item>    <itemname="neuBorderPressedStartColor">...</item>    <itemname="neuBorderPressedEndColor">...</item></style>

Flat button renders a flat surface on top of the elevated neumorphic platform. This flat surface can be customized in two ways:

1. By specifying a color for the surface, synth will attempt to compute the gradients, borders, etc of the surface

<club.cred.synth.views.SynthButtonapp:neuButtonType="elevated_flat"app:neuFlatButtonColor="@colo/button_surface_color"app:neuPlatformAppearance="@style/button_platform_appearance"     ... />

2. By specifying a complete appearance for all aspects of the flat surface

<club.cred.synth.views.SynthButtonapp:neuButtonType="elevated_flat"app:neuFlatButtonAppearance="@style/button_flat_appearance"app:neuPlatformAppearance="@style/button_platform_appearance"     ... />    <stylename="button_flat_appearance">    <itemname="neuButtonStartColor">...</item>    <itemname="neuButtonEndColor">...</item>    <itemname="neuButtonBorder1StartColor">...</item>    <itemname="neuButtonBorder1EndColor">...</item>    <itemname="neuButtonBorder2StartColor">...</item>    <itemname="neuButtonBorder2EndColor">...</item>    <itemname="neuButtonPressedDarkShadowColor">...</item></style>

Image button is simply an image view with a neumorphic platform

<club.cred.synth.views.SynthImageButtonapp:neuButtonType="elevated_soft"app:srcCompat="@drawable/ic_chevron_left"    ... />

You can add a drawable to a button (to the left of the text). Synth will render a neumorphic pit on which the drawable is rendered. This pit can be customized in two ways:

1. By not specifying anything, synth will take either theneuPlatformColor (if it's a soft button) orneuFlatButtonColor (if it's a flat button) and compute the gradient colors and pressed colors.

<club.cred.synth.views.SynthButtonapp:neuButtonType="elevated_soft"app:neuButtonDrawable="@drawable/ic_plus"app:neuButtonDrawablePitRadius="20dp"app:neuPlatformColor="@color/button_platform_color"    .. or ..app:neuFlatButtonColor="@color/button_surface_color"    ... />

2. By specifying a complete appearance for all aspects of the icon pit

<club.cred.synth.views.SynthButtonapp:neuButtonType="elevated_flat"app:neuButtonDrawable="@drawable/ic_plus"app:neuButtonDrawablePitRadius="20dp"app:neuButtonIconAppearance="@style/button_icon_appearance"    ... />    <stylename="button_icon_appearance">    <itemname="neuFillStartColor">...</item>    <itemname="neuFillEndColor">...</item>    <itemname="neuFillPressedStartColor">...</item>    <itemname="neuFillPressedEndColor">...</item>    <itemname="neuButtonCompatColor">...</item></style>

• PitView andElevatedView are simple Views that can be used to simulate a debossed or embossed neumorphic platform
• They are not ViewGroups so ideally they can be used in aConstraintLayout with other Views that are constrained to thePitView orElevatedView.
• To use these freely with your views,PitDrawable andElevatedDrawable can be set as background for your Views programmatically.

PitView shadows can be specified in two ways:

1. By specifying a color for the pit, synth will attempt to compute the shadows of the pit

<club.cred.synth.views.PitViewapp:pitColor="@color/pit_color"app:neuCornerRadius="14dp"  ... />

2. By specifying a complete appearance for all aspects of the pit

<club.cred.synth.views.PitViewapp:pitViewAppearance="@style/pit_view_appearance"app:neuCornerRadius="14dp"  ... />    <stylename="pit_view_appearance">    <itemname="neuLightShadowColor">...</item>    <itemname="neuDarkShadowColor">...</item>    <itemname="softEdgeColor">...</item>    <itemname="neuCompatColor">...</item></style>

ElevatedView internally uses the same neumorphic platform that is used to draw the buttons. To specify the appearance and shadows of theElevatedView, the same attributes of soft button can be used:

1. By specifyingapp:neuPlatformColor, synth will compute the shadows and gradients of the view.
2. By specifying the complete appearance usingapp:neuPlatformAppearance (same as soft button).

We support a minimum SDK of 21. But the neumorphic components will be rendered appropriately only on devices running SDK version 28 or above.

Pull requests are welcome! We'd love help improving this library. Feel free to browse through open issues to look for things that need work. If you have a feature request or bug, please open a new issue so we can track it.

Synth would not have been possible if not for the contributions made by CRED's design and frontend teams. Specifically:

• Rishab Singh Bisht —Twitter |Github |Linkedin
• Nikhil Panju —Twitter |Github |Linkedin
• Madhur Kapadia —Twitter |Github |Linkedin
• Siddharth Kumar —Twitter |Linkedin
• Hari Krishna

Copyright 2020 Dreamplug Technologies Private Limited.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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.