electron/docs/tutorial/examples.md
David Sanders d94f35a8f6
chore: disallow shortcut reference links in docs Markdown (#36860)
* chore: disallow shortcut reference links in docs Markdown

* docs: clean up shortcut-style links
2023-01-16 10:22:49 +01:00

3 KiB

title description slug hide_title
Examples Overview A set of examples for common Electron features examples false

Examples Overview

In this section, we have collected a set of guides for common features that you may want to implement in your Electron application. Each guide contains a practical example in a minimal, self-contained example app. The easiest way to run these examples is by downloading Electron Fiddle.

Once Fiddle is installed, you can press on the "Open in Fiddle" button that you will find below code samples like the following one:

window.addEventListener('DOMContentLoaded', () => {
  const replaceText = (selector, text) => {
    const element = document.getElementById(selector)
    if (element) element.innerText = text
  }

  for (const type of ['chrome', 'node', 'electron']) {
    replaceText(`${type}-version`, process.versions[type])
  }
})

If there is still something that you do not know how to do, please take a look at the API as there is a chance it might be documented just there (and also open an issue requesting the guide!).

Guide Description
Message ports This guide provides some examples of how you might use MessagePorts in your app to communicate different processes.
Device access Learn how to access the device hardware (Bluetooth, USB, Serial).
Keyboard shortcuts Configure local and global keyboard shortcuts for your Electron application.
Multithreading With Web Workers, it is possible to run JavaScript in OS-level threads
Offscreen rendering Offscreen rendering lets you obtain the content of a BrowserWindow in a bitmap, so it can be rendered anywhere.
Spellchecker Learn how to use the built-in spellchecker, set languages, etc.
Web embeds Discover the different ways to embed third-party web content in your application.

How to...?

You can find the full list of "How to?" in the sidebar. If there is something that you would like to do that is not documented, please join our Discord server and let us know!