diff --git a/README.md b/README.md index 7331edf..bb62cee 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,23 @@ # react-native-action-sheet + [![npm](https://img.shields.io/npm/v/@expo/react-native-action-sheet.svg?style=flat-square)](https://www.npmjs.com/package/@expo/react-native-action-sheet) [![License: MIT](https://img.shields.io/github/license/nd-02110114/goofi-mobile.svg)](https://opensource.org/licenses/MIT) [![Discord](https://img.shields.io/badge/discord-expo-green?style=flat-square&logo=discord)](https://discord.gg/4gtbPAdpaE) ActionSheet is a cross-platform React Native component that uses the native UIActionSheet on iOS and a JS implementation on Android. Almost a drop in replacement for [ActionSheetIOS](https://facebook.github.io/react-native/docs/actionsheetios.html) except it cannot be called statically. - -| iOS | Android | Web | -|---------------------------|---------------------------|---------------------------| +| iOS | Android | Web | +| -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | | | | | - ## Installation ``` $ npm install @expo/react-native-action-sheet -S ``` + or + ``` $ yarn add @expo/react-native-action-sheet ``` @@ -26,8 +27,7 @@ $ yarn add @expo/react-native-action-sheet ### 1. Wrap your top-level component with `` ```es6 - -import { ActionSheetProvider } from '@expo/react-native-action-sheet' +import { ActionSheetProvider } from '@expo/react-native-action-sheet'; class AppContainer extends React.Component { render() { @@ -41,16 +41,17 @@ class AppContainer extends React.Component { ``` ### 2. Connect your component which uses showActionSheetWithOptions. + ```es6 -import { connectActionSheet } from '@expo/react-native-action-sheet' +import { connectActionSheet } from '@expo/react-native-action-sheet'; class App extends React.Component { /* ... */ } -const ConnectedApp = connectActionSheet(App) +const ConnectedApp = connectActionSheet(App); -export default ConnectedApp +export default ConnectedApp; ``` `App` component can access the actionSheet method as `this.props.showActionSheetWithOptions` @@ -68,9 +69,9 @@ _onOpenActionSheet = () => { cancelButtonIndex, destructiveButtonIndex, }, - buttonIndex => { + (buttonIndex) => { // Do something here depending on the button index selected - }, + } ); }; ``` @@ -78,9 +79,9 @@ _onOpenActionSheet = () => { You can use a hook instead of the higher order component if you are on React 16.8 or newer. ```es6 -import { useActionSheet } from '@expo/react-native-action-sheet' +import { useActionSheet } from '@expo/react-native-action-sheet'; -export default function App () { +export default function App() { const { showActionSheetWithOptions } = useActionSheet(); /* ... */ } @@ -94,73 +95,84 @@ This library can also be used in the browser with Expo for web. ### Universal Props -The same options available on React Native's [ActionSheetIOS](https://facebook.github.io/react-native/docs/actionsheetios.html#showactionsheetwithoptions) component exist for both iOS and Android in this library. +The same options available on React Native's [ActionSheetIOS](https://reactnative.dev/docs/0.64/actionsheetios#showactionsheetwithoptions) component exist for both iOS and Android in this library. Note: `disabledButtonIndicies` is only available for iOS in Expo 43+ or RN 0.64.0+. ### iOS Only Props | Name | Type | Required | Default | -| -------------------| -------| -------- | ------- | +| ------------------ | ------ | -------- | ------- | | anchor | number | No | | | userInterfaceStyle | string | No | | #### `anchor` (optional) + iPad only option that allows for docking the action sheet to a node. See [ShowActionSheetButton.tsx](/example/ShowActionSheetButton.tsx) for an example on how to implement this. #### `userInterfaceStyle` (optional) + The interface style used for the action sheet, can be set to `light` or `dark`, otherwise the default system style will be used. ### Android/Web-Only Props The below props allow modification of the Android ActionSheet. They have no effect on the look on iOS as the native iOS Action Sheet does not have options for modifying these options. - -| Name | Type | Required | Default | -| -----------------| ----------------------------------| -------- | ------- | -| icons | array of required images or icons | No | | -| tintIcons | boolean | No | true | -| textStyle | TextStyle | No | | -| titleTextStyle | TextStyle | No | | -| messageTextStyle | TextStyle | No | | -| autoFocus | boolean | No | false | -| showSeparators | boolean | No | false | -| containerStyle | ViewStyle | No | | -| separatorStyle | ViewStyle | No | | -| useModal | boolean | No | false (true if autoFocus is true) | -| destructiveColor | string | No | #d32f2f | +| Name | Type | Required | Default | +| ---------------- | --------------------------------- | -------- | --------------------------------- | +| icons | array of required images or icons | No | | +| tintIcons | boolean | No | true | +| textStyle | TextStyle | No | | +| titleTextStyle | TextStyle | No | | +| messageTextStyle | TextStyle | No | | +| autoFocus | boolean | No | false | +| showSeparators | boolean | No | false | +| containerStyle | ViewStyle | No | | +| separatorStyle | ViewStyle | No | | +| useModal | boolean | No | false (true if autoFocus is true) | +| destructiveColor | string | No | #d32f2f | #### `icons` (optional) Show icons to go along with each option. If image source paths are provided via `require`, images will be rendered for you. Alternatively, you can provide an array of elements such as vector icons, pre-rendered Images, etc. #### `tintIcons` (optional) - Icons by default will be tinted to match the text color. When set to false, the icons will be the color of the source image. This is useful if you want to use multicolor icons. If you provide your own nodes/pre-rendered icons rather than required images in the `icons` array, you will need to tint them appropriately before providing them in the array of `icons`; `tintColor` will not be applied to icons unless they are images from a required source. + +Icons by default will be tinted to match the text color. When set to false, the icons will be the color of the source image. This is useful if you want to use multicolor icons. If you provide your own nodes/pre-rendered icons rather than required images in the `icons` array, you will need to tint them appropriately before providing them in the array of `icons`; `tintColor` will not be applied to icons unless they are images from a required source. #### `textStyle` (optional) + Apply any text style props to the options. If the `tintColor` option is provided, it takes precedence over a color text style prop. #### `titleTextStyle` (optional) + Apply any text style props to the title if present. #### `messageTextStyle` (optional) + Apply any text style props to the message if present. #### `autoFocus`: (optional) + If true, will give the first option screen reader focus automatically when the action sheet becomes visible. On iOS, this is the default behavior of the native action sheet. #### `showSeparators`: (optional) + Show separators between items. On iOS, separators always show so this prop has no effect. #### `containerStyle`: (optional) + Apply any view style props to the container rather than use the default look (e.g. dark mode). #### `separatorStyle`: (optional) + Modify the look of the separators rather than use the default look. #### `useModal`: (optional) + Wrap the ActionSheet with a Modal, in order to show in front of other Modals that were already opened ([issue reference](https://github.com/expo/react-native-action-sheet/issues/164)). #### `destructiveColor`: (optional) + Modify color for text of destructive option. ## ActionSheetProvider Props @@ -168,8 +180,8 @@ Modify color for text of destructive option. The following props can be set directly on the `ActionSheetProvider` #### `useNativeDriver` (optional) -Windows only option that provides the option to disable the [native animation](https://reactnative.dev/docs/animated#using-the-native-driver) driver for React Native Windows projects targeting _Windows 10 Version-1809 ; Build-10.0.17763.0_ and earlier. `useNativeDriver` is [supported in Version-1903 and later](https://microsoft.github.io/react-native-windows/docs/win10-compat) so if your project is targeting that, you don't need to set this prop. +Windows only option that provides the option to disable the [native animation](https://reactnative.dev/docs/animated#using-the-native-driver) driver for React Native Windows projects targeting _Windows 10 Version-1809 ; Build-10.0.17763.0_ and earlier. `useNativeDriver` is [supported in Version-1903 and later](https://microsoft.github.io/react-native-windows/docs/win10-compat) so if your project is targeting that, you don't need to set this prop. ## Try it out @@ -180,6 +192,7 @@ Try it in Expo: https://expo.io/@community/react-native-action-sheet-example See the [example app](https://github.com/expo/react-native-action-sheet/tree/master/example). ### Usage + ``` $ cd example $ yarn @@ -195,6 +208,7 @@ $ yarn web ## Development ### Setup + ``` $ git clone git@github.com:expo/react-native-action-sheet.git $ cd react-native-action-sheet @@ -202,12 +216,15 @@ $ yarn ``` ### Build + We use [bob](https://github.com/react-native-community/bob). + ``` $ yarn build ``` ### Lint & Format + ``` // tsc $ yarn type-check diff --git a/example/ShowActionSheetButton.tsx b/example/ShowActionSheetButton.tsx index f63ed3f..ac956ad 100644 --- a/example/ShowActionSheetButton.tsx +++ b/example/ShowActionSheetButton.tsx @@ -1,9 +1,11 @@ import { ActionSheetOptions } from '@expo/react-native-action-sheet'; import { MaterialIcons, Entypo } from '@expo/vector-icons'; import * as React from 'react'; -import { Text, View, TextStyle, ViewStyle, findNodeHandle, Button } from 'react-native'; +import { Text, View, TextStyle, ViewStyle, findNodeHandle } from 'react-native'; -const icon = (name: string) => ; +const icon = (name: React.ComponentProps['name']) => ( + +); interface Props { title: string; @@ -34,7 +36,7 @@ export default class ShowActionSheetButton extends React.PureComponent { useModal: false, }; - _anchorRef = React.createRef