3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-30 09:27:04 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(pwa, sitemap, client-redirects, ideal-image): JSDoc for types (#6928)

Browse source 
* chore(pwa, sitemap, client-redirects, ideal-image): JSDoc for types

* fix
This commit is contained in:
Joshua Chen 2022-03-17 12:05:23 +08:00 • committed by GitHub
parent 284649c7c8
commit bfe7ca6237
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 129 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/docusaurus-plugin-pwa/src/index.ts
View file

@ -71,7 +71,7 @@ export default function pluginPWA(
},
getClientModules() {
return isProd ? [swRegister] : [];
return isProd && swRegister ? [swRegister] : [];
},
getDefaultCodeTranslationMessages() {

88
packages/docusaurus-plugin-pwa/src/plugin-pwa.d.ts vendored
View file

@ -6,26 +6,90 @@
*/
declare module '@docusaurus/plugin-pwa' {
export type pwaHead = {
tagName: string;
href?: string;
content?: string;
[attributeName: string]: string | boolean;
};
import type {InjectManifestOptions} from 'workbox-build';
export type PluginOptions = {
/**
* Turn debug mode on:
*
* - Workbox logs
* - Additional Docusaurus logs
* - Unoptimized SW file output
* - Source maps
*/
debug?: boolean;
offlineModeActivationStrategies;
injectManifestConfig;
reloadPopup;
pwaHead: pwaHead[];
swCustom;
swRegister;
/**
* Strategies used to turn the offline mode on:
*
* - `appInstalled`: activates for users having installed the site as an app
* (not 100% reliable)
* - `standalone`: activates for users running the app as standalone (often
* the case once a PWA is installed)
* - `queryString`: activates if queryString contains `offlineMode=true`
* (convenient for PWA debugging)
* - `mobile`: activates for mobile users (width <= 940px)
* - `saveData`: activates for users with `navigator.connection.saveData ===
* true`
* - `always`: activates for all users
*/
offlineModeActivationStrategies: (
| 'appInstalled'
| 'queryString'
| 'standalone'
| 'mobile'
| 'saveData'
| 'always'
)[];
/**
* Workbox options to pass to `workbox.injectManifest()`. This gives you
* control over which assets will be precached, and be available offline.
* @see https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build#.injectManifest
*/
injectManifestConfig: InjectManifestOptions;
/**
* Module path to reload popup component. This popup is rendered when a new
* service worker is waiting to be installed, and we suggest a reload to
* the user.
*
* Passing `false` will disable the popup, but this is not recommended:
* users won't have a way to get up-to-date content.
* @see {@link @theme/PwaReloadPopup}
*/
reloadPopup: string | false;
/**
* Array of objects containing `tagName` and key-value pairs for attributes
* to inject into the `<head>` tag. Technically you can inject any head tag
* through this, but it's ideally used for tags to make your site PWA-
* compliant.
*/
pwaHead: {
tagName: string;
href?: string;
content?: string;
[attributeName: string]: string | boolean;
}[];
/**
* Useful for additional Workbox rules. You can do whatever a service worker
* can do here, and use the full power of workbox libraries. The code is
* transpiled, so you can use modern ES6+ syntax here.
*/
swCustom?: string;
/**
* Adds an entry before the Docusaurus app so that registration can happen
* before the app runs. The default `registerSW.js` file is enough for
* simple registration. Passing `false` will disable registration entirely.
*/
swRegister: string | false;
};
}
declare module '@theme/PwaReloadPopup' {
export interface Props {
/**
* The popup should call this callback when the `reload` button is clicked.
* This will tell the service worker to install the waiting service worker
* and reload the page.
*/
readonly onReload: () => void;
}
export default function PwaReloadPopup(props: Props): JSX.Element;