mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-20 15:18:08 +02:00
Code Activity

Merge pull request #17879 from ex37/master

Browse source 
Improve type definitions for the viewer
This commit is contained in:
Tim van der Meij 2024-04-14 16:35:02 +02:00 • committed by GitHub
commit e08de772ff
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 93 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

17
web/annotation_editor_params.js
View file

@ -13,8 +13,22 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
import { AnnotationEditorParamsType } from "pdfjs-lib";
/**
* @typedef {Object} AnnotationEditorParamsOptions
* @property {HTMLInputElement} editorFreeTextFontSize
* @property {HTMLInputElement} editorFreeTextColor
* @property {HTMLInputElement} editorInkColor
* @property {HTMLInputElement} editorInkThickness
* @property {HTMLInputElement} editorInkOpacity
* @property {HTMLButtonElement} editorStampAddImage
* @property {HTMLInputElement} editorFreeHighlightThickness
* @property {HTMLButtonElement} editorHighlightShowAll
*/
class AnnotationEditorParams {
/**
* @param {AnnotationEditorParamsOptions} options
@ -25,6 +39,9 @@ class AnnotationEditorParams {
this.#bindListeners(options);
}
/**
* @param {AnnotationEditorParamsOptions} options
*/
#bindListeners({
editorFreeTextFontSize,
editorFreeTextColor,

8
web/app.js
View file

@ -13,6 +13,12 @@
* limitations under the License.
*/
/** @typedef {import("./interfaces.js").IL10n} IL10n */
// eslint-disable-next-line max-len
/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
// eslint-disable-next-line max-len
/** @typedef {import("../src/display/api.js").PDFDocumentLoadingTask} PDFDocumentLoadingTask */
import {
animationStarted,
apiPageLayoutToViewerModes,
@ -96,7 +102,9 @@ const PDFViewerApplication = {
settled: false,
},
appConfig: null,
/** @type {PDFDocumentProxy} */
pdfDocument: null,
/** @type {PDFDocumentLoadingTask} */
pdfLoadingTask: null,
printService: null,
/** @type {PDFViewer} */

8
web/base_tree_viewer.js
View file

@ -43,14 +43,14 @@ class BaseTreeViewer {
}
/**
* @private
* @protected
*/
_dispatchEvent(count) {
throw new Error("Not implemented: _dispatchEvent");
}
/**
* @private
* @protected
*/
_bindLink(element, params) {
throw new Error("Not implemented: _bindLink");
@ -71,7 +71,9 @@ class BaseTreeViewer {
/**
* Prepend a button before a tree item which allows the user to collapse or
* expand all tree items at that level; see `_toggleTreeItem`.
* @private
* @param {HTMLDivElement} div
* @param {boolean|object} [hidden]
* @protected
*/
_addToggleButton(div, hidden = false) {
const toggler = document.createElement("div");

5
web/external_services.js
View file

@ -13,6 +13,8 @@
* limitations under the License.
*/
/** @typedef {import("./interfaces.js").IL10n} IL10n */
class BaseExternalServices {
constructor() {
if (this.constructor === BaseExternalServices) {
@ -28,6 +30,9 @@ class BaseExternalServices {
reportTelemetry(data) {}
/**
* @returns {Promise<IL10n>}
*/
async createL10n() {
throw new Error("Not implemented: createL10n");
}

7
web/grab_to_pan.js
View file

@ -17,10 +17,15 @@
// Class name of element which can be grabbed.
const CSS_CLASS_GRAB = "grab-to-pan-grab";
/**
* @typedef {Object} GrabToPanOptions
* @property {HTMLElement} element
*/
class GrabToPan {
/**
* Construct a GrabToPan instance for a given HTML element.
* @param {Element} options.element
* @param {GrabToPanOptions} options
*/
constructor({ element }) {
this.element = element;

2
web/password_prompt.js
View file

@ -13,6 +13,8 @@
* limitations under the License.
*/
/** @typedef {import("./overlay_manager.js").OverlayManager} OverlayManager */
import { PasswordResponses } from "pdfjs-lib";
/**

9
web/pdf_attachment_viewer.js
View file

@ -13,6 +13,10 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
// eslint-disable-next-line max-len
/** @typedef {import("./download_manager.js").DownloadManager} DownloadManager */
import { BaseTreeViewer } from "./base_tree_viewer.js";
import { getFilenameFromUrl } from "pdfjs-lib";
import { waitOnEventOrTimeout } from "./event_utils.js";
@ -27,6 +31,7 @@ import { waitOnEventOrTimeout } from "./event_utils.js";
/**
* @typedef {Object} PDFAttachmentViewerRenderParameters
* @property {Object|null} attachments - A lookup table of attachment objects.
* @property {boolean} [keepRenderedCapability]
*/
class PDFAttachmentViewer extends BaseTreeViewer {
@ -56,7 +61,7 @@ class PDFAttachmentViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
async _dispatchEvent(attachmentsCount) {
this._renderedCapability.resolve();
@ -87,7 +92,7 @@ class PDFAttachmentViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_bindLink(element, { content, filename }) {
element.onclick = () => {

2
web/pdf_cursor_tools.js
View file

@ -13,6 +13,8 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
import { AnnotationEditorType, shadow } from "pdfjs-lib";
import { CursorTool, PresentationModeState } from "./ui_utils.js";
import { GrabToPan } from "./grab_to_pan.js";

6
web/pdf_document_properties.js
View file

@ -13,6 +13,12 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
/** @typedef {import("./interfaces.js").IL10n} IL10n */
/** @typedef {import("./overlay_manager.js").OverlayManager} OverlayManager */
// eslint-disable-next-line max-len
/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
import { getPageSizeInches, isPortraitOrientation } from "./ui_utils.js";
import { PDFDateString } from "pdfjs-lib";

14
web/pdf_layer_viewer.js
View file

@ -13,6 +13,12 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
// eslint-disable-next-line max-len
/** @typedef {import("../src/optional_content_config.js").OptionalContentConfig} OptionalContentConfig */
// eslint-disable-next-line max-len
/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
import { BaseTreeViewer } from "./base_tree_viewer.js";
/**
@ -25,7 +31,7 @@ import { BaseTreeViewer } from "./base_tree_viewer.js";
* @typedef {Object} PDFLayerViewerRenderParameters
* @property {OptionalContentConfig|null} optionalContentConfig - An
* {OptionalContentConfig} instance.
* @property {PDFDocument} pdfDocument - A {PDFDocument} instance.
* @property {PDFDocumentProxy} pdfDocument - A {PDFDocument} instance.
*/
class PDFLayerViewer extends BaseTreeViewer {
@ -48,7 +54,7 @@ class PDFLayerViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_dispatchEvent(layersCount) {
this.eventBus.dispatch("layersloaded", {
@ -58,7 +64,7 @@ class PDFLayerViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_bindLink(element, { groupId, input }) {
const setVisibility = () => {
@ -97,7 +103,7 @@ class PDFLayerViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_addToggleButton(div, { name = null }) {
super._addToggleButton(div, /* hidden = */ name === null);

15
web/pdf_outline_viewer.js
View file

@ -13,6 +13,13 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
// eslint-disable-next-line max-len
/** @typedef {import("./download_manager.js").DownloadManager} DownloadManager */
/** @typedef {import("./interfaces.js").IPDFLinkService} IPDFLinkService */
// eslint-disable-next-line max-len
/** @typedef {import("../src/display/api.js").PDFDocumentProxy} PDFDocumentProxy */
import { BaseTreeViewer } from "./base_tree_viewer.js";
import { SidebarView } from "./ui_utils.js";
@ -27,7 +34,7 @@ import { SidebarView } from "./ui_utils.js";
/**
* @typedef {Object} PDFOutlineViewerRenderParameters
* @property {Array|null} outline - An array of outline objects.
* @property {PDFDocument} pdfDocument - A {PDFDocument} instance.
* @property {PDFDocumentProxy} pdfDocument - A {PDFDocument} instance.
*/
class PDFOutlineViewer extends BaseTreeViewer {
@ -75,7 +82,7 @@ class PDFOutlineViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_dispatchEvent(outlineCount) {
this._currentOutlineItemCapability = Promise.withResolvers();
@ -98,7 +105,7 @@ class PDFOutlineViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_bindLink(
element,
@ -162,7 +169,7 @@ class PDFOutlineViewer extends BaseTreeViewer {
}
/**
* @private
* @protected
*/
_addToggleButton(div, { count, items }) {
let hidden = false;

3
web/pdf_presentation_mode.js
View file

@ -13,6 +13,9 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
/** @typedef {import("./pdf_viewer.js").PDFViewer} PDFViewer */
import {
normalizeWheelEventDelta,
PresentationModeState,

3
web/pdf_print_service.js
View file

@ -13,6 +13,9 @@
* limitations under the License.
*/
// eslint-disable-next-line max-len
/** @typedef {import("./interfaces.js").IPDFPrintServiceFactory} IPDFPrintServiceFactory */
import {
AnnotationMode,
PixelsPerInch,

3
web/pdf_sidebar.js
View file

@ -13,6 +13,9 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
/** @typedef {import("./interfaces.js").IL10n} IL10n */
import {
docStyle,
PresentationModeState,

2
web/secondary_toolbar.js
View file

@ -13,6 +13,8 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
import {
CursorTool,
ScrollMode,

2
web/toolbar.js
View file

@ -13,6 +13,8 @@
* limitations under the License.
*/
/** @typedef {import("./event_utils.js").EventBus} EventBus */
import { AnnotationEditorType, ColorPicker, noContextMenu } from "pdfjs-lib";
import {
DEFAULT_SCALE,