Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .editorconfig
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,13 @@ trim_trailing_whitespace = true
[*.{kt,kts}]
indent_size = 4
continuation_indent_size = 4
ktlint_code_style = ktlint_official
max_line_length = 140
ktlint_standard_max-line-length = disabled
ktlint_standard_function-signature = disabled
# Compose @Composable functions use PascalCase by convention.
ktlint_function_naming_ignore_when_annotated_with = Composable
ktlint_standard_function-naming = disabled

[*.{yml,yaml,json,md,xml}]
indent_size = 2
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
name: CI

on:
push:
branches: [main]
pull_request:
workflow_dispatch:

concurrency:
group: ci-${{ github.ref }}
cancel-in-progress: true

jobs:
quality:
name: Quality gates
runs-on: macos-latest
steps:
- name: Check out code
uses: actions/checkout@v4

- name: Set up JDK
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: 17

- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Spotless + Detekt + Kover
run: ./gradlew spotlessCheck detekt koverXmlReport koverVerify --stacktrace

build:
name: Build KMP targets
runs-on: macos-latest
Expand All@@ -32,3 +54,6 @@ jobs:

- name: Compile iOS sample
run: ./gradlew :sampleApp:compileKotlinIosSimulatorArm64 --stacktrace

- name: Validate Maven publication
run: ./gradlew publishToMavenLocal --stacktrace
50 changes: 50 additions & 0 deletions .github/workflows/docs.yml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
name: Deploy docs

on:
push:
branches: [main]
paths:
- 'website/**'
- '.github/workflows/docs.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: website
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
version: 10
- uses: actions/setup-node@v4
with:
node-version: 20
cache: pnpm
cache-dependency-path: website/pnpm-lock.yaml
- run: pnpm install --frozen-lockfile
- run: pnpm build
- uses: actions/upload-pages-artifact@v3
with:
path: website/out

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v5
20 changes: 16 additions & 4 deletions .github/workflows/publish.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,12 +2,15 @@ name: Publish

on:
release:
types: [released]
types: [published]
workflow_dispatch:

permissions:
contents: read

jobs:
publish:
name: Validate release publication
name: Publish to Maven Central
runs-on: macos-latest
steps:
- name: Check out code
Expand All@@ -22,5 +25,14 @@ jobs:
- name: Set up Gradle
uses: gradle/actions/setup-gradle@v4

- name: Build library publications
run: ./gradlew :liquidkit:publishAllPublicationsToLocalBuildRepository :liquidkit-navigation3:publishAllPublicationsToLocalBuildRepository --stacktrace
- name: Verify before publishing
run: ./gradlew spotlessCheck detekt koverXmlReport --stacktrace

