ZenBrowserMirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/zen-browser/pdf.js.git synced 2025-07-09 09:45:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Include the /Order array, if available, when parsing the Optional Content configuration

Browse source 
The `/Order` array is used to improve the display of Optional Content groups in PDF viewers, and it allows a PDF document to e.g. specify that Optional Content groups should be displayed as a (collapsable) tree-structure rather than as just a list.

Note that not all available Optional Content groups must be present in the `/Order` array, and PDF viewers will often (by default) hide those toggles in the UI.
To allow us to improve the UX around toggling of Optional Content groups, in the default viewer, these hidden-by-default groups are thus appended to the parsed `/Order` array under a *custom* nesting level (with `name == null`).

Finally, the patch also slightly tweaks an `OptionalContentConfig` related JSDoc-comment in the API.
This commit is contained in:
Jonas Jenwald 2020-08-06 20:59:46 +02:00
parent 9ba5f9fa34
commit 2393443e73
3 changed files with 68 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/display/api.js
View file

@ -778,9 +778,9 @@ class PDFDocumentProxy {
}
/**
* @returns {Promise<OptionalContentConfig | null>} A promise that is resolved
* with an {@link OptionalContentConfig} that has all the optional content
* groups, or `null` if the document does not have any.
* @returns {Promise<OptionalContentConfig>} A promise that is resolved with
* an {@link OptionalContentConfig} that contains all the optional content
* groups (assuming that the document has any).
*/
getOptionalContentConfig() {
return this._transport.getOptionalContentConfig();