electron/docs
arno renevier 81bdba67ec
feat: Implement password delegate for NSS (#41205)
* feat: Implement password delegate for NSS (#41188)

Introduce an app event client-certificate-request-password. It allows
the user to display a UI to prompt for the password.

An alternative would have been to implement a class similar to
CryptoModulePasswordDialogView, to provide the UI. This might have been
simpler for the user, comparing to letting them implement the UI. But it
seems like electron does not have an i18n framework, so it's not
possible to provide a locale aware UI.

* fix lint:markdown error

* address review comments

* use a trampoline handler in JS. The api exposed is now app.setClientCertRequestPasswordHandler
* use properties on the Event object instead of positional parameters
* remove ChromeNSSCryptoModuleDelegate::OnPassword in favor of args->GetNext(&password_)

* address review comments second round

- backslash escape parametrized TypeScript
- rename hostName param to hostname
- use base::ScopedAllowBaseSyncPrimitivesForTesting
- and then, rename ChromeNSSCryptoModuleDelegate to ElectronNSSCryptoModuleDelegate

* Update docs/api/app.md

Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>

* Update docs/api/app.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

---------

Co-authored-by: Arno Renevier <arnaud@switchboard.app>
Co-authored-by: Sam Maddock <samuel.maddock@gmail.com>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2024-07-17 09:48:03 -04:00
..
api feat: Implement password delegate for NSS (#41205) 2024-07-17 09:48:03 -04:00
development build: remove CircleCI (#42844) 2024-07-15 14:26:41 -04:00
fiddles docs: fixing typo in dark mode fiddle and doc (#42112) 2024-05-13 10:50:55 +02:00
images docs: Update code signing documentation (#41535) 2024-03-08 10:02:39 -08:00
tutorial docs(autoUpdater): document static storage strategy (#42690) 2024-07-02 19:06:38 +02:00
README.md feat: remove File.path (#42053) 2024-05-15 11:07:23 -07:00
breaking-changes.md feat: duplicate navigation related APIs to `contents.navigationHistory` (#41752) 2024-06-05 09:34:47 -07:00
experimental.md docs: Markdown linting and typo (#35568) 2022-09-13 13:49:11 -07:00
faq.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
glossary.md docs: update docs.microsoft.com links to learn.microsoft.com (#37707) 2023-03-29 12:16:44 +02:00
styleguide.md chore: disallow shortcut reference links in docs Markdown (#36860) 2023-01-16 10:22:49 +01:00

README.md

Official Guides

Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.

FAQ

There are questions that are asked quite often. Check this out before creating an issue:

Guides and Tutorials

Getting started

Learning the basics

Advanced steps

Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.


API References

Custom DOM Elements:

Modules for the Main Process:

Modules for the Renderer Process (Web Page):

Modules for Both Processes:

Development

See development/README.md