Version: 2.0.0-beta.5 🚧

📦 plugin-pwa

Workbox를 사용해 PWA 지원을 추가할 수 있는 도큐사우루스 플러그인입니다. 제품 빌드에만 서비스 워커를 만들어주는 플러그인입니다. 이를 통해 오프라인에서 실행할 수 있고 설치도 지원하는 완전한 PWA 호환 문서를 만들 수 있습니다.

설치#

npm
Yarn

npm install --save @docusaurus/plugin-pwa

yarn add @docusaurus/plugin-pwa

설정#

./static/manifest.json 파일에 PWA 매니페스트를 작성합니다.

docusaurus.config.js에 필요한 PWA 설정을 추가합니다.

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-pwa',      {        debug: true,        offlineModeActivationStrategies: [          'appInstalled',          'standalone',          'queryString',        ],        pwaHead: [          {            tagName: 'link',            rel: 'icon',            href: '/img/docusaurus.png',          },          {            tagName: 'link',            rel: 'manifest',            href: '/manifest.json', // your PWA manifest          },          {            tagName: 'meta',            name: 'theme-color',            content: 'rgb(37, 194, 160)',          },        ],      },    ],  ],};

프로그레시브 웹 앱#

서비스 워커를 설치하는 것만으로 여러분의 애플리케이션이 PWA가 되는 건 아닙니다. 최소한 웹 앱 매니페스트를 가지고 있어야 하며 <head> 태그 안에 적절한 태그가 포함되어 있어야 합니다 (Options > pwaHead).

배포 후에는 Lighthouse를 사용해 여러분의 사이트를 점검할 수 있습니다.

여러분의 사이트가 PWA가 되기 위해 필요한 좀 더 자세한 내용은 PWA 체크리스트를 참고하세요.

앱 설치 지원#

여러분의 브라우저가 지원한다면 도큐사우루스 사이트를 앱처럼 설치할 수 있습니다.

note

앱 설치를 지원하려면 https 프로토콜을 사용해야 하며 유효한 매니페스트가 필요합니다.

오프라인 모드(precaching)#

서비스 워커 사전캐싱을 사용해 도큐사우루스 사이트를 오프라인에서 사용자가 탐색할 수 있습니다.

사전캐싱은 무엇인가요?#
서비스 워커의 기능 중 하나로 서비스 워커 설치 시 캐시 처리할 파일 묶음을 저장해놓을 수 있습니다. 서비스 워커가 사용되기 전에 콘텐츠를 캐시 처리하기 때문에 "사전캐싱"이라고 부릅니다.
이렇게 처리하는 이유는 개발자에게 캐시를 제어할 수 있는 권한을 주기 위함입니다. 개발자는 캐시를 언제 만들고 얼마나 오래 보관할지 결정할 수 있을 뿐 아니라 네트워크를 거치지 않고 브라우저에서 바로 서비스를 제공할 수 있습니다. 즉 오프라인에서 동작할 수 있는 웹 앱을 만들 수 있다는 겁니다.
Workbox는 API를 단순화하고 효율적으로 필요한 파일을 내려받을 수 있게 만들어 사전캐싱 작업을 쉽게 접근할 수 있도록 지원합니다.

기본적으로 오프라인 모드는 사이트가 앱으로 설치되면 활성화됩니다. 자세한 내용은 offlineModeActivationStrategies 옵션 설명을 참고하세요.

사이트 사전캐싱 이후에 서비스 워커는 방문자에게 캐시된 응답을 제공합니다. 새로운 빌드가 새로운 서비스 워커와 함께 배포되면 새로운 앱이 설치되고 대기 상태로 이동하게 됩니다. 대기 상태에 들어가면 리로드 팝업이 표시되고 사용자에게 새로운 콘텐츠를 위해 페이지를 리로드할 것인지 물어봅니다. 사용자가 애플리케이션 캐시를 삭제하거나 팝업에서 reload 버튼을 클릭할 때까지 서비스 워커는 기존 콘텐츠를 제공합니다.

caution

오프라인 모드나 사전캐싱은 사이트의 모든 애셋을 미리 내려받아야 하며 불필요한 대역폭을 사용할 수 있습니다. 모든 종류의 사이트에서 무조건 해당 기능을 활성화하는 건 좋은 생각은 아닙니다.

