Skip to content

Commit

Permalink
add textinput properties
Browse files Browse the repository at this point in the history
  • Loading branch information
TatianaKapos committed Feb 29, 2024
1 parent 07fe224 commit 9aae79f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
32 changes: 32 additions & 0 deletions docs/textinput-component-windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
id: textinput-component
title: TextInput
---

# Reference

## Props

Inherits [TextInput Props](https://reactnative.dev/docs/textinput).

## Windows-Specific Properties

### `submitKeyEvent`

A property that registers a set of KeyEvents that may trigger `OnSubmitEditing` in a multiline scenario.

| type | required |
|:--|:--|
| { code: 'Enter', shiftKey: bool } | No |

### `clearTextOnSubmit`

If true, the text field will clear when submitted. The default is false.

| type | required |
|:--|:--|
| bool | No |

## Examples

Examples can be found in the [React Native Gallery App](https://github.com/microsoft/react-native-gallery/blob/main/src/examples/TextInputExamplePage.tsx) available in the [Microsoft Store](http://aka.ms/reactnativegalleryapp)
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
"Components (Windows)": [
"flyout-component",
"glyph-component",
"popup-component"
"popup-component",
"textinput-component"
],
"JavaScript API (Windows)": [
"apptheme-api",
Expand Down

0 comments on commit 9aae79f

Please sign in to comment.