Plugin Configuration

Plugin Configuration in the Config File

Settings a plugin needs before any JavaScript runs, such as how long the splash screen stays up, live under plugins, keyed by the plugin's class name. The native plugin reads them from the packaged JSON at startup:

Configuring the Splash Screen plugin and the built-in HTTP pluginJavaScript

import type {} from '@capacitor/splash-screen'; // adds SplashScreen to the plugin types
// ... inside the config object:
  plugins: {
    SplashScreen: { launchShowDuration: 1500, backgroundColor: '#1565c0' },
    CapacitorHttp: { enabled: true },
  },

The empty type import serves the editor: the plugin's definitions.d.ts augments the CLI's PluginsConfig interface (declare module '@capacitor/cli'), so each option is typed and documented (launchShowDuration, for instance, defaults to 500 ms). CapacitorHttp ships inside @capacitor/core; enabled: true patches fetch and XMLHttpRequest to use the native HTTP libraries instead. Install the plugin and sync:

Installing the plugin that the config refers toShell

npm i @capacitor/splash-screen
npx cap sync android

Output

...
[info] Found 1 Capacitor plugin for android:
       @capacitor/splash-screen@8.0.2
...

sync found the plugin in package.json, added implementation project(':capacitor-splash-screen') to capacitor.build.gradle and listed its class in capacitor.plugins.json. Plugin options are native settings, so a change needs cap sync and a rebuild; includePlugins limits which installed plugins get linked.

MENU

Plugin Configuration