DOCSEARCHbyAlgolia
Submit Docs

Capacitor Documentation

website·Indexed 39 days ago

https://capacitorjs.com/docs

A cross-platform native runtime for building performant mobile applications that run natively on iOS and Android using web technologies. The documentation covers versions v2 through v9, including API usage, CLI tools, and integration guides for frameworks such as Ionic, Angular, React, Vue, Svelte, Preact, Qwik, and Stencil.

Tokens
721K
Snippets
4.4K
Records
6.2K
Agent score
66%

What's inside Capacitor

  1. Overview of Capacitor v3 native runtime

    v3
    Capacitor is a cross-platform native runtime used to create 'Web Native apps'. It allows developers to build modern web apps that run natively on iOS, Android, and the Web. It provides a consistent set of web-focused APIs to access native device features while maintaining web standards. Capacitor is backward-compatible with many Apache Cordova plugins and provides a Plugin API for Swift (iOS), Java (Android), and JavaScript (Web).

  2. Overview of Capacitor v6 Web Native runtime

    v6
    Capacitor is a cross-platform native runtime used to build performant mobile applications for iOS and Android using modern web tooling. It implements a 'Web Native' approach, providing a native container that allows developers to build web-first applications while maintaining full access to native SDKs. It provides a consistent set of web-focused APIs, ensuring that features working in a standard browser typically work within the Capacitor mobile app. Native functionality can be extended using a Plugin API supporting Swift (iOS), Java (Android), and JavaScript (Web).

  3. Overview of Official Capacitor v6 Plugins

    v6
    The Official Plugins are a set of Capacitor plugins maintained by the Capacitor team that provide access to commonly used native APIs. These include capabilities for device hardware (Camera, Geolocation, Haptics), system UI (StatusBar, SplashScreen, Keyboard), and data management (Filesystem, Preferences, Cookies). The source code for these plugins is hosted on GitHub at https://github.com/ionic-team/capacitor-plugins.

  4. Overview of Official Capacitor v7 Plugins

    v7
    Official Capacitor plugins are a set of libraries maintained by the Capacitor team that provide standardized access to commonly used native device APIs. For Capacitor v7, the official plugin suite includes tools for hardware access (Camera, Geolocation, Motion), system UI (StatusBar, SplashScreen, Keyboard), and data management (Filesystem, Preferences, Cookies).

  5. Overview of Capacitor v2 Filesystem API

    v2
    The Filesystem API provides a NodeJS-like interface for working with files on a device. It allows developers to scope operations to special system directories (like Documents) or use full file:// paths (and content:// on Android). If a full file path is provided, the directory parameter should be omitted.

  6. Overview of Capacitor v5 native runtime

    v5
    Capacitor is a cross-platform native runtime used to build performant mobile applications for iOS and Android using modern web tooling. It enables the creation of 'Web Native apps' by providing a native container that allows developers to build web-first applications while maintaining full access to native SDKs. Capacitor provides a consistent set of web-focused APIs, ensuring that features working in a standard browser typically work in the mobile app. Native functionality can be extended via a Plugin API supporting Swift (iOS), Java (Android), and JavaScript (Web).

  7. Overview of SystemBars API

    The SystemBars API provides methods for configuring the style and visibility of device System Bars and Status Bars. It is bundled with @capacitor/core and is intended for modern edge-to-edge use cases. For legacy functionality (such as setOverlaysWebView or setBackgroundColor), use the Status Bar plugin instead.

  8. Overview of Official Capacitor v3 Plugins

    v3
    The Official Plugins for Capacitor v3 are a set of plugins maintained by the Capacitor team that provide standardized access to commonly used native device APIs. These include capabilities for hardware access (Camera, Geolocation, Motion), system UI (Action Sheet, Dialog, Toast, Status Bar), and application management (App, App Launcher, Push Notifications). The source code for these plugins is hosted on GitHub in the ionic-team/capacitor-plugins repository.

  9. Overview of Capacitor Native Runtime

    Capacitor is a cross-platform native runtime used to build performant mobile applications for iOS, Android, and other platforms using modern web tooling. It enables the creation of 'Web Native apps' by providing a native container that allows developers to build web-first applications while maintaining full access to native SDKs. Capacitor provides a consistent set of web-focused APIs, ensuring that features working in a standard browser typically work within the mobile app. Native functionality can be extended using a Plugin API supporting Swift (iOS), Java (Android), and JavaScript (Web).

  10. Overview of Official Capacitor v4 Plugins

    v4
    The Official Plugins are a set of Capacitor plugins maintained by the Capacitor team that provide access to commonly used native APIs. The source code for these plugins is hosted on GitHub at https://github.com/ionic-team/capacitor-plugins.

  11. Overview of Capacitor PWA Elements

    v4
    Capacitor PWA Elements provide web-based UI implementations for specific plugins (e.g., Camera.getPhoto() or Toast) when the app is running in a web browser rather than natively. These are implemented as web components using Shadow DOM to prevent conflicts with the application's own UI.

  12. Overview of the Capacitor App API

    v2
    The App API in Capacitor v2 handles high-level application state and events. It is used to detect when the app enters or leaves the foreground, handle deep links, open external apps, and manage persisted plugin state.