Merge pull request #19 from Vadko/21.03-custom-done-button-title

feat: done button title for iOS

Author: Vadko

README.md

@@ -17,7 +17,7 @@ This library requires React Native 0.76.3 or newer. It is compatible with Expo S
 npx expo install react-native-file-viewer-turbo
 ```
 
-Add plugin to your `app.json` or `app.config.js` (it will modify AndroidManifest.xml as described below in extra step for Android section):
+Add plugin to your `app.json` or `app.config.js` with preferred `mimeTypes` (it will modify AndroidManifest.xml as described below in extra step for Android section):
 
 ```json
 {
@@ -26,7 +26,7 @@ Add plugin to your `app.json` or `app.config.js` (it will modify AndroidManifest
       "react-native-file-viewer-turbo",
       {
         "mimeTypes": [
-          "*/*" // or any other mimeType you want to specifically include
+          "*/*"
         ]
       }
     ]
@@ -69,6 +69,25 @@ For example, if you know upfront that your app is supposed to open PDF files, th
 </manifest>
 ```
 
+## API
+
+### `open(filepath: string, options?: Options): Promise<void>`
+
+| Parameter              | Type   | Description                                                                                                                                                                                                                                         |
+| ---------------------- | ------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **filepath**           | string | The absolute path where the file is stored. The file needs to have a valid extension to be successfully detected. Use [expo-file-system constants](https://docs.expo.dev/versions/latest/sdk/filesystem/#constants) to determine the absolute path correctly. |
+| **options** (optional) | Object | Some options to customize the behaviour. See below.                                                                                                                                                                                                 |
+
+#### Options
+
+| Parameter                          | Type    | Platform     | Description                                                                                        |
+|------------------------------------|---------|--------------|----------------------------------------------------------------------------------------------------|
+| **displayName** (optional)         | string  | iOS          | Customize the QuickLook title                                                                      |
+| **doneButtonTitle** (optional)     | string  | iOS          | Customize UINavigationController Done button title                                                 |
+| **onDismiss** (optional)           | function | iOS, Android | Callback invoked when the viewer is being dismissed                                                |
+| **showOpenWithDialog** (optional)  | boolean | Android      | If there is more than one app that can open the file, show an _Open With_ dialogue box             |
+| **showAppsSuggestions** (optional) | boolean | Android      | If there is not an installed app that can open the file, open the Play Store with suggested apps   |
+
 **IMPORTANT**: Try to be as granular as possible when defining your own queries. This might affect your Play Store approval, as mentioned in [Package visibility filtering on Android](https://developer.android.com/training/package-visibility).
 
 > If you publish your app on Google Play, your app's use of this permission is subject to approval based on an upcoming policy.
@@ -191,26 +210,6 @@ try {
 }
 ```
 
-## API
-
-### `open(filepath: string, options?: Object): Promise<void>`
-
-| Parameter              | Type   | Description                                                                                                                                                                                                                                         |
-| ---------------------- | ------ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **filepath**           | string | The absolute path where the file is stored. The file needs to have a valid extension to be successfully detected. Use [expo-file-system constants](https://docs.expo.dev/versions/latest/sdk/filesystem/#constants) to determine the absolute path correctly. |
-| **options** (optional) | Object | Some options to customize the behaviour. See below.                                                                                                                                                                                                 |
-
-#### Options
-
-| Parameter                          | Type     | Description                                                                                                      |
-| ---------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
-| **displayName** (optional)         | string   | Customize the QuickLook title (iOS only).                                                                        |
-| **onDismiss** (optional)           | function | Callback invoked when the viewer is being dismissed (iOS and Android only).                                      |
-| **showOpenWithDialog** (optional)  | boolean  | If there is more than one app that can open the file, show an _Open With_ dialogue box (Android only).           |
-| **showAppsSuggestions** (optional) | boolean  | If there is not an installed app that can open the file, open the Play Store with suggested apps (Android only). |
-
-
-
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

example/src/App.tsx

@@ -29,7 +29,10 @@ export default function App() {
       toFile: localFile,
     };
     downloadFile(options).promise.then(() =>
-      open(localFile, { onDismiss: () => console.log('dismissed!') })
+      open(localFile, {
+        onDismiss: () => console.log('dismissed!'),
+        doneButtonTitle: 'Custom done',
+      })
         .then(console.log)
         .catch(console.error)
     );

ios/FileViewerTurbo.mm

@@ -164,27 +164,35 @@ - (void)dismissView:(id)sender {
                   options:(NSDictionary *)options
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject) {
-  
+
       NSString *displayName = options[@"displayName"];
-      File *file = [[File alloc] initWithPath:path title:displayName];
+      NSString *doneButtonTitle = options[@"doneButtonTitle"];
 
+      File *file = [[File alloc] initWithPath:path title:displayName];
+
       QLPreviewController *controller = [[CustomQLViewController alloc] initWithFile:file identifier:invocationId];
       controller.delegate = self;
-  
+
       if (@available(iOS 13.0, *)) {
           [controller setModalInPresentation: true];
       }
-  
+
       UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:controller];
-      controller.navigationItem.leftBarButtonItem = [[UIBarButtonItem alloc] initWithBarButtonSystemItem:UIBarButtonSystemItemDone target:self action:@selector(dismissView:)];
 
-       if ([QLPreviewController canPreviewItem:file]) {
-         [[FileViewerTurbo topViewController] presentViewController:navigationController animated:YES completion:^{
-             resolve(nil);
-           }];
-       } else {
-           reject(@"FileViewerTurbo:open", @"File not supported", nil);
-       }
+      if (doneButtonTitle) {
+        controller.navigationItem.leftBarButtonItem = [[UIBarButtonItem alloc] initWithTitle:doneButtonTitle style:UIBarButtonItemStylePlain target:self action:@selector(dismissView:)];
+      } else {
+        controller.navigationItem.leftBarButtonItem = [[UIBarButtonItem alloc] initWithBarButtonSystemItem:UIBarButtonSystemItemDone target:self action:@selector(dismissView:)];
+
+      }
+ 
+      if ([QLPreviewController canPreviewItem:file]) {
+        [[FileViewerTurbo topViewController] presentViewController:navigationController animated:YES completion:^{
+          resolve(nil);
+        }];
+      } else {
+        reject(@"FileViewerTurbo:open", @"File not supported", nil);
+      }
 };
 
 #ifdef RCT_NEW_ARCH_ENABLED

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-file-viewer-turbo",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Native file viewer for react-native - now with TurboModules support",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",

src/NativeFileViewerTurbo.ts

@@ -4,6 +4,7 @@ import type { EventEmitter } from 'react-native/Libraries/Types/CodegenTypes';
 
 export type Options = {
   displayName?: string;
+  doneButtonTitle?: string;
   showOpenWithDialog?: boolean;
   showAppsSuggestions?: boolean;
 };