옵션#

`debug`#

Type: boolean
Default: false

아래와 같은 디버그 모드를 설정합니다.

Workbox 로그
추가적인 도큐사우루스 로그
최적화되지 못한 SW 파일 출력
소스맵

`offlineModeActivationStrategies`#

Type: Array<'appInstalled' | 'mobile' | 'saveData'| 'queryString' | 'always'>
Default: ['appInstalled','queryString','standalone']

오프라인 모드를 적용할 상태에 대한 옵션을 설정합니다.

appInstalled: 사용자가 사이트를 앱으로 설치한 경우 활성화(100% 신뢰할 수는 없습니다)
standalone: 사용자가 앱을 독립적으로 실행한 경우 활성화(PWA가 설치된 경우)
queryString: queryString에 offlineMode=true가 포함된 경우 활성화(PWA 디버깅 시 유용합니다)
mobile: 모바일 사용자인 경우 활성화(width <= 940px)
saveData: navigator.connection.saveData === true로 설정한 경우 활성화
always: 모든 사용자 활성화

caution

주의해서 사용해주세요. 일부 사용자는 오프라인 모드로 사용하도록 강제되는 것을 싫어할 수도 있습니다.

danger

매우 안정적인 방식으로 PWA를 감지하는 것은 불가능합니다.

appinstalled 이벤트가 스펙에서 제거되면서 최신 크롬 버전에서는 navigator.getInstalledRelatedApps() API만 지원하고 있습니다. 이를 사용하려면 매니페스트에서 related_applications를 선언해주어야 합니다.

standalone 전략을 사용하는 것이 오프라인 모드를 활성화하는 좋은 대안입니다(설치된 앱을 실행하는 경우).

`injectManifestConfig`#

workbox.injectManifest()에 전달할 Workbox 옵션을 설정합니다. 프리캐싱을 적용하고 오프라인에서 사용할 수 있는 애셋을 직접 설정할 수 있습니다.

Type: InjectManifestOptions
Default: {}

docusaurus.config.js

