xref: /aosp_15_r20/external/accompanist/web/README.md (revision fa44fe6ae8e729aa3cfe5c03eedbbf98fb44e2c6) 
1# WebView wrapper for Jetpack Compose
2
3[![Maven Central](https://img.shields.io/maven-central/v/com.google.accompanist/accompanist-webview)](https://search.maven.org/search?q=g:com.google.accompanist)
4
5For more information, visit the documentation: https://google.github.io/accompanist/web/
6
7## Basic Usage
8
9To implement this wrapper there are two key APIs which are needed: WebView, which provides the layout, and rememberWebViewState(url) which provides some remembered state including the URL to display.
10
11The basic usage is as follows:
12```kotlin
13val state = rememberWebViewState("https://example.com")
14
15WebView(state)
16```
17This will display a WebView in your Compose layout that shows the URL provided.
18
19## Download
20
21```groovy
22repositories {
23    mavenCentral()
24}
25
26dependencies {
27    implementation "com.google.accompanist:accompanist-webview:<version>"
28}
29```
30
31Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap]. These are updated on every commit.
32
33  [snap]: https://oss.sonatype.org/content/repositories/snapshots/com/google/accompanist/accompanist-web/
34