Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add missing documentation for <webview> methods #14413

Merged
merged 1 commit into from Sep 3, 2018

Conversation

miniak
Copy link
Contributor

@miniak miniak commented Sep 1, 2018

Description of Change

There are several public methods exposed by <webview> (web-view.js) missing in the documentation and therefore electron.d.ts

  • downloadURL(url: string): void;
  • isLoadingMainFrame(): boolean;
  • isCurrentlyAudible(): boolean;
  • getZoomFactor(callback: (zoomFactor: number) => void): void;
  • getZoomLevel(callback: (zoomLevel: number) => void): void;
  • setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
  • setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
Checklist
  • PR description included and stakeholders cc'd
  • relevant documentation is changed or added
  • PR title follows semantic commit guidelines
Release Notes

Notes: Added missing documentation for <webview> methods.

@@ -267,6 +267,12 @@ webview.addEventListener('dom-ready', () => {
Loads the `url` in the webview, the `url` must contain the protocol prefix,
e.g. the `http://` or `file://`.

#### `contents.downloadURL(url)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/contents/<webview>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miniak miniak self-assigned this Sep 1, 2018
@MarshallOfSound MarshallOfSound merged commit e828348 into master Sep 3, 2018
@release-clerk
Copy link

release-clerk bot commented Sep 3, 2018

Release Notes Persisted

Added missing documentation for <webview> methods.

@MarshallOfSound MarshallOfSound deleted the miniak/webview-docs branch September 3, 2018 03:27
@trop
Copy link
Contributor

trop bot commented Sep 3, 2018

An error occurred while attempting to backport this PR to "2-0-x",
you will need to perform this backport manually

@trop
Copy link
Contributor

trop bot commented Sep 3, 2018

An error occurred while attempting to backport this PR to "3-0-x",
you will need to perform this backport manually

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants