WebView
Embed a web page in a native view. Use it for hosted help, web content or a service that only offers a web interface.
Embed a hosted help page
import { WebView } from 'kuito';
export default function Help() {
return <WebView flex={1} src="https://example.com/help" />;
}Behavior
Give the view a bounded size. Use allowedOrigins to restrict the origins that may load. Use webViewRef for navigation and messaging; do not expose privileged app actions to arbitrary page messages.
Continue
Read Linking for a complete workflow. See the complete prop reference for types and documented defaults.
Reference
Signatures
(props: NativeViewProps<WebViewProps, WebViewMethods>): KuitoElementParameters
| Name | Type | Required | Description |
|---|---|---|---|
props | NativeViewProps<WebViewProps, WebViewMethods> | Yes | — |
Returns
Props: NativeViewProps<WebViewProps, WebViewMethods>
Props (including inherited props) 96
| Name | Type | Required | Description |
|---|---|---|---|
opacity | Animatable<number> | No | — |
backgroundColor | Animatable<string> | No | — |
borderRadius | Animatable<number> | No | — |
borderColor | Animatable<string> | No | — |
width | Animatable<SizeValue> | No | — |
height | Animatable<SizeValue> | No | — |
translateX | Animatable<number> | No | — |
translateY | Animatable<number> | No | — |
scale | Animatable<number> | No | — |
scaleX | Animatable<number> | No | — |
scaleY | Animatable<number> | No | — |
rotate | Animatable<number> | No | Degrees. |
shadowColor | Animatable<string> | No | — |
shadowRadius | Animatable<number> | No | — |
shadowOffsetX | Animatable<number> | No | — |
shadowOffsetY | Animatable<number> | No | — |
padding | Prop<LengthPercentage> | No | — |
position | Prop<"relative" | "absolute"> | No | — |
id | string | No | — |
class | Prop<ClassNames> | No | Class names from a .css import or styles(): a string, or a list with falsy entries skipped, following the signals it reads. |
style | StyleDeclarations | No | Styles of this view alone, compiled at build time: CSS properties in
camelCase. A value that changes must set a native prop (opacity). |
key | string | number | No | — |
paddingTop | Prop<LengthPercentage> | No | — |
paddingRight | Prop<LengthPercentage> | No | — |
paddingBottom | Prop<LengthPercentage> | No | — |
paddingLeft | Prop<LengthPercentage> | No | — |
minWidth | Prop<SizeValue> | No | — |
maxWidth | Prop<SizeValue> | No | — |
minHeight | Prop<SizeValue> | No | — |
maxHeight | Prop<SizeValue> | No | — |
aspectRatio | Prop<number> | No | Width divided by height; sizes the missing side from the other. |
top | Prop<LengthPercentageAuto> | No | — |
right | Prop<LengthPercentageAuto> | No | — |
bottom | Prop<LengthPercentageAuto> | No | — |
left | Prop<LengthPercentageAuto> | No | — |
margin | Prop<LengthPercentageAuto> | No | — |
marginTop | Prop<LengthPercentageAuto> | No | — |
marginRight | Prop<LengthPercentageAuto> | No | — |
marginBottom | Prop<LengthPercentageAuto> | No | — |
marginLeft | Prop<LengthPercentageAuto> | No | — |
flexGrow | Prop<number> | No | — |
flexShrink | Prop<number> | No | — |
flexBasis | Prop<SizeValue | "content"> | No | — |
flex | Prop<number> | No | A grow factor from a zero basis, as CSS flex: n; 0 is inflexible. |
alignSelf | Prop<"auto" | SelfAlignment> | No | — |
direction | Prop<"ltr" | "rtl"> | No | The way lines run; unset, the parent's, and the app's first language's at the root. |
boxSizing | Prop<"border-box" | "content-box"> | No | — |
paddingInlineStart | Prop<LengthPercentage> | No | Padding on the side lines start from: the left in ltr, the right in rtl. |
paddingInlineEnd | Prop<LengthPercentage> | No | Padding on the side lines end at: the right in ltr, the left in rtl. |
marginInlineStart | Prop<LengthPercentageAuto> | No | Margin on the side lines start from: the left in ltr, the right in rtl. |
marginInlineEnd | Prop<LengthPercentageAuto> | No | Margin on the side lines end at: the right in ltr, the left in rtl. |
insetInlineStart | Prop<LengthPercentageAuto> | No | left in ltr, right in rtl. |
insetInlineEnd | Prop<LengthPercentageAuto> | No | right in ltr, left in rtl. |
role | Prop<Role> | No | — |
onAction | (event: AccessibilityActionEvent) => void | No | The screen reader action taken, by name. |
accessible | Prop<boolean> | No | Makes the view one screen reader element, read as its label or its children's text. |
label | Prop<string> | No | What a screen reader says for the view. |
hint | Prop<string> | No | What happens when the view is activated, read after the label. |
actions | Prop<readonly AccessibilityAction[]> | No | Actions a screen reader offers; onAction receives the one taken. |
live | Prop<"off" | "polite" | "assertive"> | No | ARIA's aria-live: announces changes to the view's content, on iOS too. |
aria-disabled | Prop<boolean> | No | — |
aria-selected | Prop<boolean> | No | — |
aria-checked | Prop<boolean | "mixed"> | No | — |
aria-busy | Prop<boolean> | No | — |
aria-expanded | Prop<boolean> | No | — |
aria-valuemin | Prop<number> | No | — |
aria-valuemax | Prop<number> | No | — |
aria-valuenow | Prop<number> | No | — |
aria-valuetext | Prop<string> | No | — |
gestures | readonly Composable[] | No | The view's gestures; several race unless composed with together or orElse. |
transition | Partial<Record<"opacity" | "backgroundColor" | "transform" | "borderRadius" | "borderColor" | "shadow" | "width" | "height" | "all", Animation<unknown> | AnimationSpec>> | No | How the animatable props move when they change, enter or leave, by group; a CSS transition compiles to it. |
animate | Partial<Record<AnimatableProps, string | number>> | No | Animatable props whose every change moves as transition says; the first value applies at once. |
enter | Effect | No | Where the view enters from: fade.and(slide.up(12)). |
exit | Prop<Effect> | No | Where the view leaves to; it stays on screen until it is there. The renderer gets true, and keeps the view until exited. |
layout | Animation<number> | No | How the view moves to a new frame the layout gives it: layout={spring()}. |
overflow | Prop<"visible" | "hidden" | "clip" | "scroll"> | No | hidden and scroll clip; as in CSS, either lets a flex item shrink below its content. |
borderWidth | Prop<number> | No | — |
backgroundGradient | { angle: number; colors: string[];} | No | — |
color | Prop<string> | No | — |
sharedId | Prop<string> | No | A view the navigation stack flies to the view with the same sharedId on the screen it pushes or pops to (docs/navigation.md#shared-elements). |
ref | ElementRef<NativeViewHandle<WebViewMethods>> | No | — |
src | Bound<WebViewSource> | No | The page to load. Set src or html, not both. |
html | Bound<string | { html: string; baseUrl?: string;}> | No | Inline HTML, resolved against baseUrl when given. |
allowedOrigins | Bound<string[]> | No | Origins the WebView navigates to, as wildcard patterns (https://*).
The main frame's navigations elsewhere open through Linking instead.
["http://*", "https://*"] by default. |
injectedJavaScript | Bound<string> | No | Runs in the main frame each time a document finishes loading. |
javaScriptEnabled | Bound<boolean> | No | True by default. |
swipeNavigation | Bound<boolean> | No | iOS only: swipe from an edge to go back or forward. False by default. |
userAgent | Bound<string> | No | Replaces the platform's user agent. |
onLoadStart | (event: WebViewNavigationEvent) => void | No | — |
onLoad | (event: WebViewNavigationEvent) => void | No | The page loaded. |
onLoadEnd | (event: WebViewNavigationEvent) => void | No | The load ended, loaded or failed. |
onError | (event: WebViewErrorEvent) => void | No | — |
onNavigate | (event: WebViewNavigationEvent) => void | No | The URL, title, loading state or history changed. |
onMessage | (event: WebViewMessageEvent) => void | No | — |
onAction — method signatures
Signatures
(event: AccessibilityActionEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | AccessibilityActionEvent | Yes | — |
Returns
void
backgroundGradient — nested fields
backgroundGradient fields
| Name | Type | Required | Description |
|---|---|---|---|
angle | number | Yes | — |
colors | string[] | Yes | — |
onLoadStart — method signatures
Signatures
(event: WebViewNavigationEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebViewNavigationEvent | Yes | — |
Returns
void
onLoad — method signatures
Signatures
(event: WebViewNavigationEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebViewNavigationEvent | Yes | — |
Returns
void
onLoadEnd — method signatures
Signatures
(event: WebViewNavigationEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebViewNavigationEvent | Yes | — |
Returns
void
onError — method signatures
Signatures
(event: WebViewErrorEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebViewErrorEvent | Yes | — |
Returns
void
onNavigate — method signatures
Signatures
(event: WebViewNavigationEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebViewNavigationEvent | Yes | — |
Returns
void
onMessage — method signatures
Signatures
(event: WebViewMessageEvent): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | WebViewMessageEvent | Yes | — |
Returns
void
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.