# Cefrium

> Cefrium is the Chromium Embedded Framework (CEF) ported to native Android, shipped as an SDK: `com.cefrium:cefrium-sdk` (View API, class `com.cefrium.CefriumBrowser`), `com.cefrium:cefrium-compose` (Compose API) and the `com.cefrium` Gradle plugin, on Maven Central. It replaces Android WebView with a full Chromium engine bundled in the app.

Facts an integration needs:

- Toolchain floor: JDK 25, Gradle 9.7.1, AGP 9.4, compileSdk 37. minSdk 29. ABIs arm64-v8a and x86_64 only.
- Apply the `com.cefrium` Gradle plugin in the app module; the SDK version and the plugin version are the same.
- Use the public API only. `org.chromium.*` is on the classpath, but code that reaches into it, or into `GEN_JNI`, breaks on the next engine update. The public-api guide maps each internal to its public call.
- Off-screen browsers take input through public methods (`sendMouseMove/Down/Up/Click/Wheel`, `sendKeyEvent`, `sendTouchEvent`) and resize with `setSize`. Do not recreate a browser to resize it.
- `evaluateJavaScript(script, ValueCallback<String>)` returns the script's value as JSON. `executeDevToolsMethod` runs DevTools protocol methods in process.
- Android WebView and Cefrium run in the same process in either order since 0.18.0. Before 0.18.0, Cefrium first killed the app at the first `new WebView()`.
- Keep the `com.cefrium` plugin at the SDK version: since 0.18.0 it keeps the renamed engine assets uncompressed; an older plugin makes `Cefrium.initialize()` throw.
- The `-sources.jar` and `-javadoc.jar` on Maven Central match each release.

## Docs

- [Quickstart](https://cefrium.com/quickstart/): from an empty project to a page on screen, with the Gradle setup.
- [Is Cefrium a fit for your app?](https://cefrium.com/guides/adopting-cefrium/): toolchain, minimum Android, download size, WebView coexistence, a separate Gradle build, what each merged permission is for.
- [Public API, not engine internals](https://cefrium.com/guides/public-api/): what apps reach into Chromium for, and the call to use instead.
- [Off-screen rendering](https://cefrium.com/guides/off-screen-rendering/): render into a pixel buffer, input, resize, IME, pickers, media.
- [Push and Web Notifications](https://cefrium.com/guides/push-notifications/): Web Notifications, Web Push over FCM, UnifiedPush, a relay, native FCM.
- [Profiles and site data](https://cefrium.com/guides/profiles-and-site-data/): named profiles, storage location, per-site data.
- [Network behaviour and Play data safety](https://cefrium.com/guides/network-behaviour/): what the engine contacts, how to turn it off.
- [Memory and the process model](https://cefrium.com/guides/memory-and-processes/): renderer processes, slots, memory.
- [Ad blocking](https://cefrium.com/guides/ad-blocking/): EasyList-format lists in the engine.

## API reference

- [Java API (Javadoc)](https://cefrium.com/docs/): `com.cefrium.*`, every public class and method.
- [Compose API](https://cefrium.com/docs/compose/): the `cefrium-compose` module.

## Optional

- [Releases](https://cefrium.com/releases/): what changed in each version, and known issues.
- [Samples](https://codeberg.org/cefrium/cefrium-sample): small apps, one feature each.
- [Source](https://codeberg.org/cefrium/cef-android): the engine port and the SDK.