@astrocoders/react-native-selectable-text
v1.5.1
Published
React Native component used to provide the features of pass different context menu items and events
Downloads
158
Keywords
Readme
react-native-selectable-text
Demo
Android
iOS
Usage
import { SelectableText } from "@astrocoders/react-native-selectable-text";
// Use normally, it is a drop-in replacement for react-native/Text
<SelectableText
menuItems={["Foo", "Bar"]}
/*
Called when the user taps in a item of the selection menu:
- eventType: (string) is the label
- content: (string) the selected text portion
- selectionStart: (int) is the start position of the selected text
- selectionEnd: (int) is the end position of the selected text
*/
onSelection={({ eventType, content, selectionStart, selectionEnd }) => {}}
value="I crave star damage"
/>;
Getting started
$ npm install @astrocoders/react-native-selectable-text --save
Mostly automatic installation
$ react-native link @astrocoders/react-native-selectable-text
Manual installation
iOS - Binary Linking (Alternative 1)
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜@astrocoders/react-native-selectable-text
and addRNSelectableText.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNSelectableText.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)<
iOS - Pods (Alternative 2)
- Add
pod 'RNSelectableText', :path => '../node_modules/@astrocoders/react-native-selectable-text/ios/RNSelectableText.podspec'
to your projects podfile - run
pod install
Android
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import com.astrocoders.selectabletext.RNSelectableTextPackage;
to the imports at the top of the file - Add
new RNSelectableTextPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':react-native-selectable-text' project(':react-native-selectable-text').projectDir = new File(rootProject.projectDir, '../node_modules/@astrocoders/react-native-selectable-text/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:compile project(':react-native-selectable-text')
Props
| name | description | type | default |
|--|--|--|--|
| value | text content | string | "" |
| onSelection | Called when the user taps in a item of the selection menu | ({ eventType: string, content: string, selectionStart: int, selectionEnd: int }) => void | () => {} |
| menuItems | context menu items | array(string) | [] |
| style | additional styles to be applied to text | Object | null |
| highlights | array of text ranges that should be highlighted with an optional id | array({ id: string, start: int, end: int }) | [] |
| highlightColor | highlight color |string | null |
| onHighlightPress | called when the user taps the highlight |(id: string) => void | () => {} |
| appendToChildren | element to be added in the last line of text | ReactNode | null |
| TextComponent | Text component used to render value
| ReactNode | |
| textValueProp | text value prop for TextComponent. Should be used when passing TextComponent. Defaults to 'children' which works for | string | 'children' |
| textComponentProps | additional props to pass to TextComponent | object | null |