pdf_editor_aleon35_react_plugin
Advanced tools
Comparing version 1.0.22 to 1.0.24
@@ -11,4 +11,3 @@ "use strict"; | ||
var useCreateIframeAndLoadViewer = function useCreateIframeAndLoadViewer(_ref) { | ||
var domWindow = _ref.window, | ||
file = _ref.file, | ||
var file = _ref.file, | ||
fileName = _ref.fileName, | ||
@@ -15,0 +14,0 @@ tools = _ref.tools, |
{ | ||
"name": "pdf_editor_aleon35_react_plugin", | ||
"version": "1.0.22", | ||
"version": "1.0.24", | ||
"description": "", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
# hello | ||
Parameters | ||
## Core | ||
## Parameters | ||
### tools `Object` `{}` | ||
Control what tools are available in the UI. Available keys are `thumbnails`, `general`, `editing`, ... | ||
``` | ||
{ | ||
thumbnails: [ | ||
"zoom", | ||
"view-expansion" | ||
] | ||
} | ||
useCreateIframeAndLoadViewer({ | ||
tools: { | ||
thumbnails: ..., | ||
general: ..., | ||
editing: ..., | ||
}, | ||
...other parameters | ||
}); | ||
``` | ||
#### general `Object` `[]` | ||
| Field | Description | | ||
| ------- | ---------------- | | ||
| zoom | Enable zoom in/out of the document in view | | ||
| search | Enable search functions | | ||
| download | Enable downloading the document | | ||
| thumbnails | Enable a thumbnails panel | | ||
``` | ||
useCreateIframeAndLoadViewer({ | ||
tools: { | ||
general: [ | ||
"zoom", | ||
"search", | ||
"download", | ||
"thumbnails" | ||
], | ||
}, | ||
...other parameters | ||
}); | ||
``` | ||
#### thumbnails `Object` `[]` | ||
| Field | Description | | ||
| ------- | ---------------- | | ||
| zoom | Enable a slider above thumbnails to increase/decrease the size of the thumbnails | | ||
| expand | Enable the thumbnails bar to be expandable to the full screen | | ||
``` | ||
useCreateIframeAndLoadViewer({ | ||
tools: { | ||
thumbnails: [ | ||
"zoom", | ||
"expand" | ||
], | ||
}, | ||
...other parameters | ||
}); | ||
``` | ||
#### editing `Object` `[]` | ||
| Field | Description | | ||
| ------- | ---------------- | | ||
| remove | Enable the ability to remove pages | | ||
| rotation | Enable the rotation of individual pages | | ||
``` | ||
useCreateIframeAndLoadViewer({ | ||
tools: { | ||
editing: [ | ||
"remove", | ||
"rotation" | ||
], | ||
}, | ||
...other parameters | ||
}); | ||
``` |
@@ -0,9 +1,14 @@ | ||
import * as React from 'react'; | ||
declare module 'pdf_editor_aleon35_react_plugin' { | ||
export const useCreateIframeAndLoadViewer: ( | ||
props: { | ||
domWindow: any; | ||
file: string; | ||
fileName: string; | ||
tools: any; | ||
container: any; | ||
tools: { | ||
thumbnails?: ("zoom" | "expand")[]; | ||
general?: ("zoom" | "search" | "download" | "thumbnails")[]; | ||
editing?: ("remove" | "rotation")[]; | ||
}; | ||
container: React.MutableRefObject<HTMLElement | null> | (HTMLElement | null); | ||
} | ||
@@ -10,0 +15,0 @@ ) => { |
@@ -5,3 +5,2 @@ import { useEffect, useRef } from 'react'; | ||
export const useCreateIframeAndLoadViewer = ({ | ||
window: domWindow, | ||
file, | ||
@@ -8,0 +7,0 @@ fileName, |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
4548077
236
85