Skip to content

feat: Add readOnly prop to TextInput component#34444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
gabrieldonadel wants to merge 3 commits into from
Closed

feat: Add readOnly prop to TextInput component #34444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1277d0
feat: Add readOnly prop to TextInput
gabrieldonadel Aug 18, 2022
f29a533
feat: Update TextInput logic to readOnly take priority over editable
gabrieldonadel Aug 18, 2022
21aec01
chore: Update TextInput prop types to be alpha sorted
gabrieldonadel Aug 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Libraries/Components/TextInput/TextInput.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -709,6 +709,13 @@ export type Props = $ReadOnly<{|
*/
placeholderTextColor?: ?ColorValue,

/** `readOnly` works like the `readonly` attribute in HTML.
* If `true`, text is not editable. The default value is `false`.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly
* for more details.
*/
readOnly?: ?boolean,

/**
* Determines how the return key should look. On Android you can also use
* `returnKeyLabel`.
Expand DownExpand Up@@ -1381,6 +1388,8 @@ const ExportedForwardRef: React.AbstractComponent<
allowFontScaling = true,
rejectResponderTermination = true,
underlineColorAndroid = 'transparent',
readOnly,
editable,

@lunaleapslunaleapsAug 23, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about adding a deprecation message on editable if it's used cc @cipolleschi. We could do that in a follow-up PR

@gabrieldonadelgabrieldonadelAug 23, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I can open a follow-up PR and also update the docs on https://github.com/facebook/react-native-website/

@gabrieldonadelgabrieldonadelAug 24, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lunaleaps here is the follow-up PR #34492 and the PR updating the docs react/react-native-website#3278

...restProps
},
forwardedRef: ReactRefSetter<
Expand All@@ -1392,6 +1401,7 @@ const ExportedForwardRef: React.AbstractComponent<
allowFontScaling={allowFontScaling}
rejectResponderTermination={rejectResponderTermination}
underlineColorAndroid={underlineColorAndroid}
editable={readOnly !== undefined ? !readOnly : editable}
{...restProps}
forwardedRef={forwardedRef}
/>
Expand Down
36 changes: 36 additions & 0 deletions packages/rn-tester/js/examples/TextInput/TextInputExample.android.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,13 @@ const styles = StyleSheet.create({
singleLineWithHeightTextInput: {
height: 30,
},
default: {
borderWidth: StyleSheet.hairlineWidth,
borderColor: '#0f0f0f',
flex: 1,
fontSize: 13,
padding: 4,
},
});

exports.title = 'TextInput';
Expand DownExpand Up@@ -347,6 +354,35 @@ exports.examples = ([
);
},
},
{
title: 'Editable and Read only',
render: function (): React.Node {
return (
<View>
<TextInput
placeholder="editable text input using editable prop"
style={styles.default}
editable
/>
<TextInput
placeholder="uneditable text input using editable prop"
style={styles.default}
editable={false}
/>
<TextInput
placeholder="editable text input using readOnly prop"
style={styles.default}
readOnly={false}
/>
<TextInput
placeholder="uneditable text input using readOnly prop"
style={styles.default}
readOnly
/>
</View>
);
},
},
{
title: 'Fixed number of lines',
platform: 'android',
Expand Down
29 changes: 29 additions & 0 deletions packages/rn-tester/js/examples/TextInput/TextInputExample.ios.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -621,6 +621,35 @@ exports.examples = ([
);
},
},
{
title: 'Editable and Read only',
render: function (): React.Node {
return (
<View>
<TextInput
placeholder="editable text input using editable prop"
style={styles.default}
editable
/>
<TextInput
placeholder="uneditable text input using editable prop"
style={styles.default}
editable={false}
/>
<TextInput
placeholder="editable text input using readOnly prop"
style={styles.default}
readOnly={false}
/>
<TextInput
placeholder="uneditable text input using readOnly prop"
style={styles.default}
readOnly
/>
</View>
);
},
},
{
title: 'TextInput Intrinsic Size',
render: function (): React.Node {
Expand Down