Okno O aplikaci v Electronu: verze, podpora a odkazy
Zobrazte v okně O aplikaci v Electronu verzi vaší aplikace a odkazy, které potřebují vaši uživatelé nebo podpora. Praktický návod s ukázkami kódu.
Živá ukázka
Toto je About box samotné aplikace AboutTheApp. Přepnutím varianty uvidíte další podoby. Kód níže zobrazí přesně tento box. Pro svou aplikaci v něm změňte alias.
<script src="https://aboutthe.app/embed/web/0.3.8/card.js" integrity="sha384-xbrze16qslpxxqa0btKjJLhz6NtQVPTbAnS/0lQyyJKYHxPSqH7fyP3zv9aX6kc2" crossorigin="anonymous" async></script>
<about-the-app alias="aboutthe.app" variant="card" api-base="https://aboutthe.app/api/v1" visual-style="default" palette="default" appearance="auto"></about-the-app>Co má uživatel v okně O aplikaci najít
Základem je název a verze právě spuštěné aplikace. Když ji uživatel pošle podpoře spolu s popisem problému, tým může ověřit, zda se chyba týká daného vydání.
Doplňte odkazy, které uživatelům pomohou pokračovat: návod, kontakt na podporu nebo místo pro hlášení chyb. Podle aplikace se hodí také přehled změn, web projektu, údaje o autorovi a licence použitých komponent. Další příklady najdete v průvodci co patří na obrazovku O aplikaci.
Kdy použít vestavěný panel a kdy vlastní dialog
Pro základní údaje může stačit vestavěný panel Electronu. V app.setAboutPanelOptions nastavíte například název, verzi aplikace a copyright. Některé další volby se liší podle operačního systému.
Vlastní dialog se hodí, když chcete informace uspořádat stejně na všech platformách, přidat nápovědu a podporu nebo zobrazit změny konkrétního vydání. Protože okno Electronu zobrazuje webovou stránku, můžete takový dialog vytvořit pomocí HTML, CSS a JavaScriptu.
Jak si usnadnit správu obsahu okna
Verze musí odpovídat spuštěné aplikaci, ale adresa podpory nebo dokumentace se může změnit nezávisle na vydání. Při návrhu okna proto zvažte i to, odkud se tyto údaje berou a kdo je bude udržovat.
Jednou z možností je AboutTheApp: připravený prvek zobrazí verzi předanou aplikací a doplní spravované odkazy, poznámky k vydání a licenční údaje. Odkazy a další spravovaný obsah tak můžete upravit bez nového sestavení aplikace; prvek je načte při dalším načtení stránky okna. Následující příklad ukazuje zapojení do Electronu.
Zapojte hotový prvek O aplikaci ve 3 krocích
Prvek O aplikaci běží na stránce okna, ale verzi aplikace zná hlavní proces. Preload skript předá verzi z hlavního procesu na stránku.
- 1
Připravte informace a odkazy
V AboutTheApp vytvořte produkt a doplňte odkazy na dokumentaci, podporu a další místa, která mají uživatelé najít. Poznamenejte si alias produktu. Panel Integrovat na jeho kartě nabízí kód s vyplněným aliasem.
- 2
Předejte verzi z hlavního procesu
Hlavní proces vrací výsledek `app.getVersion()` přes handler IPC a preload skript ho zpřístupní stránce.
- 3
Načtěte skript a vložte prvek
Přidejte skript do HTML souboru okna a prvek O aplikaci vložte tam, kde se má zobrazit, například do dialogu O aplikaci nebo do patičky.
Vraťte verzi z hlavního procesu
`app.getVersion()` vrací `version` z `package.json` vaší aplikace. Pokud ho soubor neobsahuje, vrátí verzi aktuálního balíčku nebo spustitelného souboru.
const { app, BrowserWindow, ipcMain } = require("electron");
const path = require("path");
ipcMain.handle("app:version", () => app.getVersion());
app.whenReady().then(() => {
const win = new BrowserWindow({
webPreferences: {
preload: path.join(__dirname, "preload.js"),
contextIsolation: true,
},
});
win.loadFile("index.html");
});Zpřístupněte verzi v preload skriptu
Preload skript dá stránce jednu funkci, která zavolá handler `app:version`. Stránka nedostane přímý přístup k Node.js ani k `ipcRenderer`.
const { contextBridge, ipcRenderer } = require("electron");
contextBridge.exposeInMainWorld("appInfo", {
version: () => ipcRenderer.invoke("app:version"),
});Vložte prvek O aplikaci a nastavte jeho verzi
Stránka přečte verzi přes `window.appInfo` a nastaví ji do atributu `version` prvku. Prvek pak zobrazí verzi spuštěné aplikace.
<about-the-app alias="your-alias" variant="dialog"></about-the-app>
<script src="https://aboutthe.app/embed/web/v1/abouttheapp.js" async></script>
<script>
window.appInfo.version().then((version) => {
document.querySelector("about-the-app").setAttribute("version", version);
});
</script>Povolte načítání skriptu a obsahu
Pokud `index.html` nastavuje meta značku Content-Security-Policy, povolte `https://aboutthe.app` v `script-src`, `connect-src` a `img-src`. Jinak politika zablokuje skript nebo data, která načítá.
Ověřte verzi při spuštění ze zdrojů
Když aplikaci spustíte ze zdrojů a `package.json` neobsahuje `version`, `app.getVersion()` vrátí verzi Electronu. Nastavte `version` v `package.json` a hodnota bude stejná ve vývoji i v zabalené aplikaci.
Časté otázky
Je preload skript nutný?
Ne, pokud váš build verzi zná. Předejte ji jako pevnou hodnotu, například `version="1.4.2"`, nebo ji nastavte z build skriptu. Preload skript potřebujete jen tehdy, když chcete číst verzi z hlavního procesu Electronu za běhu.
Funguje prvek O aplikaci s contextIsolation a sandboxem?
Ano. Prvek běží na stránce a svůj obsah načítá přes HTTPS. Preload skript zpřístupní jen funkci pro verzi, takže stránka zůstává oddělená od Node.js.
Proč prvek zobrazí verzi bez poznámek k vydání?
Číslo verze pochází z aplikace, ale text změn je potřeba doplnit zvlášť. V tomto příkladu se načítá z katalogu verzí produktu v AboutTheApp, kde musí existovat záznam se stejnou verzí. Vydání můžete zapisovat také z CI/CD přes [GitHub Actions](/integrations/github-actions).
Chcete si přidat vlastní About box?
Založte si zdarma produkt v AboutTheApp a integrační kód budete mít hned.