@txtextcontrol/tx-react-ds-document-editor
v3.5.0
Published
TX Text Control Document Editor for React.
Downloads
454
Readme
TX Text Control Document Services HTML5 Document Editor (React version)
This library offers a HTML5 based rich text editor for TX Text Control DS Server. Give your users an MS Word compatible document editor to create powerful reporting templates anywhere - in any HTML5-based browser including Google Chrome, Firefox, Safari and Internet Explorer.
Requirements
This version requires TX Text Control DS Server version 3.1.1.
Installation
npm install @txtextcontrol/tx-react-ds-document-editor
Usage
Your App.js
could look like this, for example (the only mandatory attributes are width
, height
and serviceURL
):
import DocumentEditor from '@txtextcontrol/tx-react-ds-document-editor'
function App() {
return (
<DocumentEditor
style={{width:"1024px", height:"1024px" }}
serviceURL="https://your.server.com/documentservices"
authSettings={{clientId:"dsserver.u5NQQHkgjmCRAOeChUVc19zNFJ9aivKz", clientSecret:"tPGgkutg8oYuSHPbfuRfE5DMf9arUCEg"}}></DocumentEditor>
);
}
Possible attributes
- style (object)
- width (string) - The width of the Document Editor in pixel 'px' or in percentage '%' relative to the container's width.
- height (string) - The height of the Document Editor in pixel 'px' or in percentage '%' relative to the container's height.
- serviceURL (string) - The server which is hosting your installation of Text Control DS Server.
- authSettings (object)
- clientId (string) - The OAuth client ID.
- clientSecret (string) - The OAuth client secret.
- accessToken (string) - The OAuth Access Token.
- editMode (string) - Sets whether the document's text is read-only, can be selected or is editable. Possible values are
'Edit'
,'ReadAndSelect'
,'ReadOnly'
and'UsePassword'
. - contextMenusEnabled (boolean) - Sets whether a right click opens a context menu or not.
- formattingPrinter (string) - The name of a printer the text dimensions and capabilities of which are used to format the document.
- culture (string) - The culture (e. g.
'de-DE'
). Affects date and time string formats, for example. - uiCulture (string) - The user interface culture (e. g.
'en-US'
). Affects the string resource language. - userNames (string[]) - An array of names specifying users who have access to editable regions. When a document is set to read-only all editable regions that are related to these users can be edited.
- reconnectTimeout (number) - Time in seconds before stopping reconnection attempts after a connection loss.
- customQueryParams (Object.<string, any>) - Specifies user-definable query parameters which are added to the query string of each HTTP request.
- onLoad (function) - Is be executed as soon as the main 'TXTextControl' object is loaded.