12
4

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

【React】manifest.jsonについて

Last updated at Posted at 2022-03-06

はじめに

 本記事は、プログラミング初学者が、学習を進めていて疑問に思った点について調べた結果を備忘録も兼ねてまとめたものです。
 そのため、記事の内容に誤りが含まれている可能性があります。ご容赦ください。
 間違いを見つけた方は、お手数ですが、ご指摘いただけますと幸いです。

manifest.jsonについて

Reactアプリケーションをcreate-react-appで作成するとpublicフォルダにmanifest.jsonというファイルが存在します。
このmanifest.jsonを編集することでスマートフォン等で「ホーム画面に追加」した際のアイコンやUI等に関する設定をすることができます。

初期状態は以下のようになっています。

sample-pwa/public/manifest.json
{
  "short_name": "React App",
  "name": "Create React App Sample",
  "icons": [
    {
      "src": "favicon.ico",
      "sizes": "64x64 32x32 24x24 16x16",
      "type": "image/x-icon"
    },
    {
      "src": "logo192.png",
      "type": "image/png",
      "sizes": "192x192"
    },
    {
      "src": "logo512.png",
      "type": "image/png",
      "sizes": "512x512"
    }
  ],
  "start_url": ".",
  "display": "standalone",
  "theme_color": "#000000",
  "background_color": "#ffffff"
}

主要なプロパティについて

short_nameおよびname

アプリケーションの名前を設定します。
short_nameはホーム画面、ランチャー等やアプリケーション名が表示されるスペースが狭い場合に表示されます。

icons

アイコンを設定します。
src,type,sizesを設定する必要があります。
アイコンはホーム画面、アプリランチャー、タスクスイッチャー、スプラッシュ画面などで使用されます。
スプラッシュ画面は後述のdisplayにfullscreenかstandaloneを指定する必要があります。

start_url

ホーム画面に追加したアイコンをタップしてアプリケーションを起動した際に最初に表示する画面を指定します。
何も設定していない場合には、ユーザーが「ホーム画面に追加」した際に表示していた画面が表示されるようです。
/?utm_source=pwaを追加することでGoogle Analyticsでアプリの起動頻度を追跡することができます。

background_color

スプラッシュ画面の背景色を指定します。

display

ホーム画面から起動した際のUIを指定します。
fullscreen,standalone,minimal-ui,browserのいずれかを設定します。
standaloneはネイティブアプリケーションのような表示、browserはブラウザで表示した際と同じUIとなります。
前述の通り、スプラッシュ画面はfullscreenstandaloneを指定する必要があります。

orientation

表示する画面を指定し、固定することができます。
landscape(横向き)かportrait(縦向き)を指定します。

scope

スコープを設定します。
スコープ外のページにはdisplayをstandaloneに設定していても以下のようなツールバーが表示されるようになります。
IMG_8A85C8417A23-1.jpeg

theme_color

ツールバーとタスクスイッチャーの色を設定します。

description

アプリケーションの説明を追加することができます。

設定できているかの確認方法

manifest.jsonに記述して想定通り設定できているかどうか確認するには、スマートフォン等で実際に「ホーム画面に追加」してみて確認する他にPCではディベロッパーツールの「アプリケーション」で設定の状況やエラー等を確認することができます。
スクリーンショット 2022-03-07 0.56.14.png

12
4
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
12
4

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?