capsule

1.1.1indexed

Compose library enhances user interfaces with smooth, continuous rounded shapes like rectangles and capsules, offering efficient Bézier curve calculations to optimize performance, even during animations.

AndroidJSJVMNativeWasm·xfqwdsj/capsule

Stars

—

Used by

dependents

—

Health

/ 100

Capsule

Maven Central Version

A Compose Multiplatform library that provides smooth rounded corner shapes.

Getting Started

To use capsule in your Kotlin Multiplatform project, add the following dependency to your build.gradle.kts file:

dependencies {
    implementation("top.ltfan.capsule:capsule:<version>")
}

Or if you are using Gradle Version Catalogs, add the following to your gradle/libs.versions.toml:

[versions]
capsule = "<version>"

[libraries]
capsule = { module = "top.ltfan.capsule:capsule", version.ref = "capsule" }

Make sure your settings.gradle.kts includes the repository:

dependencyResolutionManagement {
    repositories {
        mavenCentral()
    }
}

Usages

Replace the RoundedCornerShape with ContinuousRoundedRectangle or ContinuousCapsule:

// create a basic rounded corner shape
ContinuousRoundedRectangle(16.dp)

// create a capsule shape
ContinuousCapsule

Custom continuity:

val g1 = G1Continuity // no corner smoothness
val g2 = G2Continuity(
    profile = G2ContinuityProfile.RoundedRectangle.copy(
        extendedFraction = 0.5,
        arcFraction = 0.5,
        bezierCurvatureScale = 1.1,
        arcCurvatureScale = 1.1
    ),
    capsuleProfile = G2ContinuityProfile.Capsule.copy(
        extendedFraction = 0.5,
        arcFraction = 0.25
    )
)

// create shapes with custom continuity
ContinuousRoundedRectangle(16.dp, continuity = g2)
ContinuousCapsule(continuity = g2)

The following parameters are supported by G2ContinuityProfile:

Extended fraction: the transition length between original corner and line, relative to the corner radius
Arc fraction: the ratio of the arc to the corner
Bezier curvature scale: the multiplier of the end curvature of the Bézier curve
Arc curvature scale: the multiplier of the arc curvature

Note: It guarantees G1 continuity at least. Only if the Bezier curvature scale equals the arc curvature scale, it will have exact G2 continuity.

Performance

Drawing cubic Bézier curves on Android performs poorly. However, the Capsule library uses a very efficient method to calculate the control points, achieving optimal theoretical performance.

When the shape area is large (almost fullscreen) and the corner radius is constantly changing, performance may decrease. Use animatedShape.copy(continuity = G1Continuity) to temporarily disable corner smoothing during the animation.