diff --git a/README.md b/README.md index 1cf3ce05c..1d1a42261 100644 --- a/README.md +++ b/README.md @@ -131,25 +131,27 @@ preview.show(fileId, accessToken, { | fileId | Box file ID | | accessToken | Either a string auth token or a token generator function, see below for details | -| Option | Default | Description | -| ------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| container | document.body | DOM node or selector where Preview should be placed | -| sharedLink | | Shared link URL | -| sharedLinkPassword | | Shared link password | -| collection | | List of file IDs to iterate over for previewing | -| header | `light` | String value of `none` or `dark` or `light` that controls header visibility and theme | -| logoUrl | | URL of logo to show in header | -| showAnnotations | false | Whether annotations and annotation controls are shown. This option will be overridden by viewer-specific annotation options if they are set. See [Box Annotations](https://github.com/box/box-annotations) for more details | -| showDownload | false | Whether download button is shown | -| autoFocus | true | Whether preview should focus itself when a file loads | -| useHotkeys | true | Whether hotkeys (keyboard shortcuts) are enabled | -| fixDependencies | false | Temporarily patches AMD to properly load Preview's dependencies. You may need to enable this if your project uses RequireJS | -| disableEventLog | false | Disables client-side `preview` event log. Previewing with this option enabled will not increment access stats (content access is still logged server-side) | -| fileOptions | {} | Mapping of file ID to file-level options. See the File Option table below for details | -| previewWMPref | `any` | String value of `all`, `any`, or `none` that sets how previews of watermarked files behave. See https://community.box.com/t5/Sharing-Content-with-Box/Watermarking-Files/ta-p/30766 for more information about watermarking and https://community.box.com/t5/Collaborate-By-Inviting-Others/Understanding-Collaborator-Permission-Levels/ta-p/144 for more information about permissions and collaboration roles.

`all` forces watermarked previews. If the file type supports watermarking, users with `can_preview` permissions will see a watermarked preview. If the file type cannot be watermarked, no preview is shown.

`any` is the default watermarking behavior in the Box Web Application. If the file type supports watermarking, users with `can_preview` permissions will see a watermarked preview. If the file type cannot be watermarked, users that have both `can_preview` and `can_upload` permissions will see a non-watermarked preview and no preview otherwise.

`none` forces non-watermarked previews. Users that have both `can_preview` and `can_upload` permissions will see a non-watermarked preview and no preview otherwise. | -| downloadWM | false | Whether the download of a watermarked file should be watermarked. This option does not affect non-watermarked files. If true, users will be able to download watermarked versions of supported file types as long as they have `can_preview` permissions (any collaboration role except for `Uploader`). | -| responseInterceptor | | Function to intercept responses. For an example see https://codepen.io/box-platform/pen/jLdxEv | -| requestInterceptor | | Function to intercept requests. For an example see https://codepen.io/box-platform/pen/jLdxEv | +| Option | Default | Description | +| --------------------------------------------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| container | document.body | DOM node or selector where Preview should be placed | +| sharedLink | | Shared link URL | +| sharedLinkPassword | | Shared link password | +| collection | | List of file IDs to iterate over for previewing | +| header | `light` | String value of `none` or `dark` or `light` that controls header visibility and theme | +| logoUrl | | URL of logo to show in header | +| showAnnotations | false | Whether annotations and annotation controls are shown. This option will be overridden by viewer-specific annotation options if they are set. See [Box Annotations](https://github.com/box/box-annotations) for more details | +| showDownload | false | Whether download button is shown | +| autoFocus | true | Whether preview should focus itself when a file loads | +| useHotkeys | true | Whether hotkeys (keyboard shortcuts) are enabled | +| fixDependencies | false | Temporarily patches AMD to properly load Preview's dependencies. You may need to enable this if your project uses RequireJS | +| disableEventLog | false | Disables client-side `preview` event log. Previewing with this option enabled will not increment access stats (content access is still logged server-side) | +| fileOptions | {} | Mapping of file ID to file-level options. See the File Option table below for details | +| previewWMPref | `any` | String value of `all`, `any`, or `none` that sets how previews of watermarked files behave. See https://community.box.com/t5/Sharing-Content-with-Box/Watermarking-Files/ta-p/30766 for more information about watermarking and https://community.box.com/t5/Collaborate-By-Inviting-Others/Understanding-Collaborator-Permission-Levels/ta-p/144 for more information about permissions and collaboration roles.

`all` forces watermarked previews. If the file type supports watermarking, users with `can_preview` permissions will see a watermarked preview. If the file type cannot be watermarked, no preview is shown.

`any` is the default watermarking behavior in the Box Web Application. If the file type supports watermarking, users with `can_preview` permissions will see a watermarked preview. If the file type cannot be watermarked, users that have both `can_preview` and `can_upload` permissions will see a non-watermarked preview and no preview otherwise.

`none` forces non-watermarked previews. Users that have both `can_preview` and `can_upload` permissions will see a non-watermarked preview and no preview otherwise. | +| downloadWM | false | Whether the download of a watermarked file should be watermarked. This option does not affect non-watermarked files. If true, users will be able to download watermarked versions of supported file types as long as they have `can_preview` permissions (any collaboration role except for `Uploader`). | +| viewers | {} | Maps options to a valid viewer type | +| viewers.Document.disableFontFace viewers.Presentation.disableFontFace | false | By default, fonts are converted to OpenType fonts and loaded via font face rules. If disabled, fonts will be rendered using a built-in font renderer that constructs the glyphs with primitive path commands. **Use this option at your own risk** | +| responseInterceptor | | Function to intercept responses. For an example see https://codepen.io/box-platform/pen/jLdxEv | +| requestInterceptor | | Function to intercept requests. For an example see https://codepen.io/box-platform/pen/jLdxEv | | File Option | Default | Description | | ------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/src/index.html b/src/index.html index 6431b1061..99ea4e4a1 100644 --- a/src/index.html +++ b/src/index.html @@ -1,12 +1,12 @@ - - - - - - + + + + + +