Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.81 KB

README.md

File metadata and controls

61 lines (46 loc) · 2.81 KB
Raw

SmoothRoundedCornerShape

Introduction

Kotlin Multiplatform library for Compose that provides SmoothRoundedCornerShape -- which works just like RoundedCornerShape, but takes an additional smoothing parameter, which provides smoothed superellipse corners.

The smoothing value approximately maps to Figma's corner smoothing setting as a fraction, for example smoothing: 0.6f is roughly equivalent to Figma's Corner smoothing: 60%

AbsoluteSmoothRoundedCornerShape and Path.smoothRoundedRectangle are also provided.

There is no path/smoothing logic contained in this library, it's just a lightweight wrapper around androidx.graphics.shapes, which is a non-compose library.

What is a smoothed corner?

A smoothed (superellipse) corner is a shape with no point where the corner ends and the straight side begins. You'll see this kind of shape everywhere in iOS, as well as in physical products, as its more aesthetically pleasing than a naive corner radius, which can appear to have a harsh transition from corner to edge. squircle (image from react-native-figma-squircle)

Figma's Daniel Furse explains the concept and the math in some extreme detail

Installation

Ensure your project is using the maven central repository:

repositories {
    mavenCentral()
}

Then add as a module dependency:

dependencies {
    implementation("io.github.iamcalledrob:smoothRoundedCornerShape:1.0.4")
}

Usage

Use in place of RoundedCornerShape and AbsoluteRoundedCornerShape for example:

// SmoothRoundedCornerShape
SmoothRoundedCornerShape(smoothing = 0.6f, radius = 10.dp)
SmoothRoundedCornerShape(smoothing = 0.6f, percent = 25)
SmoothRoundedCornerShape(smoothing = 0.6f, topStart = 10.dp, topEnd = 5.dp, bottomEnd = 0.dp, bottomStart = 20.dp)
SmoothRoundedCornerShape(smoothing = 0.6f, topStartPercent = 10, topEndPercent = 5, bottomEndPercent = 0, bottomStartPercent = 20)

// AbsoluteSmoothRoundedCornerShape
AbsoluteSmoothRoundedCornerShape(smoothing = 0.6f, topLeft = 10.dp, topRight = 5.dp, bottomRight = 0.dp, bottomLeft = 20.dp)
AbsoluteSmoothRoundedCornerShape(smoothing = 0.6f, topLeftPercent = 10, topRightPercent = 5, bottomRightPercent = 0, bottomLeftPercent = 20)

// Path.smoothRoundedRectangle
Path.smoothRoundedRectangle(smoothing = 0.6f, size = Size(100f, 50f), topLeft = 10f, topRight = 5f, bottomRight = 0f, bottomLeft = 20f)

Notes

Currently only builds desktop (jvm) and android targets, since androidx.graphics.shapes only supports those targets. Feel free to make a PR for other platforms if they become supported.