Add a note on SVG mode deprecation

wojtekmaj · Oct 7, 2022 · b242d9d · b242d9d
1 parent f52fcf7
commit b242d9d
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.md b/README.md
@@ -390,7 +390,7 @@ Loads a document passed using `file` prop.
 | onSourceError      | Function called in case of an error while retrieving document source from `file` prop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | n/a                                                   | `(error) => alert('Error while retrieving document source! ' + error.message)`                                                                                                                                                                                                                                   |
 | onSourceSuccess    | Function called when document source is successfully retrieved from `file` prop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | n/a                                                   | `() => alert('Document source retrieved!')`                                                                                                                                                                                                                                                                      |
 | options            | An object in which additional parameters to be passed to PDF.js can be defined. For a full list of possible parameters, check [PDF.js documentation on DocumentInitParameters](https://mozilla.github.io/pdf.js/api/draft/module-pdfjsLib.html#~DocumentInitParameters).                                                                                                                                                                                                                                                                                                                                                                        | n/a                                                   | `{ cMapUrl: 'cmaps/', cMapPacked: true }`                                                                                                                                                                                                                                                                        |
-| renderMode         | Rendering mode of the document. Can be `"canvas"`, `"svg"` or `"none"`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | `"canvas"`                                            | `"svg"`                                                                                                                                                                                                                                                                                                          |
+| renderMode         | Rendering mode of the document. Can be `"canvas"`, `"svg"` or `"none"`.<br />**Warning**: SVG render mode is no longer maintained and may be removed in the future.                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | `"canvas"`                                            | `"svg"`                                                                                                                                                                                                                                                                                                          |
 | rotate             | Rotation of the document in degrees. If provided, will change rotation globally, even for the pages which were given `rotate` prop of their own. `90` = rotated to the right, `180` = upside down, `270` = rotated to the left.                                                                                                                                                                                                                                                                                                                                                                                                                 | n/a                                                   | `90`                                                                                                                                                                                                                                                                                                             |
 
 ### Page