npm
/
react-native-autoheight-webview
Obserwuj 10
Gwiazdka 0
Forkuj 0
Kod Problemy 0 Pull Requests 0 Wydania 23 Wiki Aktywność
Przeglądaj źródła

Update Readme

iou90 4 lat temu
rodzic
817f498921
commit
0cb95686e0
1 zmienionych plików z 13 dodań i 13 usunięć
Zunifikowany widok Pokaż statystyki zmian
  1. 13
    13
      README.md

+ 13
- 13
README.md Wyświetl plik

55
55
56 
 | Prop                         | Default |                                                      Type                                                       | Description                                                                                                                                                                                                  |
 56 
 | Prop                         | Default |                                                      Type                                                       | Description                                                                                                                                                                                                  |
57 
 | :--------------------------- | :-----: | :-------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 57 
 | :--------------------------- | :-----: | :-------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
58 
-| style                        |    -    |                                              `ViewPropTypes.style`                                              | The width of this component will be the width of screen by default, if there are some text selection issues on iOS, the width should be reduced more than 15 and the marginTop should be added more than 35. |
59 
-| customScript                 |    -    |                                               `PropTypes.string`                                                | -                                                                                                                                                                                                            |
60 
-| customStyle                  |    -    |                                               `PropTypes.string`                                                | The custom css content will be added to the page's `<head>`.                                                                                                                                                 |
61 
-| onSizeUpdated                |    -    |                                                `PropTypes.func`                                                 | Either updated height or width will trigger onSizeUpdated.                                                                                                                                                   |
62 
-| files                        |    -    | `PropTypes.arrayOf(PropTypes.shape({ href: PropTypes.string, type: PropTypes.string, rel: PropTypes.string }))` | Using local or remote files. To add local files: Add files to android/app/src/main/assets/ (depends on baseUrl) on android; add files to web/ (depends on baseUrl) on iOS.                                   |
63 
-| source                       |    -    |                                               `PropTypes.object`                                                | BaseUrl now contained by source. 'web/' by default on iOS; 'file:///android_asset/' by default on Android or uri.                                                                                            |
64 
-| scalesPageToFit              |  false  |                                                `PropTypes.bool`                                                 | False by default (different from react-native-webview which true by default on Android). When scalesPageToFit was enabled, it will apply the scale of the page directly instead of using viewport meta script.    |
65 
-| scrollEnabledWithZoomedin                     |  false   |                                                `PropTypes.bool`                                                 | Making the webview scrollable on iOS when zoomed in even if scrollEnabled is false.                                                                        |
66 
-| zoomable                     |  true   |                                                `PropTypes.bool`                                                 | Only works on iOS when disable scalesPageToFit, in other conditions, using custom scripts to create viewport meta to disable zooming.                                                                        |
67 
-| showsVerticalScrollIndicator |  false  |                                                `PropTypes.bool`                                                 | False by default (different from react-native-webview).                                                                                                                                                      |
68 
-| showsVerticalScrollIndicator |  false  |                                                `PropTypes.bool`                                                 | False by default (different from react-native-webview).                                                                                                                                                      |
69 
-| originWhitelist              |  ['*']  |                                      `PropTypes.arrayOf(PropTypes.string)`                                      | -                                                                                                                                                                                                            |
58 
+| __style__                        |    -    |                                              `ViewPropTypes.style`                                              | The width of this component will be the width of screen by default, if there are some text selection issues on iOS, the width should be reduced more than 15 and the marginTop should be added more than 35. |
59 
+| __customScript__                 |    -    |                                               `PropTypes.string`                                                | -                                                                                                                                                                                                            |
60 
+| __customStyle__                  |    -    |                                               `PropTypes.string`                                                | The custom css content will be added to the page's `<head>`.                                                                                                                                                 |
61 
+| __onSizeUpdated__                |    -    |                                                `PropTypes.func`                                                 | Either updated height or width will trigger onSizeUpdated.                                                                                                                                                   |
62 
+| __files__                        |    -    | `PropTypes.arrayOf(PropTypes.shape({ href: PropTypes.string, type: PropTypes.string, rel: PropTypes.string }))` | Using local or remote files. To add local files: Add files to android/app/src/main/assets/ (depends on baseUrl) on android; add files to web/ (depends on baseUrl) on iOS.                                   |
63 
+| __source__                       |    -    |                                               `PropTypes.object`                                                | BaseUrl now contained by source. 'web/' by default on iOS; 'file:///android_asset/' by default on Android or uri.                                                                                            |
64 
+| __scalesPageToFit__              |  false  |                                                `PropTypes.bool`                                                 | False by default (different from react-native-webview which true by default on Android). When scalesPageToFit was enabled, it will apply the scale of the page directly.    |
65 
+| __scrollEnabledWithZoomedin__                     |  false   |                                                `PropTypes.bool`                                                 | Making the webview scrollable on iOS when zoomed in even if scrollEnabled is false.                                                                        |
66 
+| __zoomDisabled__                     |  false   |                                                `PropTypes.bool`                                                 | ZoomDisabled with scalesPageToFit may cause some layout issues on Android, for these conditions, using __customScript__ prop instead to apply custom viewport meta.                                                                        |
67 
+| __showsVerticalScrollIndicator__ |  false  |                                                `PropTypes.bool`                                                 | False by default (different from react-native-webview).                                                                                                                                                      |
68 
+| __showsVerticalScrollIndicator__ |  false  |                                                `PropTypes.bool`                                                 | False by default (different from react-native-webview).                                                                                                                                                      |
69 
+| __originWhitelist__              |  ['*']  |                                      `PropTypes.arrayOf(PropTypes.string)`                                      |  Validate any origin by default cause of most cases using raw html concerns.                                                                                                                                                                                                           |
70
70
71 
 ## demo
 71 
 ## demo
72
72
77 
 You may have to use yarn to install the dependencies of the demo and remove "demo/node_modules/react-native-autoheight-webview/demo" manually, cause of installing a local package with npm will create symlink, but there is no supporting of React Native to symlink (https://github.com/facebook/watchman/issues/105) and "yarn install" ignores "files" from local dependencies (https://github.com/yarnpkg/yarn/issues/2822).
 77 
 You may have to use yarn to install the dependencies of the demo and remove "demo/node_modules/react-native-autoheight-webview/demo" manually, cause of installing a local package with npm will create symlink, but there is no supporting of React Native to symlink (https://github.com/facebook/watchman/issues/105) and "yarn install" ignores "files" from local dependencies (https://github.com/yarnpkg/yarn/issues/2822).
78 
 For android, you may have to copy the "Users\UserName\.android\debug.keystore" to "demo/android/app/".
 78 
 For android, you may have to copy the "Users\UserName\.android\debug.keystore" to "demo/android/app/".
79
79
80 
-## supporting rnaw
80 
+## supporting rnahw
81
81
82 
 One-time donation via PayPal:
 82 
 One-time donation via PayPal:
83
83