- name: Publish and release to Maven Central
run: ./gradlew publishAndReleaseToMavenCentral --no-configuration-cache --stacktrace
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.SIGNING_KEY_ID }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,3 +4,6 @@
/*/build/
iosApp/DerivedData/
local.properties

.idea/
xcuserdata/
94 changes: 77 additions & 17 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,75 @@
# LiquidGlass
# LiquidKit

LiquidGlass is a Kotlin Multiplatform component kit for Liquid Glass-style UI.
LiquidKit is a Kotlin Multiplatform component kit for Liquid Glass-style UI.

Android renders with the vendored AndroidLiquidGlass engine. iOS renders with
native UIKit controls through Compose interop.
One shared Compose Multiplatform API; the rendering diverges per platform:

> Maven/module coordinates still use `liquidkit` until a deliberate breaking
> rename is made.
- **Android** renders the glass look in-Compose via an internal backdrop-capture
and refraction (Liquid Glass) shader engine.
- **iOS** wraps **genuine native UIKit controls** (`UISwitch`, `UIButton` glass
configuration, `UIMenu`, `UIPickerView`, `UITextField`, `UISearchTextField`,
`UIStepper`, `UINavigationBar`, `UIVisualEffectView`) so components get the
authentic system Liquid Glass on iOS 26, with a `UIBlurEffect` `systemMaterial`
fallback on earlier versions.

See [Architecture](#architecture) for details.

## Install

LiquidKit is published to Maven Central as `io.github.androidpoet`.

```kotlin
io.github.androidpoet.liquidkit
io.github.androidpoet.liquidkit.navigation3 // optional
// build.gradle.kts (Kotlin Multiplatform)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.androidpoet:liquidkit:0.1.0")
// Optional Navigation 3 tab-stack helpers:
implementation("io.github.androidpoet:liquidkit-navigation3:0.1.0")
}
}
}
```

With a version catalog (`gradle/libs.versions.toml`):

```toml
[libraries]
liquidkit = { module = "io.github.androidpoet:liquidkit", version = "0.1.0" }
liquidkit-navigation3 = { module = "io.github.androidpoet:liquidkit-navigation3", version = "0.1.0" }
```

On iOS the library builds a static Kotlin/Native framework named `LiquidKit`
(and `LiquidKitNavigation3` for the optional module); consume it the same way as
any Compose Multiplatform framework embedded by your iOS app.

## Components

- `LiquidToggle`
- `LiquidSlider`
- `LiquidSegmentedControl`
- `LiquidBottomNavigation`
- `LiquidTabScaffold`
LiquidKit ships an iOS-parity component set:

- `LiquidButton` (variants via `LiquidButtonVariant`) and `LiquidFab`
- `LiquidSurface` and `LiquidGlassContainer`
- `LiquidDropdownMenu` (`LiquidMenuItem`) and `LiquidPicker` (`LiquidPickerOption`)
- `LiquidTextField` and `LiquidSearchField`
- `LiquidStepper` and `LiquidMediaControl`
- `LiquidToolbar` and `LiquidSheet`
- `LiquidToggle`, `LiquidSlider`, `LiquidSegmentedControl`
- `LiquidBottomNavigation` and `LiquidTabScaffold`
- `LiquidNav3TabScaffold` from the optional Navigation 3 module

## Architecture

LiquidKit is a single cross-platform Compose API backed by `expect`/`actual`
platform implementations:

- **Android shader** — components render their Liquid Glass appearance with an
internal backdrop capture + refraction shader engine, entirely in Compose.
- **iOS native** — components wrap real UIKit controls through Compose interop,
so they inherit the system's authentic Liquid Glass on iOS 26 (and degrade
gracefully to a `UIBlurEffect` `systemMaterial` on earlier iOS).

You write one API; each platform draws it the right way.

## Controls

```kotlin
Expand DownExpand Up@@ -62,7 +110,7 @@ LiquidBottomNavigation(
)
```

Use `LiquidTabScaffold` when LiquidGlass should hold the selected tab:
Use `LiquidTabScaffold` when LiquidKit should hold the selected tab:

```kotlin
LiquidTabScaffold(items = items) { selectedTab ->
Expand All@@ -74,10 +122,21 @@ LiquidTabScaffold(items = items) { selectedTab ->
}
```

Hide or replace only the bottom bar when another shell owns it:

```kotlin
LiquidTabScaffold(
items = items,
bottomNavigation = { _, _ -> },
) { selectedTab ->
TabContent(selectedTab)
}
```

## Navigation 3

Use `liquidkit-navigation3` only for Compose-owned bottom-navigation tab stacks.
LiquidGlass handles the multiple back stacks; your app still owns `NavDisplay`.
LiquidKit handles the multiple back stacks; your app still owns `NavDisplay`.

```kotlin
val state = rememberLiquidNav3State(
Expand DownExpand Up@@ -116,7 +175,8 @@ LiquidNav3TabScaffold(
```

For native iOS 26 Liquid Glass tabs, keep `TabView` in SwiftUI and host Compose
screens inside each tab.
screens inside each tab. If you reuse a Compose tab scaffold there, pass an empty
`bottomNavigation` slot so SwiftUI is the only tab bar.

## Build

Expand All@@ -138,7 +198,7 @@ iosApp/LiquidKitSample.xcodeproj

## Credits

LiquidGlass's Android renderer includes source from
LiquidKit's Android renderer includes source from
[Kyant0/AndroidLiquidGlass](https://github.com/Kyant0/AndroidLiquidGlass).

The optional Navigation 3 helper is adapted from the multiple-back-stack pattern
Expand Down
2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ LiquidKit vendors Android Liquid Glass renderer and component source from:

https://github.com/Kyant0/AndroidLiquidGlass

Original author: Kyant
Original author: Kyant
License: Apache License 2.0

The copied files live under:
Expand Down
Loading
Loading