Source: https://app-studio-6167b.web.app/docs/KeyboardAvoidingView

@app-studio/components

# KeyboardAvoidingView

Keep form content usable when the on-screen keyboard appears. Browser previews illustrate layout; native keyboard behavior depends on the target platform.

[View component source](https://github.com/rize-network/app-studio-components/blob/main/src/components/KeyboardAvoidingView/KeyboardAvoidingView.tsx)

## Import

```ts
import { KeyboardAvoidingView } from '@app-studio/components';
```

New to the library? Complete [installation and provider setup](https://app-studio-6167b.web.app/docs/installation) first.

## Interactive examples

Try the component, then open Code to copy the complete example.

```jsx
import React from 'react';
import { Text, View, Vertical } from 'app-studio';
import { KeyboardAvoidingView, TextField } from '@app-studio/components';

/**
 * On native, focusing a field lifts this content above the keyboard and a tap
 * on empty space dismisses it. On web it renders as a plain flex container.
 */
export const DefaultKeyboardAvoidingView = () => (
  <View
    height={320}
    width="100%"
    maxWidth={360}
    borderRadius={16}
    overflow="hidden"
    borderWidth={1}
    borderStyle="solid"
    borderColor="color-gray-200"
  >
    <KeyboardAvoidingView dismissOnTap>
      <Vertical flex={1} justifyContent="flex-end" padding={16} gap={12}>
        <Text color="color-gray-500">Tap empty space to dismiss</Text>
        <TextField name="email" label="Email" />
        <TextField name="message" label="Message" />
      </Vertical>
    </KeyboardAvoidingView>
  </View>
);
```

## Props

Required props are marked below. A dash indicates an unspecified default. Design system configuration can override implementation defaults.

**KeyboardAvoidingView**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `behavior` | `"height" \| "position" \| "padding"` `"height"``"position"``"padding"` | `—` | How the view reacts to the on-screen keyboard (native only). Defaults to 'padding' on iOS and 'height' on Android — the combination that behaves best in practice. Ignored on web.[Source](https://github.com/rize-network/app-studio-components/blob/main/src/components/KeyboardAvoidingView/KeyboardAvoidingView.types.ts#L10) |
| `keyboardVerticalOffset` | `number` | `—` | Distance between the top of the keyboard and the focused field (native only) — e.g. to account for a fixed header. Ignored on web.[Source](https://github.com/rize-network/app-studio-components/blob/main/src/components/KeyboardAvoidingView/KeyboardAvoidingView.types.ts#L15) |
| `dismissOnTap` | `boolean` | `—` | When true, tapping an empty (non-input) area dismisses the keyboard (native only). Web browsers reflow around their own keyboard, so this is a no-op there.[Source](https://github.com/rize-network/app-studio-components/blob/main/src/components/KeyboardAvoidingView/KeyboardAvoidingView.types.ts#L21) |
| `enabled` | `boolean` | `—` | Enable/disable the avoiding behavior (native only). Default true.[Source](https://github.com/rize-network/app-studio-components/blob/main/src/components/KeyboardAvoidingView/KeyboardAvoidingView.types.ts#L23) |
| `children` | View type `string \| number \| bigint \| boolean \| React.ReactElement<unknown, string \| React.JSXElementConstructor<any>> \| Iterable<React.ReactNode> \| React.ReactPortal \| Promise<string \| number \| bigint \| boolean \| React.ReactPortal \| React.ReactElement<unknown, string \| React.JSXElementConstructor<any>> \| Iterable<React.ReactNode> \| null \| undefined> \| null` | `—` | Content rendered inside the component.[Source](https://github.com/rize-network/app-studio-components/blob/main/src/components/KeyboardAvoidingView/KeyboardAvoidingView.types.ts#L24) |

Common inherited styling props (7)

**KeyboardAvoidingView inherited**

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `media` | `Record<string, CssProps>` | `—` | See the type and source declaration for this property. |
| `onClick` | `any` | `—` | Called when the user activates the component. |
| `as` | `keyof JSX.IntrinsicElements` `"symbol"``"object"``"slot"``"style"``"title"``"pattern"``"form"``"animate"``"clipPath"``"filter"``"marker"``"mask"``"a"``"abbr"``"address"``"area"``"article"``"aside"``"audio"``"b"``"base"``"bdi"``"bdo"``"big"``"blockquote"``"body"``"br"``"button"``"canvas"``"caption"``"center"``"cite"``"code"``"col"``"colgroup"``"data"``"datalist"``"dd"``"del"``"details"``"dfn"``"dialog"``"div"``"dl"``"dt"``"em"``"embed"``"fieldset"``"figcaption"``"figure"``"footer"``"h1"``"h2"``"h3"``"h4"``"h5"``"h6"``"head"``"header"``"hgroup"``"hr"``"html"``"i"``"iframe"``"img"``"input"``"ins"``"kbd"``"keygen"``"label"``"legend"``"li"``"link"``"main"``"map"``"mark"``"menu"``"menuitem"``"meta"``"meter"``"nav"``"noindex"``"noscript"``"ol"``"optgroup"``"option"``"output"``"p"``"param"``"picture"``"pre"``"progress"``"q"``"rp"``"rt"``"ruby"``"s"``"samp"``"search"``"script"``"section"``"select"``"small"``"source"``"span"``"strong"``"sub"``"summary"``"sup"``"table"``"template"``"tbody"``"td"``"textarea"``"tfoot"``"th"``"thead"``"time"``"tr"``"track"``"u"``"ul"``"var"``"video"``"wbr"``"webview"``"svg"``"animateMotion"``"animateTransform"``"circle"``"defs"``"desc"``"ellipse"``"feBlend"``"feColorMatrix"``"feComponentTransfer"``"feComposite"``"feConvolveMatrix"``"feDiffuseLighting"``"feDisplacementMap"``"feDistantLight"``"feDropShadow"``"feFlood"``"feFuncA"``"feFuncB"``"feFuncG"``"feFuncR"``"feGaussianBlur"``"feImage"``"feMerge"``"feMergeNode"``"feMorphology"``"feOffset"``"fePointLight"``"feSpecularLighting"``"feSpotLight"``"feTile"``"feTurbulence"``"foreignObject"``"g"``"image"``"line"``"linearGradient"``"metadata"``"mpath"``"path"``"polygon"``"polyline"``"radialGradient"``"rect"``"set"``"stop"``"switch"``"text"``"textPath"``"tspan"``"use"``"view"` | `—` | See the type and source declaration for this property. |
| `themeMode` | `"light" \| "dark"` `"light"``"dark"` | `—` | See the type and source declaration for this property. |
| `_hover` | `string \| CssProps` | `—` | See the type and source declaration for this property. |
| `_active` | `string \| CssProps` | `—` | See the type and source declaration for this property. |
| `_focus` | `string \| CssProps` | `—` | See the type and source declaration for this property. |

For shared layout, color, and responsive properties, read [Styling & composition](https://app-studio-6167b.web.app/docs/styling) and [Responsive layouts](https://app-studio-6167b.web.app/docs/responsive). Additional native element attributes depend on the target platform.

## Usage guidance

- Give controls a visible label or an accessible name, and verify keyboard interaction. See [Accessibility](https://app-studio-6167b.web.app/docs/accessibility).
- For controlled inputs, update the value from the callback shown in the props table. Keep application state in your component or form library.
- These previews run in the browser. Check [React Native setup](https://app-studio-6167b.web.app/docs/react-native) for platform requirements and differences.