module.exports = {  plugins: [    [      '@docusaurus/plugin-pwa',      {        injectManifestConfig: {          manifestTransforms: [            //...          ],          modifyURLPrefix: {            //...          },          // 일반적으로 사용하는 정적 애셋(html, 이미지 등)은 오프라인에서 사용할 수 있도록          // 기본적으로 추가했습니다. 추가로 필요한 파일만 설정해줍니다.          globPatterns: ['**/*.{pdf,docx,xlsx}'],          // ...        },      },    ],  ],};

`reloadPopup`#

Type: string | false
Default: '@theme/PwaReloadPopup'

팝업 컴포넌트를 리로드할 모듈 경로를 설정합니다. 새로운 서비스 워커가 설치되기를 기다릴 때 팝업이 표시되며 사용자에게 리로드를 안내합니다.

false로 설정하면 팝업이 표시되지 않지만 권장하지는 않습니다. 이렇게 하면 사용자가 최신 컨텐츠를 확인할 수 없습니다.

속성으로 onReload를 설정하면 사용자 지정 컴포넌트를 사용할 수 있습니다. onReload 콜백함수는 reload 버튼 클릭 시 호출됩니다. 그리고 기다리고 있는 서비스 워커에게 설치를 진행하고 페이지를 리로드하도록 전달합니다.

interface PwaReloadPopupProps {  onReload: () => void;}

기본 테마는 리로드 팝업이 구현되어 있으며 Infima Alerts을 사용합니다.

`pwaHead`#

Type: Array<{ tagName: string } & Record<string,string>>
Default: []

<head> 태그 내에 삽입할 tagName과 키, 값 쌍을 포함하는 오브젝트 배열을 설정합니다. 기술적으로 어떤 head 태그 든 삽입할 수 있지만 여러분의 사이트 PWA에 적합한 태그를 사용하는 것이 이상적입니다. 아래 목록은 여러분의 앱에 적합한 태그 목록입니다.

module.exports = {  plugins: [    [      '@docusaurus/plugin-pwa',      {        pwaHead: [          {            tagName: 'link',            rel: 'icon',            href: '/img/docusaurus.png',          },          {            tagName: 'link',            rel: 'manifest',            href: '/manifest.json',          },          {            tagName: 'meta',            name: 'theme-color',            content: 'rgb(37, 194, 160)',          },          {            tagName: 'meta',            name: 'apple-mobile-web-app-capable',            content: 'yes',          },          {            tagName: 'meta',            name: 'apple-mobile-web-app-status-bar-style',            content: '#000',          },          {            tagName: 'link',            rel: 'apple-touch-icon',            href: '/img/docusaurus.png',          },          {            tagName: 'link',            rel: 'mask-icon',            href: '/img/docusaurus.svg',            color: 'rgb(37, 194, 160)',          },          {            tagName: 'meta',            name: 'msapplication-TileImage',            content: '/img/docusaurus.png',          },          {            tagName: 'meta',            name: 'msapplication-TileColor',            content: '#000',          },        ],      },    ],  ],};

`swCustom`#

Type: string | undefined
Default: undefined

Workbox에 적용할 규칙 추가 시 유용한 설정입니다. 서비스 워커의 모든 기능과 함께 Workbox 라이브러리의 강력한 추가 기능을 사용할 수 있습니다. 트랜스파일된 코드이며 최신 ES6+ 구문을 사용할 수 있습니다.

예를 들어 외부 경로에 있는 파일을 캐시하는 경우에는 아래와 같이 사용합니다.

import {registerRoute} from 'workbox-routing';import {StaleWhileRevalidate} from 'workbox-strategies';
// default fn export receiving some useful paramsexport default function swCustom(params) {  const {    debug, // :boolean    offlineMode, // :boolean  } = params;
  // Cache responses from external resources  registerRoute((context) => {    return [      /graph\.facebook\.com\/.*\/picture/,      /netlify\.com\/img/,      /avatars1\.githubusercontent/,    ].some((regex) => context.url.href.match(regex));  }, new StaleWhileRevalidate());}

모듈은 default 내보내기 함수를 가지고 있어야 하며 일부 매개변수를 받아야 합니다.

`swRegister`#

Type: string | false
Default: 'docusaurus-plugin-pwa/src/registerSW.js'

앱이 실행하기 전에 등록이 처리되도록 도큐사우루스 앱 앞에 항목을 추가합니다. 기본 registerSW.js 파일은 간단한 등록을 위한 충분한 설정을 포함합니다.

false로 설정하면 등록을 처리할 수 없습니다.

매니페스트 예#

도큐사우루스 사이트 매니페스트를 참고하세요.

{  "name": "Docusaurus v2",  "short_name": "Docusaurus",  "theme_color": "#2196f3",  "background_color": "#424242",  "display": "standalone",  "scope": "./",  "start_url": "./index.html",  "related_applications": [    {      "platform": "webapp",      "url": "https://docusaurus.io/manifest.json"    }  ],  "icons": [    {      "src": "img/icons/icon-72x72.png",      "sizes": "72x72",      "type": "image/png"    },    {      "src": "img/icons/icon-96x96.png",      "sizes": "96x96",      "type": "image/png"    },    {      "src": "img/icons/icon-128x128.png",      "sizes": "128x128",      "type": "image/png"    },    {      "src": "img/icons/icon-144x144.png",      "sizes": "144x144",      "type": "image/png"    },    {      "src": "img/icons/icon-152x152.png",      "sizes": "152x152",      "type": "image/png"    },    {      "src": "img/icons/icon-192x192.png",      "sizes": "192x192",      "type": "image/png"    },    {      "src": "img/icons/icon-384x384.png",      "sizes": "384x384",      "type": "image/png"    },    {      "src": "img/icons/icon-512x512.png",      "sizes": "512x512",      "type": "image/png"    }  ]}

설치#

설정#

프로그레시브 웹 앱#

앱 설치 지원#

note

오프라인 모드(precaching)#

사전캐싱은 무엇인가요?#

caution

옵션#

debug#

offlineModeActivationStrategies#

caution

danger

injectManifestConfig#

reloadPopup#

pwaHead#

swCustom#

swRegister#

매니페스트 예#

`debug`#

`offlineModeActivationStrategies`#

`injectManifestConfig`#

`reloadPopup`#

`pwaHead`#

`swCustom`#

`swRegister`#