Package Exports
- react-native-webview-quilljs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-native-webview-quilljs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
React Native Webview Quilljs
Quill.js editor and viewer components with no native code for React Native apps.
Try it in Expo
Installation
npm install --save react-native-webview-quilljs
or
yarn add react-native-webview-quilljs
and then
import {WebViewQuillEditor, WebViewQuillViewer} from 'react-native-webview-quilljs'
Usage
This package can be used to create both an editor and a viewer
Creating a Quill.js editor with the standard toolbar:
<WebViewQuillEditor
ref={component => (this.webViewQuillEditor = component)}
getDeltaCallback={this.getDeltaCallback}
contentToDisplay={contentToDisplay}
onLoad={this.onLoadCallback}
/>
This component accepts the following props:
- ref
- getDeltaCallback
- contentToDisplay
Name | Required | Description |
---|---|---|
ref | yes | A reference to the editor componment to be used to retrieve its contents using this.webViewQuillEditor.getDelta(); |
getDeltaCallback | no | Function called in response to a call to this.webViewQuillEditor.getDelta(). It will receive a Delta object containing the contents of editor |
contentToDisplay | no | A Delta object that will be displayed by the editor when it mounts |
onLoad | no | A function called when the Editor finishes loading |
onDeltaChangeCallback | no | Function called when the contents of Quill editor have changed. The function receives a delta containing the new contents, the old contents, and source as described in the Quill.js API documentation |
Creating a Delta viewer that can display content created with Quill.js:
<WebViewQuillViewer
ref={component => (this.webViewQuillViewer = component)}
contentToDisplay={this.state.messageDelta}
onLoad={this.onLoadCallback}
/>
This component accepts the following props:
- ref
- contentToDisplay
Name | Required | Description |
---|---|---|
ref | yes | A reference to the editor componment to be used to update its contents using this.webViewQuillViewer.sendContentToViewer(delta); |
contentToDisplay | no | A Delta object that will be displayed by the viewer when it mounts |
onLoad | no | A function called when the Editor finishes loading |
Changelog
0.3.20
- Added copy and paste of HTML
0.3.10
- Revert file access features from 0.3.0.
0.3.0
- Library no longer relies on accessing WebView files from the Internet. All files needed by both the Editor and Viewer are included with the packages.
- Fonts display correctly on iOS devices
0.2.5
- Added onDeltaChangeCallback property to Editor
LICENSE
MIT