From 3c0b929c1f42038bd351643c578239e5bb5b79f9 Mon Sep 17 00:00:00 2001 From: Martin Donadieu Date: Tue, 11 Nov 2025 15:32:39 +0000 Subject: [PATCH 1/4] docs: fix typos and improve clarity in various API documentation --- docs/apis/background-runner.md | 2 +- docs/apis/local-notifications.md | 2 +- docs/apis/watch.md | 6 +++--- docs/main/reference/config.md | 4 ++-- docs/main/updating/5-0.md | 2 +- docs/main/updating/6-0.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/apis/background-runner.md b/docs/apis/background-runner.md index dcf91c31e..2c1729793 100644 --- a/docs/apis/background-runner.md +++ b/docs/apis/background-runner.md @@ -193,7 +193,7 @@ backgrounded. | **`src`** | string | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 | | **`event`** | string | The name of the event that will be called when the OS executes the background task. | 1.0.0 | | **`repeat`** | boolean | If background task should repeat based on the interval set in `interval`. | 1.0.0 | -| **`interval`** | number | The number of minutes after the the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 | +| **`interval`** | number | The number of minutes after the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 | | **`autoStart`** | boolean | Automatically register and schedule background task on app load. | 1.0.0 | ### Examples diff --git a/docs/apis/local-notifications.md b/docs/apis/local-notifications.md index aaa6a357c..ddab7be0c 100644 --- a/docs/apis/local-notifications.md +++ b/docs/apis/local-notifications.md @@ -29,7 +29,7 @@ Starting on Android 12, scheduled notifications won't be exact unless this permi ``` -Note that even if the permission is present, users can still disable exact notifications from the app settings. Use `checkExactNotificationSetting()` to check the the value of the setting. If a user disables this setting, the app will restart and any notification scheduled with an exact alarm will be deleted. If your application depends on exact alarms, be sure to check this setting on app launch (for example, in [`App.appStateChange`](https://capacitorjs.com/docs/apis/app#addlistenerappstatechange-)) in order to provide fallbacks or alternative behavior. +Note that even if the permission is present, users can still disable exact notifications from the app settings. Use `checkExactNotificationSetting()` to check the value of the setting. If a user disables this setting, the app will restart and any notification scheduled with an exact alarm will be deleted. If your application depends on exact alarms, be sure to check this setting on app launch (for example, in [`App.appStateChange`](https://capacitorjs.com/docs/apis/app#addlistenerappstatechange-)) in order to provide fallbacks or alternative behavior. On Android 14, there is a new permission called `USE_EXACT_ALARM`. Use this permission to use exact alarms without needing to request permission from the user. This should only be used if the use of exact alarms is central to your app's functionality. Read more about the implications of using this permission [here](https://developer.android.com/reference/android/Manifest.permission#USE_EXACT_ALARM). diff --git a/docs/apis/watch.md b/docs/apis/watch.md index 483537ce0..385b74a18 100644 --- a/docs/apis/watch.md +++ b/docs/apis/watch.md @@ -177,7 +177,7 @@ Will produce this: This article provides a great summary on the native methods and their implications: https://alexanderweiss.dev/blog/2023-01-18-three-ways-to-communicate-via-watchconnectivity -On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can recieve envents from the watch while your app is in the background using the following code in your runner.js: +On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can receive events from the watch while your app is in the background using the following code in your runner.js: ```javascript addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { @@ -185,7 +185,7 @@ addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { }) ``` -You can also implment the `runCommand` event listener for foreground procesing: +You can also implement the `runCommand` event listener for foreground processing: ```typescript Watch.addListener("runCommand", (data: {command: string}) => { @@ -193,7 +193,7 @@ Watch.addListener("runCommand", (data: {command: string}) => { }) ``` -The commands are the 2nd paramter in the `Button()` definition of the watch UI. This can be any string. +The commands are the 2nd parameter in the `Button()` definition of the watch UI. This can be any string. ## Updating watch data diff --git a/docs/main/reference/config.md b/docs/main/reference/config.md index 4ab6b7f56..55e6e43a0 100644 --- a/docs/main/reference/config.md +++ b/docs/main/reference/config.md @@ -241,9 +241,9 @@ export interface CapacitorConfig { initialFocus?: boolean; /** - * The minimum supported webview version on Android supported by your app. + * The minimum supported webview version on Android for your app. * - * The minimum supported cannot be lower than version `55`, which is required for Capacitor. + * This minimum version cannot be lower than version `55`, which is required for Capacitor. * * If the device uses a lower WebView version, an error message will be shown on Logcat. * If `server.errorPath` is configured, the WebView will redirect to that file, so can be diff --git a/docs/main/updating/5-0.md b/docs/main/updating/5-0.md index 2ce8a23c7..20740d837 100644 --- a/docs/main/updating/5-0.md +++ b/docs/main/updating/5-0.md @@ -160,7 +160,7 @@ android { In Capacitor 6, `https` is going to be the default setting for `androidScheme` for __existing apps__ to better enable Capacitor applications to make use of the system [Autofill feature](https://capacitorjs.com/docs/guides/autofill-credentials). -Changing the scheme is the equivalent to shipping your application on a different domain, which means any data stored in in cookies, localstorage, etc would no longer be accessible. To avoid data loss as a result of this change, in your [Capacitor configuration file](https://capacitorjs.com/docs/config), you should set the scheme to `http` now even if it's the current default. +Changing the scheme is the equivalent to shipping your application on a different domain, which means any data stored in cookies, localstorage, etc would no longer be accessible. To avoid data loss as a result of this change, in your [Capacitor configuration file](https://capacitorjs.com/docs/config), you should set the scheme to `http` now even if it's the current default. ```typescript { diff --git a/docs/main/updating/6-0.md b/docs/main/updating/6-0.md index c92580c0c..294a628b2 100644 --- a/docs/main/updating/6-0.md +++ b/docs/main/updating/6-0.md @@ -128,7 +128,7 @@ zipStorePath=wrapper/dists In Capacitor 6, `https` is the default setting for `androidScheme` for __existing apps__ to better enable Capacitor applications to make use of the system [Autofill feature](https://capacitorjs.com/docs/guides/autofill-credentials). -Changing the scheme is the equivalent to shipping your application on a different domain, which means any data stored in in cookies, localstorage, etc would no longer be accessible. To avoid data loss as a result of this change, if you didn't have a `androidScheme` entry in your Capacitor config file already set to `https`, you should set the scheme to `http`. +Changing the scheme is the equivalent to shipping your application on a different domain, which means any data stored in cookies, localstorage, etc would no longer be accessible. To avoid data loss as a result of this change, if you didn't have a `androidScheme` entry in your Capacitor config file already set to `https`, you should set the scheme to `http`. ```typescript { From a1c21fe6ecf98ecf8b5a53732478dc8e3122c0fc Mon Sep 17 00:00:00 2001 From: Martin Donadieu Date: Tue, 11 Nov 2025 15:33:50 +0000 Subject: [PATCH 2/4] docs: correct typos in Http and Watch API documentation --- docs/apis/http.md | 10 +++++----- docs/apis/watch.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/apis/http.md b/docs/apis/http.md index a4490f422..07df07487 100644 --- a/docs/apis/http.md +++ b/docs/apis/http.md @@ -220,7 +220,7 @@ Make a Http DELETE Request to a server using native libraries. | **`data`** | any | Additional data received with the Http response. | | **`status`** | number | The status code received from the Http response. | | **`headers`** | HttpHeaders | The headers received from the Http response. | -| **`url`** | string | The response URL recieved from the Http response. | +| **`url`** | string | The response URL received from the Http response. | #### HttpHeaders @@ -287,9 +287,9 @@ https://nodejs.org/api/buffer.html#class-blob #### ArrayBuffer -Represents a raw buffer of binary data, which is used to store data for the -different typed arrays. ArrayBuffers cannot be read from or written to directly, -but can be passed to a typed array or DataView Object to interpret the raw +Represents a raw buffer of binary data, which is used to store data for the +different typed arrays. ArrayBuffers cannot be read from or written to directly, +but can be passed to a typed array or DataView Object to interpret the raw buffer as needed. | Prop | Type | Description | @@ -550,7 +550,7 @@ https://nodejs.org/api/url.html#class-urlsearchparams #### Uint8Array -A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the +A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the requested number of bytes could not be allocated an exception is raised. | Prop | Type | Description | diff --git a/docs/apis/watch.md b/docs/apis/watch.md index 385b74a18..cad04f128 100644 --- a/docs/apis/watch.md +++ b/docs/apis/watch.md @@ -151,7 +151,7 @@ You can still develop your iOS app like a normal capacitor app, but getting thin The right half of this bar lets you pick the destination device or simulator. You will need to pick the watch paired with the phone and then hit the 'Run' button or use the 'cmd+r' run shortcut. -There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the compainion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. +There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the companion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. ## Building the watch UI and sending it to the watch From 0d0bfee72ed15b81a15a812c79ae009a4bc4fe2e Mon Sep 17 00:00:00 2001 From: Martin Donadieu Date: Tue, 11 Nov 2025 15:38:55 +0000 Subject: [PATCH 3/4] docs: fix typos and improve clarity in various documentation files --- docs/README.md | 2 +- docs/apis/action-sheet.md | 2 +- docs/apis/geolocation.md | 2 +- docs/apis/inappbrowser.md | 2 +- docs/apis/watch.md | 10 +++++----- docs/main/guides/autofill-credentials.mdx | 2 +- docs/main/guides/games.md | 2 +- docs/main/guides/screen-orientation.md | 2 +- docs/main/ios/spm.md | 2 +- docs/main/ios/viewcontroller.md | 2 +- docs/main/reference/config.md | 2 +- docs/main/updating/5-0.md | 2 +- docs/main/updating/6-0.md | 2 +- 13 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2da297481..120053052 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to ## Versioning -This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. +This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`. diff --git a/docs/apis/action-sheet.md b/docs/apis/action-sheet.md index 9afb7773a..218998dd6 100644 --- a/docs/apis/action-sheet.md +++ b/docs/apis/action-sheet.md @@ -124,6 +124,6 @@ to select. | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | | **`Default`** | 'DEFAULT' | Default style of the option. | 1.0.0 | | **`Destructive`** | 'DESTRUCTIVE' | Style to use on destructive options. | 1.0.0 | -| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest availabe option. | 1.0.0 | +| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest available option. | 1.0.0 | \ No newline at end of file diff --git a/docs/apis/geolocation.md b/docs/apis/geolocation.md index d1ee8b82b..de0fa0043 100644 --- a/docs/apis/geolocation.md +++ b/docs/apis/geolocation.md @@ -180,7 +180,7 @@ Not available on web. | **`enableHighAccuracy`** | boolean | High accuracy mode (such as GPS, if available) On Android 12+ devices it will be ignored if users didn't grant ACCESS_FINE_LOCATION permissions (can be checked with location alias). | false | 1.0.0 | | **`timeout`** | number | The maximum wait time in milliseconds for location updates. In Android, since version 7.1.0 of the plugin, it is also used to determine the interval of location updates for `watchPosition`. | 10000 | 1.0.0 | | **`maximumAge`** | number | The maximum age in milliseconds of a possible cached position that is acceptable to return | 0 | 1.0.0 | -| **`minimumUpdateInterval`** | number | The minumum update interval for location updates. If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update. This parameter is only available for Android. It has no effect on iOS or Web platforms. | 5000 | 6.1.0 | +| **`minimumUpdateInterval`** | number | The minimum update interval for location updates. If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update. This parameter is only available for Android. It has no effect on iOS or Web platforms. | 5000 | 6.1.0 | | **`enableLocationFallback`** | boolean | This option applies to Android only. Whether to fall back to the Android framework's `LocationManager` in case Google Play Service's location settings checks fail. This can happen for multiple reasons - e.g. device has no Play Services or device has no network connection (Airplane Mode) If set to `false`, failures are propagated to the caller. Note that `LocationManager` may not be as effective as Google Play Services implementation. If the device's in airplane mode, only the GPS provider is used, which may take longer to return a location, depending on GPS signal. This means that to receive location in such circumstances, you may need to provide a higher timeout. | true | 8.0.0 | diff --git a/docs/apis/inappbrowser.md b/docs/apis/inappbrowser.md index 78a9a77a3..bc4568e5e 100644 --- a/docs/apis/inappbrowser.md +++ b/docs/apis/inappbrowser.md @@ -256,7 +256,7 @@ Defines the options for opening a URL in the web view. | **`allowOverScroll`** | boolean | Turns on the Web View bounce property. | | **`enableViewportScale`** | boolean | Prevents viewport scaling through a meta tag. | | **`allowInLineMediaPlayback`** | boolean | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. | -| **`surpressIncrementalRendering`** | boolean | Waits until all new view content is received before being rendered. | +| **`suppressIncrementalRendering`** | boolean | Waits until all new view content is received before being rendered. | | **`viewStyle`** | iOSViewStyle | Sets the presentation style of the Web View. | | **`animationEffect`** | iOSAnimation | Sets the transition style of the Web View. | | **`allowsBackForwardNavigationGestures`** | boolean | Enables back and forward swipe gestures in the Web View. | diff --git a/docs/apis/watch.md b/docs/apis/watch.md index cad04f128..34feeeb50 100644 --- a/docs/apis/watch.md +++ b/docs/apis/watch.md @@ -29,7 +29,7 @@ The Capacitor Watch plugin allows you to define a UI for a watch in your web cod This currently only supports iOS. This guide assumes you've already added iOS to your capcacitor project. -Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communcation like real devices do. +Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communication like real devices do. ## Install @@ -55,7 +55,7 @@ Add the 'Background Modes' and 'Push Notification' capabilities. Then in the Bac Step 3 -Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapactiorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: +Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapacitorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: ```swift assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!") @@ -83,7 +83,7 @@ We're going to add the code that makes Capacitor Watch work in the watch applica If you are using Xcode 15 or beyond you then need to add the Capacitor Watch Swift Package from your node_modules: -First go to the project package dependancies +First go to the project package dependencies @@ -99,7 +99,7 @@ Then in the column on the right pick your watch app to be the target and click ' -Once this is done your Package Dependancies should look like this: +Once this is done your Package Dependencies should look like this: @@ -216,7 +216,7 @@ async function counterIncrement() { } ``` -# Persistance on the Watch +# Persistence on the Watch Capacitor Watch will persist the last UI you sent with `updateWatchUI()`. State from `updateWatchData()` is NOT preserved. diff --git a/docs/main/guides/autofill-credentials.mdx b/docs/main/guides/autofill-credentials.mdx index ed88028ee..489bf9b17 100644 --- a/docs/main/guides/autofill-credentials.mdx +++ b/docs/main/guides/autofill-credentials.mdx @@ -71,7 +71,7 @@ Due to a [webkit bug](https://bugs.webkit.org/show_bug.cgi?id=226023) related to :::note - The `autocomplete` attribute allows auto filling of credential types like `username`, `current-pasword`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). + The `autocomplete` attribute allows auto filling of credential types like `username`, `current-password`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). ::: ## Set Capacitor Server Hostname diff --git a/docs/main/guides/games.md b/docs/main/guides/games.md index 802c39a84..8a5e54eaa 100644 --- a/docs/main/guides/games.md +++ b/docs/main/guides/games.md @@ -1,6 +1,6 @@ --- title: Games -description: Game development wiht Capacitor +description: Game development with Capacitor slug: /guides/games --- diff --git a/docs/main/guides/screen-orientation.md b/docs/main/guides/screen-orientation.md index 21bafcd8a..3d0a2ed7a 100644 --- a/docs/main/guides/screen-orientation.md +++ b/docs/main/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/docs/main/ios/spm.md b/docs/main/ios/spm.md index e09a7f1ca..482ae2950 100644 --- a/docs/main/ios/spm.md +++ b/docs/main/ios/spm.md @@ -129,7 +129,7 @@ This tool will do the following changes: - Add the following required things to your main swift plugin file, `[Name]Plugin.swift`: - Add Conformance to the `CAPBridgedPlugin` protocol to your class. - Add 3 variables to your class. `identifier`, `jsName`, and `pluginMethods`: - - `identifer` will correspond to the first argument to the `CAP_PLUGIN` macro. + - `identifier` will correspond to the first argument to the `CAP_PLUGIN` macro. - `jsName` will correspond to the second argument to the `CAP_PLUGIN` macro. - `pluginMethods` will be an array of the methods passed to the `CAP_PLUGIN` macro. - A `Package.swift` file will be created at the root of your plugin folder. diff --git a/docs/main/ios/viewcontroller.md b/docs/main/ios/viewcontroller.md index c7212d4ed..acd224792 100644 --- a/docs/main/ios/viewcontroller.md +++ b/docs/main/ios/viewcontroller.md @@ -13,7 +13,7 @@ Since Capacitor 3.0, you can subclass `CAPBridgeViewController` within your appl ## When to create a subclass -Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), subsituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), manipulating native views before they appear onscreen, or [registering custom plugins](../ios/custom-code.md). +Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), substituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), manipulating native views before they appear onscreen, or [registering custom plugins](../ios/custom-code.md). If you do need to create a custom subclass, there are a couple of steps to get started. diff --git a/docs/main/reference/config.md b/docs/main/reference/config.md index 55e6e43a0..d79808570 100644 --- a/docs/main/reference/config.md +++ b/docs/main/reference/config.md @@ -588,7 +588,7 @@ export interface CapacitorConfig { * Configure the local scheme on Android. * * Custom schemes on Android are unable to change the URL path as of Webview 117. Changing this value from anything other than `http` or `https` can result in your - * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarentees that this + * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarantees that this * will continue to work long term as allowing non-standard schemes to modify query parameters and url fragments is only allowed for compatibility reasons. * https://ionic.io/blog/capacitor-android-customscheme-issue-with-chrome-117 * diff --git a/docs/main/updating/5-0.md b/docs/main/updating/5-0.md index 20740d837..572c8a5d9 100644 --- a/docs/main/updating/5-0.md +++ b/docs/main/updating/5-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 5. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 5. ## iOS diff --git a/docs/main/updating/6-0.md b/docs/main/updating/6-0.md index 294a628b2..5788d265b 100644 --- a/docs/main/updating/6-0.md +++ b/docs/main/updating/6-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 6. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 6. ## iOS From 8f682ce6eb23873b2807fde68a2892d47271fc37 Mon Sep 17 00:00:00 2001 From: Martin Donadieu Date: Tue, 11 Nov 2025 15:50:50 +0000 Subject: [PATCH 4/4] fix(docs): correct typos and improve clarity in various API documentation files - Fixed spelling errors and improved descriptions in action-sheet, filesystem, geolocation, http, inappbrowser, watch, autofill-credentials, games, screen-orientation, spm, viewcontroller, and config documentation. - Updated "availabe" to "available" in action-sheet. - Updated "accesible" to "accessible" in filesystem. - Updated "minumum" to "minimum" in geolocation. - Updated "recieved" to "received" in http. - Updated "surpress" to "suppress" in inappbrowser. - Updated "communcation" to "communication" in watch. - Updated "recomendations" to "recommendations" in migration guides. - Updated "guarentees" to "guarantees" in config. - Updated "Capactior" to "Capacitor" in watch. - Updated "wiht" to "with" in games. --- scripts/api-v6.mjs | 2 +- .../page/react/PageStyles/index.module.scss | 2 +- src/theme/TOC/index.tsx | 2 +- src/utils/hooks.ts | 2 +- versioned_docs/version-v2/apis/device.md | 2 +- versioned_docs/version-v2/apis/filesystem.md | 4 ++-- .../version-v2/apis/push-notifications.md | 4 ++-- .../cordova/using-cordova-plugins.md | 2 +- .../version-v2/guides/screen-orientation.md | 2 +- versioned_docs/version-v2/plugins/ios.md | 2 +- versioned_docs/version-v3/README.md | 2 +- versioned_docs/version-v3/apis/action-sheet.md | 2 +- versioned_docs/version-v3/apis/camera.md | 2 +- versioned_docs/version-v3/apis/filesystem.md | 4 ++-- .../main/getting-started/vscode-extension.md | 2 +- .../main/guides/screen-orientation.md | 2 +- .../version-v3/main/ios/viewcontroller.md | 2 +- versioned_docs/version-v4/README.md | 2 +- versioned_docs/version-v4/apis/action-sheet.md | 2 +- versioned_docs/version-v4/apis/filesystem.md | 4 ++-- versioned_docs/version-v4/apis/http.md | 2 +- .../main/getting-started/vscode-extension.md | 2 +- .../main/guides/autofill-credentials.mdx | 2 +- versioned_docs/version-v4/main/guides/games.md | 2 +- .../main/guides/screen-orientation.md | 2 +- .../version-v4/main/ios/viewcontroller.md | 2 +- .../version-v4/main/vs-code-ext/z-advanced.md | 2 +- versioned_docs/version-v5/README.md | 2 +- versioned_docs/version-v5/apis/action-sheet.md | 2 +- .../version-v5/apis/background-runner.md | 2 +- versioned_docs/version-v5/apis/filesystem.md | 4 ++-- versioned_docs/version-v5/apis/http.md | 2 +- versioned_docs/version-v5/apis/watch.md | 18 +++++++++--------- .../main/getting-started/vscode-extension.md | 2 +- .../main/guides/autofill-credentials.mdx | 2 +- versioned_docs/version-v5/main/guides/games.md | 2 +- .../main/guides/screen-orientation.md | 2 +- .../version-v5/main/ios/viewcontroller.md | 2 +- .../version-v5/main/reference/config.md | 2 +- versioned_docs/version-v5/main/updating/5-0.md | 2 +- .../version-v5/main/vs-code-ext/z-advanced.md | 2 +- versioned_docs/version-v6/README.md | 2 +- versioned_docs/version-v6/apis/action-sheet.md | 2 +- versioned_docs/version-v6/apis/filesystem.md | 4 ++-- versioned_docs/version-v6/apis/geolocation.md | 2 +- versioned_docs/version-v6/apis/http.md | 2 +- versioned_docs/version-v6/apis/inappbrowser.md | 2 +- versioned_docs/version-v6/apis/watch.md | 18 +++++++++--------- .../main/getting-started/vscode-extension.md | 2 +- .../main/guides/autofill-credentials.mdx | 2 +- versioned_docs/version-v6/main/guides/games.md | 2 +- .../main/guides/screen-orientation.md | 2 +- versioned_docs/version-v6/main/ios/spm.md | 2 +- .../version-v6/main/ios/viewcontroller.md | 2 +- .../version-v6/main/reference/config.md | 2 +- versioned_docs/version-v6/main/updating/5-0.md | 2 +- versioned_docs/version-v6/main/updating/6-0.md | 2 +- .../version-v6/main/vs-code-ext/z-advanced.md | 2 +- versioned_docs/version-v7/README.md | 2 +- versioned_docs/version-v7/apis/action-sheet.md | 2 +- versioned_docs/version-v7/apis/geolocation.md | 2 +- versioned_docs/version-v7/apis/http.md | 2 +- versioned_docs/version-v7/apis/inappbrowser.md | 2 +- versioned_docs/version-v7/apis/watch.md | 18 +++++++++--------- .../main/guides/autofill-credentials.mdx | 2 +- versioned_docs/version-v7/main/guides/games.md | 2 +- .../main/guides/screen-orientation.md | 2 +- versioned_docs/version-v7/main/ios/spm.md | 2 +- .../version-v7/main/ios/viewcontroller.md | 2 +- .../version-v7/main/reference/config.md | 2 +- versioned_docs/version-v7/main/updating/5-0.md | 2 +- versioned_docs/version-v7/main/updating/6-0.md | 2 +- 72 files changed, 102 insertions(+), 102 deletions(-) diff --git a/scripts/api-v6.mjs b/scripts/api-v6.mjs index c2bb8d037..9b005b50d 100644 --- a/scripts/api-v6.mjs +++ b/scripts/api-v6.mjs @@ -68,7 +68,7 @@ function createApiPage(plugin, readme, pkgJson) { : plugin.editApiUrl; const sidebarLabel = toTitleCase(pluginId); - // // escape right curly brace in inline code blocks for MDX v3 compatability + // // escape right curly brace in inline code blocks for MDX v3 compatibility // const regexp = /[<|(<)]code>(.*)[<|(<)]\/code>/g; // readme = readme.replace(regexp, (result) => { diff --git a/src/components/page/react/PageStyles/index.module.scss b/src/components/page/react/PageStyles/index.module.scss index 8a4a293cf..5c7e01965 100644 --- a/src/components/page/react/PageStyles/index.module.scss +++ b/src/components/page/react/PageStyles/index.module.scss @@ -19,7 +19,7 @@ padding: 50px 0px; } .main-flex h1 { - margin-botton: 0px; + margin-bottom: 0px; } .main-flex ul { padding-left: 0; diff --git a/src/theme/TOC/index.tsx b/src/theme/TOC/index.tsx index a1f0f4e06..2ffb39052 100644 --- a/src/theme/TOC/index.tsx +++ b/src/theme/TOC/index.tsx @@ -40,7 +40,7 @@ export default function TOC({ ...props }) { target={activeAd.ad_url.target} // onClick={e => trackClick(activeAd.ad_id, e)} > - {/* Reponsive image since Prismic supports it out of the box */} + {/* Responsive image since Prismic supports it out of the box */} diff --git a/src/utils/hooks.ts b/src/utils/hooks.ts index 6c68d2e64..68f1ab8b6 100644 --- a/src/utils/hooks.ts +++ b/src/utils/hooks.ts @@ -13,7 +13,7 @@ export const useScript = (src: string) => { return; } // Fetch existing script element by src - // It may have been added by another intance of this hook + // It may have been added by another instance of this hook let script = document.querySelector(`script[src="${src}"]`) as HTMLScriptElement; if (!script) { // Create script diff --git a/versioned_docs/version-v2/apis/device.md b/versioned_docs/version-v2/apis/device.md index 8bfe7fd87..71675a2eb 100644 --- a/versioned_docs/version-v2/apis/device.md +++ b/versioned_docs/version-v2/apis/device.md @@ -103,7 +103,7 @@ Get the device's current language locale code | **`model`** | string | The device model. For example, "iPhone" | | **`platform`** | "ios" \| "android" \| "electron" \| "web" | The device platform (lowercase). | | **`uuid`** | string | The UUID of the device as available to the app. This identifier may change on modern mobile platforms that only allow per-app install UUIDs. | -| **`appVersion`** | string | The current bundle verison of the app | +| **`appVersion`** | string | The current bundle version of the app | | **`appBuild`** | string | The current bundle build of the app | | **`appId`** | string | The bundle id of the app | | **`appName`** | string | The display name of the app | diff --git a/versioned_docs/version-v2/apis/filesystem.md b/versioned_docs/version-v2/apis/filesystem.md index e382c00f3..69213b51a 100644 --- a/versioned_docs/version-v2/apis/filesystem.md +++ b/versioned_docs/version-v2/apis/filesystem.md @@ -476,11 +476,11 @@ Copy a file or directory | Members | Value | Description | | --------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`Documents`** | "DOCUMENTS" | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` | +| **`Documents`** | "DOCUMENTS" | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` | | **`Data`** | "DATA" | The Data directory On iOS it will use the Documents directory On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | | **`Cache`** | "CACHE" | The Cache directory Can be deleted in cases of low memory, so use this directory to write app-specific files that your app can re-create easily. | | **`External`** | "EXTERNAL" | The external directory On iOS it will use the Documents directory On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | -| **`ExternalStorage`** | "EXTERNAL_STORAGE" | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` | +| **`ExternalStorage`** | "EXTERNAL_STORAGE" | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml` | #### FilesystemEncoding diff --git a/versioned_docs/version-v2/apis/push-notifications.md b/versioned_docs/version-v2/apis/push-notifications.md index 802edb8c6..02c822d98 100644 --- a/versioned_docs/version-v2/apis/push-notifications.md +++ b/versioned_docs/version-v2/apis/push-notifications.md @@ -13,11 +13,11 @@ canonicalUrl: https://capacitorjs.com/docs/apis/push-notifications The Push Notifications API provides methods for registering a device to receive notifications from a server, along with processing received notifications and responding to them. In contrast, the [Local Notifications](/apis/local-notifications.md) API provides means for offline, local notification scheduling and processing. -## Enabling Push Notifications Capabilites +## Enabling Push Notifications Capabilities On iOS you must enable Push Notifications Capabilities in your project to enable the Push Notifications plugin to work. To do so, go to the `Capabilities` section of the app project and switch the `Push Notifications` button from `OFF` to the `ON` position. -This change adds the push capabilites to the app and creates an entitlements file in the project. +This change adds the push capabilities to the app and creates an entitlements file in the project. ![Enabling Push Notifications Capabilities](../../../static/img/v3/docs/ios/enable-push-capabilities.png) diff --git a/versioned_docs/version-v2/cordova/using-cordova-plugins.md b/versioned_docs/version-v2/cordova/using-cordova-plugins.md index 0f414f289..f245c00f1 100644 --- a/versioned_docs/version-v2/cordova/using-cordova-plugins.md +++ b/versioned_docs/version-v2/cordova/using-cordova-plugins.md @@ -41,7 +41,7 @@ npx cap sync ## Updating Ionic Native Plugins -Similiar to the installation steps. Update the Ionic Native JavaScript library, remove then re-add the Cordova plugin, then update your project: +Similar to the installation steps. Update the Ionic Native JavaScript library, remove then re-add the Cordova plugin, then update your project: ```bash npm install @ionic-native/javascript-package-name@2 diff --git a/versioned_docs/version-v2/guides/screen-orientation.md b/versioned_docs/version-v2/guides/screen-orientation.md index 7256fb2af..ea425eca7 100644 --- a/versioned_docs/version-v2/guides/screen-orientation.md +++ b/versioned_docs/version-v2/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/versioned_docs/version-v2/plugins/ios.md b/versioned_docs/version-v2/plugins/ios.md index 4a1400f99..59d4b6980 100644 --- a/versioned_docs/version-v2/plugins/ios.md +++ b/versioned_docs/version-v2/plugins/ios.md @@ -120,7 +120,7 @@ public class MyPlugin: CAPPlugin { ### Presenting Native Screens -To present a Native Screen over the Capacitor screen we need to acces the Capacitor's View Controller. +To present a Native Screen over the Capacitor screen we need to access the Capacitor's View Controller. To access the Capacitor's View Controller, we have to use the `CAPBridge` object available on `CAPPlugin` class. We can use the `UIViewController` to present Native View Controllers over it like this: diff --git a/versioned_docs/version-v3/README.md b/versioned_docs/version-v3/README.md index d0bc19887..448dcd22c 100644 --- a/versioned_docs/version-v3/README.md +++ b/versioned_docs/version-v3/README.md @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to ## Versioning -This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/v3/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/v3/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. +This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/v3/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/v3/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`. diff --git a/versioned_docs/version-v3/apis/action-sheet.md b/versioned_docs/version-v3/apis/action-sheet.md index 922a10cef..3b585af81 100644 --- a/versioned_docs/version-v3/apis/action-sheet.md +++ b/versioned_docs/version-v3/apis/action-sheet.md @@ -124,6 +124,6 @@ to select. | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | | **`Default`** | 'DEFAULT' | Default style of the option. | 1.0.0 | | **`Destructive`** | 'DESTRUCTIVE' | Style to use on destructive options. | 1.0.0 | -| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest availabe option. | 1.0.0 | +| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest available option. | 1.0.0 | diff --git a/versioned_docs/version-v3/apis/camera.md b/versioned_docs/version-v3/apis/camera.md index 173aaf633..6d902d8d3 100644 --- a/versioned_docs/version-v3/apis/camera.md +++ b/versioned_docs/version-v3/apis/camera.md @@ -285,7 +285,7 @@ Request camera and photo album permissions | ------------ | --------------------- | ------------------------------------------------------------------ | | **`Prompt`** | 'PROMPT' | Prompts the user to select either the photo album or take a photo. | | **`Camera`** | 'CAMERA' | Take a new photo using the camera. | -| **`Photos`** | 'PHOTOS' | Pick an existing photo fron the gallery or photo album. | +| **`Photos`** | 'PHOTOS' | Pick an existing photo from the gallery or photo album. | #### CameraDirection diff --git a/versioned_docs/version-v3/apis/filesystem.md b/versioned_docs/version-v3/apis/filesystem.md index 1e11fdb6d..84e55b942 100644 --- a/versioned_docs/version-v3/apis/filesystem.md +++ b/versioned_docs/version-v3/apis/filesystem.md @@ -497,12 +497,12 @@ Required on Android, only when using `Directory.Documents`< | Members | Value | Description | Since | | --------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **`Documents`** | 'DOCUMENTS' | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 | +| **`Documents`** | 'DOCUMENTS' | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 | | **`Data`** | 'DATA' | The Data directory On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 | | **`Library`** | 'LIBRARY' | The Library directory On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 | | **`Cache`** | 'CACHE' | The Cache directory Can be deleted in cases of low memory, so use this directory to write app-specific files that your app can re-create easily. | 1.0.0 | | **`External`** | 'EXTERNAL' | The external directory On iOS it will use the Documents directory On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 | -| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 | +| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 | #### Encoding diff --git a/versioned_docs/version-v3/main/getting-started/vscode-extension.md b/versioned_docs/version-v3/main/getting-started/vscode-extension.md index 5449e5cd8..01261bfd1 100644 --- a/versioned_docs/version-v3/main/getting-started/vscode-extension.md +++ b/versioned_docs/version-v3/main/getting-started/vscode-extension.md @@ -44,7 +44,7 @@ Using the Ionic extension, you can run the VS Code debugger on Web, Android, and ![Capacitor Debugging Example Image](../../../../static/img/v3/docs/getting-started/ionic-vs-code-debugging.jpg) -Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a seperate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. +Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a separate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. ## Doing More diff --git a/versioned_docs/version-v3/main/guides/screen-orientation.md b/versioned_docs/version-v3/main/guides/screen-orientation.md index b084d52d1..b0b03c223 100644 --- a/versioned_docs/version-v3/main/guides/screen-orientation.md +++ b/versioned_docs/version-v3/main/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/versioned_docs/version-v3/main/ios/viewcontroller.md b/versioned_docs/version-v3/main/ios/viewcontroller.md index 0a547baf6..b1e541211 100644 --- a/versioned_docs/version-v3/main/ios/viewcontroller.md +++ b/versioned_docs/version-v3/main/ios/viewcontroller.md @@ -13,7 +13,7 @@ With Capacitor 3.0, you can now subclass `CAPBridgeViewController` within your a ## When to create a subclass -Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), subsituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), or manipulating native views before they appear onscreen. +Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), substituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), or manipulating native views before they appear onscreen. If you do need to create a custom subclass, there are a couple of steps to get started. diff --git a/versioned_docs/version-v4/README.md b/versioned_docs/version-v4/README.md index 2da297481..120053052 100644 --- a/versioned_docs/version-v4/README.md +++ b/versioned_docs/version-v4/README.md @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to ## Versioning -This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. +This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`. diff --git a/versioned_docs/version-v4/apis/action-sheet.md b/versioned_docs/version-v4/apis/action-sheet.md index ff4b41941..8533a0632 100644 --- a/versioned_docs/version-v4/apis/action-sheet.md +++ b/versioned_docs/version-v4/apis/action-sheet.md @@ -124,6 +124,6 @@ to select. | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | | **`Default`** | 'DEFAULT' | Default style of the option. | 1.0.0 | | **`Destructive`** | 'DESTRUCTIVE' | Style to use on destructive options. | 1.0.0 | -| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest availabe option. | 1.0.0 | +| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest available option. | 1.0.0 | \ No newline at end of file diff --git a/versioned_docs/version-v4/apis/filesystem.md b/versioned_docs/version-v4/apis/filesystem.md index 006643599..ead94d821 100644 --- a/versioned_docs/version-v4/apis/filesystem.md +++ b/versioned_docs/version-v4/apis/filesystem.md @@ -527,12 +527,12 @@ Required on Android, only when using `Directory.Documents`< | Members | Value | Description | Since | | --------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **`Documents`** | 'DOCUMENTS' | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 | +| **`Documents`** | 'DOCUMENTS' | The Documents directory On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 | | **`Data`** | 'DATA' | The Data directory On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 | | **`Library`** | 'LIBRARY' | The Library directory On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 | | **`Cache`** | 'CACHE' | The Cache directory Can be deleted in cases of low memory, so use this directory to write app-specific files that your app can re-create easily. | 1.0.0 | | **`External`** | 'EXTERNAL' | The external directory On iOS it will use the Documents directory On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 | -| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 | +| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory On iOS it will use the Documents directory On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 | #### Encoding diff --git a/versioned_docs/version-v4/apis/http.md b/versioned_docs/version-v4/apis/http.md index f342d9c0d..a3a7ec518 100644 --- a/versioned_docs/version-v4/apis/http.md +++ b/versioned_docs/version-v4/apis/http.md @@ -225,7 +225,7 @@ Make a Http DELETE Request to a server using native libraries. | Prop | Type | Description | | ------------- | --------------------------------------------------- | ------------------------------------------------- | -| **`url`** | string | The response URL recieved from the Http response. | +| **`url`** | string | The response URL received from the Http response. | | **`status`** | number | The status code received from the Http response. | | **`data`** | any | Additional data received with the Http response. | | **`headers`** | HttpHeaders | The headers received from the Http response. | diff --git a/versioned_docs/version-v4/main/getting-started/vscode-extension.md b/versioned_docs/version-v4/main/getting-started/vscode-extension.md index f95479806..cfa40f392 100644 --- a/versioned_docs/version-v4/main/getting-started/vscode-extension.md +++ b/versioned_docs/version-v4/main/getting-started/vscode-extension.md @@ -44,7 +44,7 @@ Using the Ionic extension, you can run the VS Code debugger on Web, Android, and ![Capacitor Debugging Example Image](../../../../static/img/v4/docs/getting-started/ionic-vs-code-debugging.jpg) -Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a seperate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. +Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a separate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. ## Doing More diff --git a/versioned_docs/version-v4/main/guides/autofill-credentials.mdx b/versioned_docs/version-v4/main/guides/autofill-credentials.mdx index cd334d8db..af781fa00 100644 --- a/versioned_docs/version-v4/main/guides/autofill-credentials.mdx +++ b/versioned_docs/version-v4/main/guides/autofill-credentials.mdx @@ -71,7 +71,7 @@ Due to a [webkit bug](https://bugs.webkit.org/show_bug.cgi?id=226023) related to :::note - The `autocomplete` attribute allows auto filling of credential types like `username`, `current-pasword`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). + The `autocomplete` attribute allows auto filling of credential types like `username`, `current-password`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). ::: ## Set Capacitor Server Hostname diff --git a/versioned_docs/version-v4/main/guides/games.md b/versioned_docs/version-v4/main/guides/games.md index 802c39a84..8a5e54eaa 100644 --- a/versioned_docs/version-v4/main/guides/games.md +++ b/versioned_docs/version-v4/main/guides/games.md @@ -1,6 +1,6 @@ --- title: Games -description: Game development wiht Capacitor +description: Game development with Capacitor slug: /guides/games --- diff --git a/versioned_docs/version-v4/main/guides/screen-orientation.md b/versioned_docs/version-v4/main/guides/screen-orientation.md index c16b62f33..db602831f 100644 --- a/versioned_docs/version-v4/main/guides/screen-orientation.md +++ b/versioned_docs/version-v4/main/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/versioned_docs/version-v4/main/ios/viewcontroller.md b/versioned_docs/version-v4/main/ios/viewcontroller.md index 7661dbb9b..f4233f1ba 100644 --- a/versioned_docs/version-v4/main/ios/viewcontroller.md +++ b/versioned_docs/version-v4/main/ios/viewcontroller.md @@ -13,7 +13,7 @@ With Capacitor 3.0, you can now subclass `CAPBridgeViewController` within your a ## When to create a subclass -Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), subsituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), or manipulating native views before they appear onscreen. +Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), substituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), or manipulating native views before they appear onscreen. If you do need to create a custom subclass, there are a couple of steps to get started. diff --git a/versioned_docs/version-v4/main/vs-code-ext/z-advanced.md b/versioned_docs/version-v4/main/vs-code-ext/z-advanced.md index b55a154d7..46cf76b0e 100644 --- a/versioned_docs/version-v4/main/vs-code-ext/z-advanced.md +++ b/versioned_docs/version-v4/main/vs-code-ext/z-advanced.md @@ -28,7 +28,7 @@ ADB is used when debugging Android devices. The Location of the Android Debug Br ### Other Features -Click the `...` button next to `Project` to show a list of expermental features: +Click the `...` button next to `Project` to show a list of experimental features: - **Migrate from NPM to PNPM** - Your project will be switched to use pnpm as its package manager. - **Switch from WebPack to ESBuild** - Your Angular project will be switched to use the ESBuild option. - **Rebuild Node Modules** - The `node_modules` folder will be deleted and `npm install` will be run to restore the folder. diff --git a/versioned_docs/version-v5/README.md b/versioned_docs/version-v5/README.md index 2da297481..120053052 100644 --- a/versioned_docs/version-v5/README.md +++ b/versioned_docs/version-v5/README.md @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to ## Versioning -This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. +This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`. diff --git a/versioned_docs/version-v5/apis/action-sheet.md b/versioned_docs/version-v5/apis/action-sheet.md index a2abc480b..31bc222dd 100644 --- a/versioned_docs/version-v5/apis/action-sheet.md +++ b/versioned_docs/version-v5/apis/action-sheet.md @@ -124,6 +124,6 @@ to select. | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | | **`Default`** | 'DEFAULT' | Default style of the option. | 1.0.0 | | **`Destructive`** | 'DESTRUCTIVE' | Style to use on destructive options. | 1.0.0 | -| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest availabe option. | 1.0.0 | +| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest available option. | 1.0.0 | \ No newline at end of file diff --git a/versioned_docs/version-v5/apis/background-runner.md b/versioned_docs/version-v5/apis/background-runner.md index 854278874..e6a1376ae 100644 --- a/versioned_docs/version-v5/apis/background-runner.md +++ b/versioned_docs/version-v5/apis/background-runner.md @@ -504,7 +504,7 @@ Get access to device location information. Interact with a watch paired with this app -sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapactiorWatch Watch application. +sendMessage, transferUserInfo and updateApplicationContext are raw routes to the WCSession delegate methods, but have no effects currently in a CapacitorWatch Watch application. They could be used if a native watch app is developed as a companion app to a Capacitor app | Prop | Type | Description | diff --git a/versioned_docs/version-v5/apis/filesystem.md b/versioned_docs/version-v5/apis/filesystem.md index af7894119..5abe42a30 100644 --- a/versioned_docs/version-v5/apis/filesystem.md +++ b/versioned_docs/version-v5/apis/filesystem.md @@ -623,12 +623,12 @@ A listener function that receives progress events. | Members | Value | Description | Since | | --------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **`Documents`** | 'DOCUMENTS' | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 | +| **`Documents`** | 'DOCUMENTS' | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 | | **`Data`** | 'DATA' | The Data directory. On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 | | **`Library`** | 'LIBRARY' | The Library directory. On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 | | **`Cache`** | 'CACHE' | The Cache directory. Can be deleted in cases of low memory, so use this directory to write app-specific files. that your app can re-create easily. | 1.0.0 | | **`External`** | 'EXTERNAL' | The external directory. On iOS it will use the Documents directory. On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 | -| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 | +| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 | #### Encoding diff --git a/versioned_docs/version-v5/apis/http.md b/versioned_docs/version-v5/apis/http.md index f342d9c0d..a3a7ec518 100644 --- a/versioned_docs/version-v5/apis/http.md +++ b/versioned_docs/version-v5/apis/http.md @@ -225,7 +225,7 @@ Make a Http DELETE Request to a server using native libraries. | Prop | Type | Description | | ------------- | --------------------------------------------------- | ------------------------------------------------- | -| **`url`** | string | The response URL recieved from the Http response. | +| **`url`** | string | The response URL received from the Http response. | | **`status`** | number | The status code received from the Http response. | | **`data`** | any | Additional data received with the Http response. | | **`headers`** | HttpHeaders | The headers received from the Http response. | diff --git a/versioned_docs/version-v5/apis/watch.md b/versioned_docs/version-v5/apis/watch.md index 77b031bbf..1fc84ca3d 100644 --- a/versioned_docs/version-v5/apis/watch.md +++ b/versioned_docs/version-v5/apis/watch.md @@ -29,7 +29,7 @@ The Capacitor Watch plugin allows you to define a UI for a watch in your web cod This currently only supports iOS. This guide assumes you've already added iOS to your capcacitor project. -Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communcation like real devices do. +Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communication like real devices do. ## Install @@ -55,7 +55,7 @@ Add the 'Background Modes' and 'Push Notification' capabilities. Then in the Bac Step 3 -Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapactiorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: +Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapacitorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: ```swift assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!") @@ -83,7 +83,7 @@ We're going to add the code that makes Capacitor Watch work in the watch applica If you are using Xcode 15 Beta 4 or beyond you then need to add the Capacitor Watch Swift Package from your node_modules: -First go to the project package dependancies +First go to the project package dependencies @@ -99,7 +99,7 @@ Then in the column on the right pick your watch app to be the target and click ' -Once this is done your Package Dependancies should look like this: +Once this is done your Package Dependencies should look like this: @@ -142,7 +142,7 @@ You can still develop your iOS app like a normal capacitor app, but getting thin The right half of this bar lets you pick the destination device or simulator. You will need to pick the watch paired with the phone and then hit the 'Run' button or use the 'cmd+r' run shortcut. -There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the compainion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. +There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the companion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. ## Building the watch UI and sending it to the watch @@ -168,7 +168,7 @@ Will produce this: This article provides a great summary on the native methods and their implications: https://alexanderweiss.dev/blog/2023-01-18-three-ways-to-communicate-via-watchconnectivity -On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can recieve envents from the watch while your app is in the background using the following code in your runner.js: +On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can receive events from the watch while your app is in the background using the following code in your runner.js: ```javascript addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { @@ -176,7 +176,7 @@ addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { }) ``` -You can also implment the `runCommand` event listener for foreground procesing: +You can also implement the `runCommand` event listener for foreground processing: ```typescript Watch.addListener("runCommand", (data: {command: string}) => { @@ -184,7 +184,7 @@ Watch.addListener("runCommand", (data: {command: string}) => { }) ``` -The commands are the 2nd paramter in the `Button()` definition of the watch UI. This can be any string. +The commands are the 2nd parameter in the `Button()` definition of the watch UI. This can be any string. ## Updating watch data @@ -207,7 +207,7 @@ async function counterIncrement() { } ``` -# Persistance on the Watch +# Persistence on the Watch Capacitor Watch will persist the last UI you sent with `updateWatchUI()`. State from `updateWatchData()` is NOT preserved. diff --git a/versioned_docs/version-v5/main/getting-started/vscode-extension.md b/versioned_docs/version-v5/main/getting-started/vscode-extension.md index 61f1443a3..2acf5016f 100644 --- a/versioned_docs/version-v5/main/getting-started/vscode-extension.md +++ b/versioned_docs/version-v5/main/getting-started/vscode-extension.md @@ -44,7 +44,7 @@ Using the Ionic extension, you can run the VS Code debugger on Web, Android, and ![Capacitor Debugging Example Image](../../../../static/img/v5/docs/getting-started/ionic-vs-code-debugging.jpg) -Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a seperate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. +Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a separate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. ## Doing More diff --git a/versioned_docs/version-v5/main/guides/autofill-credentials.mdx b/versioned_docs/version-v5/main/guides/autofill-credentials.mdx index ec75e11a7..5f89304e0 100644 --- a/versioned_docs/version-v5/main/guides/autofill-credentials.mdx +++ b/versioned_docs/version-v5/main/guides/autofill-credentials.mdx @@ -71,7 +71,7 @@ Due to a [webkit bug](https://bugs.webkit.org/show_bug.cgi?id=226023) related to :::note - The `autocomplete` attribute allows auto filling of credential types like `username`, `current-pasword`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). + The `autocomplete` attribute allows auto filling of credential types like `username`, `current-password`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). ::: ## Set Capacitor Server Hostname diff --git a/versioned_docs/version-v5/main/guides/games.md b/versioned_docs/version-v5/main/guides/games.md index 802c39a84..8a5e54eaa 100644 --- a/versioned_docs/version-v5/main/guides/games.md +++ b/versioned_docs/version-v5/main/guides/games.md @@ -1,6 +1,6 @@ --- title: Games -description: Game development wiht Capacitor +description: Game development with Capacitor slug: /guides/games --- diff --git a/versioned_docs/version-v5/main/guides/screen-orientation.md b/versioned_docs/version-v5/main/guides/screen-orientation.md index 21bafcd8a..3d0a2ed7a 100644 --- a/versioned_docs/version-v5/main/guides/screen-orientation.md +++ b/versioned_docs/version-v5/main/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/versioned_docs/version-v5/main/ios/viewcontroller.md b/versioned_docs/version-v5/main/ios/viewcontroller.md index 4b72c90f8..0580f648b 100644 --- a/versioned_docs/version-v5/main/ios/viewcontroller.md +++ b/versioned_docs/version-v5/main/ios/viewcontroller.md @@ -13,7 +13,7 @@ With Capacitor 3.0, you can now subclass `CAPBridgeViewController` within your a ## When to create a subclass -Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), subsituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), or manipulating native views before they appear onscreen. +Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), substituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), or manipulating native views before they appear onscreen. If you do need to create a custom subclass, there are a couple of steps to get started. diff --git a/versioned_docs/version-v5/main/reference/config.md b/versioned_docs/version-v5/main/reference/config.md index cc140f1b7..c8b1f9ac1 100644 --- a/versioned_docs/version-v5/main/reference/config.md +++ b/versioned_docs/version-v5/main/reference/config.md @@ -510,7 +510,7 @@ export interface CapacitorConfig { * Configure the local scheme on Android. * * Custom schemes on Android are unable to change the URL path as of Webview 117. Changing this value from anything other than `http` or `https` can result in your - * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarentees that this + * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarantees that this * will continue to work long term as allowing non-standard schemes to modify query parameters and url fragments is only allowed for compatibility reasons. * https://ionic.io/blog/capacitor-android-customscheme-issue-with-chrome-117 * diff --git a/versioned_docs/version-v5/main/updating/5-0.md b/versioned_docs/version-v5/main/updating/5-0.md index cacc0a077..bf9ace693 100644 --- a/versioned_docs/version-v5/main/updating/5-0.md +++ b/versioned_docs/version-v5/main/updating/5-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 5. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 5. ## iOS diff --git a/versioned_docs/version-v5/main/vs-code-ext/z-advanced.md b/versioned_docs/version-v5/main/vs-code-ext/z-advanced.md index c8dcb2edf..3ac7b99cf 100644 --- a/versioned_docs/version-v5/main/vs-code-ext/z-advanced.md +++ b/versioned_docs/version-v5/main/vs-code-ext/z-advanced.md @@ -39,7 +39,7 @@ ADB is used when debugging Android devices. The Location of the Android Debug Br ### Other Features -Click the `...` button next to `Project` to show a list of expermental features: +Click the `...` button next to `Project` to show a list of experimental features: - **Migrate from NPM to PNPM** - Your project will be switched to use pnpm as its package manager. - **Switch from WebPack to ESBuild** - Your Angular project will be switched to use the ESBuild option. - **Rebuild Node Modules** - The `node_modules` folder will be deleted and `npm install` will be run to restore the folder. diff --git a/versioned_docs/version-v6/README.md b/versioned_docs/version-v6/README.md index 2da297481..120053052 100644 --- a/versioned_docs/version-v6/README.md +++ b/versioned_docs/version-v6/README.md @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to ## Versioning -This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. +This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`. diff --git a/versioned_docs/version-v6/apis/action-sheet.md b/versioned_docs/version-v6/apis/action-sheet.md index 7d53e1168..6f6604a98 100644 --- a/versioned_docs/version-v6/apis/action-sheet.md +++ b/versioned_docs/version-v6/apis/action-sheet.md @@ -124,6 +124,6 @@ to select. | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | | **`Default`** | 'DEFAULT' | Default style of the option. | 1.0.0 | | **`Destructive`** | 'DESTRUCTIVE' | Style to use on destructive options. | 1.0.0 | -| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest availabe option. | 1.0.0 | +| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest available option. | 1.0.0 | \ No newline at end of file diff --git a/versioned_docs/version-v6/apis/filesystem.md b/versioned_docs/version-v6/apis/filesystem.md index 75eef49b7..d75a34f0a 100644 --- a/versioned_docs/version-v6/apis/filesystem.md +++ b/versioned_docs/version-v6/apis/filesystem.md @@ -656,12 +656,12 @@ A listener function that receives progress events. | Members | Value | Description | Since | | --------------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | -| **`Documents`** | 'DOCUMENTS' | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 | +| **`Documents`** | 'DOCUMENTS' | The Documents directory. On iOS it's the app's documents directory. Use this directory to store user-generated content. On Android it's the Public Documents folder, so it's accessible from other apps. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. On Android 11 or newer the app can only access the files/folders the app created. | 1.0.0 | | **`Data`** | 'DATA' | The Data directory. On iOS it will use the Documents directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.0.0 | | **`Library`** | 'LIBRARY' | The Library directory. On iOS it will use the Library directory. On Android it's the directory holding application files. Files will be deleted when the application is uninstalled. | 1.1.0 | | **`Cache`** | 'CACHE' | The Cache directory. Can be deleted in cases of low memory, so use this directory to write app-specific files. that your app can re-create easily. | 1.0.0 | | **`External`** | 'EXTERNAL' | The external directory. On iOS it will use the Documents directory. On Android it's the directory on the primary shared/external storage device where the application can place persistent files it owns. These files are internal to the applications, and not typically visible to the user as media. Files will be deleted when the application is uninstalled. | 1.0.0 | -| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accesible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accesible on Android 11 or newer. | 1.0.0 | +| **`ExternalStorage`** | 'EXTERNAL_STORAGE' | The external storage directory. On iOS it will use the Documents directory. On Android it's the primary shared/external storage directory. It's not accessible on Android 10 unless the app enables legacy External Storage by adding `android:requestLegacyExternalStorage="true"` in the `application` tag in the `AndroidManifest.xml`. It's not accessible on Android 11 or newer. | 1.0.0 | #### Encoding diff --git a/versioned_docs/version-v6/apis/geolocation.md b/versioned_docs/version-v6/apis/geolocation.md index f15130a48..2e49b7d8f 100644 --- a/versioned_docs/version-v6/apis/geolocation.md +++ b/versioned_docs/version-v6/apis/geolocation.md @@ -184,7 +184,7 @@ Request location permissions. Will throw if system location services are disabl | **`enableHighAccuracy`** | boolean | High accuracy mode (such as GPS, if available) On Android 12+ devices it will be ignored if users didn't grant ACCESS_FINE_LOCATION permissions (can be checked with location alias). | false | 1.0.0 | | **`timeout`** | number | The maximum wait time in milliseconds for location updates. In Android, since version 4.0.0 of the plugin, timeout gets ignored for getCurrentPosition. | 10000 | 1.0.0 | | **`maximumAge`** | number | The maximum age in milliseconds of a possible cached position that is acceptable to return | 0 | 1.0.0 | -| **`minimumUpdateInterval`** | number | The minumum update interval for location updates. If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update. This parameter is only available for Android. It has no effect on iOS or Web platforms. | 5000 | 6.1.0 | +| **`minimumUpdateInterval`** | number | The minimum update interval for location updates. If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update. This parameter is only available for Android. It has no effect on iOS or Web platforms. | 5000 | 6.1.0 | #### ClearWatchOptions diff --git a/versioned_docs/version-v6/apis/http.md b/versioned_docs/version-v6/apis/http.md index 49dbeaaa8..c01a30c0b 100644 --- a/versioned_docs/version-v6/apis/http.md +++ b/versioned_docs/version-v6/apis/http.md @@ -220,7 +220,7 @@ Make a Http DELETE Request to a server using native libraries. | **`data`** | any | Additional data received with the Http response. | | **`status`** | number | The status code received from the Http response. | | **`headers`** | HttpHeaders | The headers received from the Http response. | -| **`url`** | string | The response URL recieved from the Http response. | +| **`url`** | string | The response URL received from the Http response. | #### HttpHeaders diff --git a/versioned_docs/version-v6/apis/inappbrowser.md b/versioned_docs/version-v6/apis/inappbrowser.md index cafbe939b..433429630 100644 --- a/versioned_docs/version-v6/apis/inappbrowser.md +++ b/versioned_docs/version-v6/apis/inappbrowser.md @@ -232,7 +232,7 @@ Defines the options for opening a URL in the web view. | **`allowOverScroll`** | boolean | Turns on the Web View bounce property. | | **`enableViewportScale`** | boolean | Prevents viewport scaling through a meta tag. | | **`allowInLineMediaPlayback`** | boolean | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. | -| **`surpressIncrementalRendering`** | boolean | Waits until all new view content is received before being rendered. | +| **`suppressIncrementalRendering`** | boolean | Waits until all new view content is received before being rendered. | | **`viewStyle`** | iOSViewStyle | Sets the presentation style of the Web View. | | **`animationEffect`** | iOSAnimation | Sets the transition style of the Web View. | diff --git a/versioned_docs/version-v6/apis/watch.md b/versioned_docs/version-v6/apis/watch.md index 483537ce0..34feeeb50 100644 --- a/versioned_docs/version-v6/apis/watch.md +++ b/versioned_docs/version-v6/apis/watch.md @@ -29,7 +29,7 @@ The Capacitor Watch plugin allows you to define a UI for a watch in your web cod This currently only supports iOS. This guide assumes you've already added iOS to your capcacitor project. -Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communcation like real devices do. +Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communication like real devices do. ## Install @@ -55,7 +55,7 @@ Add the 'Background Modes' and 'Push Notification' capabilities. Then in the Bac Step 3 -Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapactiorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: +Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapacitorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: ```swift assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!") @@ -83,7 +83,7 @@ We're going to add the code that makes Capacitor Watch work in the watch applica If you are using Xcode 15 or beyond you then need to add the Capacitor Watch Swift Package from your node_modules: -First go to the project package dependancies +First go to the project package dependencies @@ -99,7 +99,7 @@ Then in the column on the right pick your watch app to be the target and click ' -Once this is done your Package Dependancies should look like this: +Once this is done your Package Dependencies should look like this: @@ -151,7 +151,7 @@ You can still develop your iOS app like a normal capacitor app, but getting thin The right half of this bar lets you pick the destination device or simulator. You will need to pick the watch paired with the phone and then hit the 'Run' button or use the 'cmd+r' run shortcut. -There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the compainion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. +There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the companion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. ## Building the watch UI and sending it to the watch @@ -177,7 +177,7 @@ Will produce this: This article provides a great summary on the native methods and their implications: https://alexanderweiss.dev/blog/2023-01-18-three-ways-to-communicate-via-watchconnectivity -On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can recieve envents from the watch while your app is in the background using the following code in your runner.js: +On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can receive events from the watch while your app is in the background using the following code in your runner.js: ```javascript addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { @@ -185,7 +185,7 @@ addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { }) ``` -You can also implment the `runCommand` event listener for foreground procesing: +You can also implement the `runCommand` event listener for foreground processing: ```typescript Watch.addListener("runCommand", (data: {command: string}) => { @@ -193,7 +193,7 @@ Watch.addListener("runCommand", (data: {command: string}) => { }) ``` -The commands are the 2nd paramter in the `Button()` definition of the watch UI. This can be any string. +The commands are the 2nd parameter in the `Button()` definition of the watch UI. This can be any string. ## Updating watch data @@ -216,7 +216,7 @@ async function counterIncrement() { } ``` -# Persistance on the Watch +# Persistence on the Watch Capacitor Watch will persist the last UI you sent with `updateWatchUI()`. State from `updateWatchData()` is NOT preserved. diff --git a/versioned_docs/version-v6/main/getting-started/vscode-extension.md b/versioned_docs/version-v6/main/getting-started/vscode-extension.md index 304285da9..4bf315214 100644 --- a/versioned_docs/version-v6/main/getting-started/vscode-extension.md +++ b/versioned_docs/version-v6/main/getting-started/vscode-extension.md @@ -44,7 +44,7 @@ Using the Ionic extension, you can run the VS Code debugger on Web, Android, and ![Capacitor Debugging Example Image](/img/v6/docs/getting-started/ionic-vs-code-debugging.jpg) -Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a seperate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. +Using the options under the Debug folder, you can set breakpoints for both web and native code. Debugging for web will launch a separate web browser instance that is debuggable (Google Chrome by Default). You can also choose Microsoft Edge from the settings option. On Android, the webview instances will be listed in the "Debug" folder and debuggable in a similar way to Web. ## Doing More diff --git a/versioned_docs/version-v6/main/guides/autofill-credentials.mdx b/versioned_docs/version-v6/main/guides/autofill-credentials.mdx index bba56b9ad..952a22c1f 100644 --- a/versioned_docs/version-v6/main/guides/autofill-credentials.mdx +++ b/versioned_docs/version-v6/main/guides/autofill-credentials.mdx @@ -90,7 +90,7 @@ Due to a [webkit bug](https://bugs.webkit.org/show_bug.cgi?id=226023) related to :::note -The `autocomplete` attribute allows auto filling of credential types like `username`, `current-pasword`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). +The `autocomplete` attribute allows auto filling of credential types like `username`, `current-password`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). ::: ## Set Capacitor Server Hostname diff --git a/versioned_docs/version-v6/main/guides/games.md b/versioned_docs/version-v6/main/guides/games.md index 802c39a84..8a5e54eaa 100644 --- a/versioned_docs/version-v6/main/guides/games.md +++ b/versioned_docs/version-v6/main/guides/games.md @@ -1,6 +1,6 @@ --- title: Games -description: Game development wiht Capacitor +description: Game development with Capacitor slug: /guides/games --- diff --git a/versioned_docs/version-v6/main/guides/screen-orientation.md b/versioned_docs/version-v6/main/guides/screen-orientation.md index 21bafcd8a..3d0a2ed7a 100644 --- a/versioned_docs/version-v6/main/guides/screen-orientation.md +++ b/versioned_docs/version-v6/main/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/versioned_docs/version-v6/main/ios/spm.md b/versioned_docs/version-v6/main/ios/spm.md index 5429e9d18..31630a6b4 100644 --- a/versioned_docs/version-v6/main/ios/spm.md +++ b/versioned_docs/version-v6/main/ios/spm.md @@ -44,7 +44,7 @@ Now you can use `npx cap open ios` to open the iOS project and run your app from --- -### Add and use a Capactior Plugin with SPM +### Add and use a Capacitor Plugin with SPM So let's add a plugin to this project and do something with that plugin. diff --git a/versioned_docs/version-v6/main/ios/viewcontroller.md b/versioned_docs/version-v6/main/ios/viewcontroller.md index a485fded1..8ab968a41 100644 --- a/versioned_docs/version-v6/main/ios/viewcontroller.md +++ b/versioned_docs/version-v6/main/ios/viewcontroller.md @@ -13,7 +13,7 @@ Since Capacitor 3.0, you can subclass `CAPBridgeViewController` within your appl ## When to create a subclass -Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), subsituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), manipulating native views before they appear onscreen, or [registering custom plugins](../ios/custom-code.md). +Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), substituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), manipulating native views before they appear onscreen, or [registering custom plugins](../ios/custom-code.md). If you do need to create a custom subclass, there are a couple of steps to get started. diff --git a/versioned_docs/version-v6/main/reference/config.md b/versioned_docs/version-v6/main/reference/config.md index 34e36ad21..06dd0efd5 100644 --- a/versioned_docs/version-v6/main/reference/config.md +++ b/versioned_docs/version-v6/main/reference/config.md @@ -534,7 +534,7 @@ export interface CapacitorConfig { * Configure the local scheme on Android. * * Custom schemes on Android are unable to change the URL path as of Webview 117. Changing this value from anything other than `http` or `https` can result in your - * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarentees that this + * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarantees that this * will continue to work long term as allowing non-standard schemes to modify query parameters and url fragments is only allowed for compatibility reasons. * https://ionic.io/blog/capacitor-android-customscheme-issue-with-chrome-117 * diff --git a/versioned_docs/version-v6/main/updating/5-0.md b/versioned_docs/version-v6/main/updating/5-0.md index 11c0e75da..462323a43 100644 --- a/versioned_docs/version-v6/main/updating/5-0.md +++ b/versioned_docs/version-v6/main/updating/5-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 5. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 5. ## iOS diff --git a/versioned_docs/version-v6/main/updating/6-0.md b/versioned_docs/version-v6/main/updating/6-0.md index 0783f6330..452b69302 100644 --- a/versioned_docs/version-v6/main/updating/6-0.md +++ b/versioned_docs/version-v6/main/updating/6-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 6. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 6. ## iOS diff --git a/versioned_docs/version-v6/main/vs-code-ext/z-advanced.md b/versioned_docs/version-v6/main/vs-code-ext/z-advanced.md index bdfa2c394..ceb1e0244 100644 --- a/versioned_docs/version-v6/main/vs-code-ext/z-advanced.md +++ b/versioned_docs/version-v6/main/vs-code-ext/z-advanced.md @@ -39,7 +39,7 @@ ADB is used when debugging Android devices. The Location of the Android Debug Br ### Other Features -Click the `...` button next to `Project` to show a list of expermental features: +Click the `...` button next to `Project` to show a list of experimental features: - **Migrate from NPM to PNPM** - Your project will be switched to use pnpm as its package manager. - **Switch from WebPack to ESBuild** - Your Angular project will be switched to use the ESBuild option. - **Rebuild Node Modules** - The `node_modules` folder will be deleted and `npm install` will be run to restore the folder. diff --git a/versioned_docs/version-v7/README.md b/versioned_docs/version-v7/README.md index 2da297481..120053052 100644 --- a/versioned_docs/version-v7/README.md +++ b/versioned_docs/version-v7/README.md @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to ## Versioning -This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. +This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files. If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`. diff --git a/versioned_docs/version-v7/apis/action-sheet.md b/versioned_docs/version-v7/apis/action-sheet.md index 20f1e6144..ee4f0919f 100644 --- a/versioned_docs/version-v7/apis/action-sheet.md +++ b/versioned_docs/version-v7/apis/action-sheet.md @@ -124,6 +124,6 @@ to select. | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | | **`Default`** | 'DEFAULT' | Default style of the option. | 1.0.0 | | **`Destructive`** | 'DESTRUCTIVE' | Style to use on destructive options. | 1.0.0 | -| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest availabe option. | 1.0.0 | +| **`Cancel`** | 'CANCEL' | Style to use on the option that cancels the Action Sheet. If used, should be on the latest available option. | 1.0.0 | \ No newline at end of file diff --git a/versioned_docs/version-v7/apis/geolocation.md b/versioned_docs/version-v7/apis/geolocation.md index e91d4ffea..65d81ce3e 100644 --- a/versioned_docs/version-v7/apis/geolocation.md +++ b/versioned_docs/version-v7/apis/geolocation.md @@ -180,7 +180,7 @@ Not available on web. | **`enableHighAccuracy`** | boolean | High accuracy mode (such as GPS, if available) On Android 12+ devices it will be ignored if users didn't grant ACCESS_FINE_LOCATION permissions (can be checked with location alias). | false | 1.0.0 | | **`timeout`** | number | The maximum wait time in milliseconds for location updates. In Android, since version 7.1.0 of the plugin, it is also used to determine the interval of location updates for `watchPosition`. | 10000 | 1.0.0 | | **`maximumAge`** | number | The maximum age in milliseconds of a possible cached position that is acceptable to return | 0 | 1.0.0 | -| **`minimumUpdateInterval`** | number | The minumum update interval for location updates. If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update. This parameter is only available for Android. It has no effect on iOS or Web platforms. | 5000 | 6.1.0 | +| **`minimumUpdateInterval`** | number | The minimum update interval for location updates. If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update. This parameter is only available for Android. It has no effect on iOS or Web platforms. | 5000 | 6.1.0 | #### ClearWatchOptions diff --git a/versioned_docs/version-v7/apis/http.md b/versioned_docs/version-v7/apis/http.md index 4803e3cea..93544b6d8 100644 --- a/versioned_docs/version-v7/apis/http.md +++ b/versioned_docs/version-v7/apis/http.md @@ -220,7 +220,7 @@ Make a Http DELETE Request to a server using native libraries. | **`data`** | any | Additional data received with the Http response. | | **`status`** | number | The status code received from the Http response. | | **`headers`** | HttpHeaders | The headers received from the Http response. | -| **`url`** | string | The response URL recieved from the Http response. | +| **`url`** | string | The response URL received from the Http response. | #### HttpHeaders diff --git a/versioned_docs/version-v7/apis/inappbrowser.md b/versioned_docs/version-v7/apis/inappbrowser.md index ea7ebb01b..e381e040d 100644 --- a/versioned_docs/version-v7/apis/inappbrowser.md +++ b/versioned_docs/version-v7/apis/inappbrowser.md @@ -256,7 +256,7 @@ Defines the options for opening a URL in the web view. | **`allowOverScroll`** | boolean | Turns on the Web View bounce property. | | **`enableViewportScale`** | boolean | Prevents viewport scaling through a meta tag. | | **`allowInLineMediaPlayback`** | boolean | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. | -| **`surpressIncrementalRendering`** | boolean | Waits until all new view content is received before being rendered. | +| **`suppressIncrementalRendering`** | boolean | Waits until all new view content is received before being rendered. | | **`viewStyle`** | iOSViewStyle | Sets the presentation style of the Web View. | | **`animationEffect`** | iOSAnimation | Sets the transition style of the Web View. | | **`allowsBackForwardNavigationGestures`** | boolean | Enables back and forward swipe gestures in the Web View. | diff --git a/versioned_docs/version-v7/apis/watch.md b/versioned_docs/version-v7/apis/watch.md index 483537ce0..34feeeb50 100644 --- a/versioned_docs/version-v7/apis/watch.md +++ b/versioned_docs/version-v7/apis/watch.md @@ -29,7 +29,7 @@ The Capacitor Watch plugin allows you to define a UI for a watch in your web cod This currently only supports iOS. This guide assumes you've already added iOS to your capcacitor project. -Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communcation like real devices do. +Also note - all of this will only work with an actual Apple Watch. Simulators don't allow the app<->watch communication like real devices do. ## Install @@ -55,7 +55,7 @@ Add the 'Background Modes' and 'Push Notification' capabilities. Then in the Bac Step 3 -Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapactiorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: +Open `AppDelegate.swift` and add `import WatchConnectivity` and `import CapacitorWatch` to the top of the file, and the following code inside the `application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?)` method: ```swift assert(WCSession.isSupported(), "This sample requires Watch Connectivity support!") @@ -83,7 +83,7 @@ We're going to add the code that makes Capacitor Watch work in the watch applica If you are using Xcode 15 or beyond you then need to add the Capacitor Watch Swift Package from your node_modules: -First go to the project package dependancies +First go to the project package dependencies @@ -99,7 +99,7 @@ Then in the column on the right pick your watch app to be the target and click ' -Once this is done your Package Dependancies should look like this: +Once this is done your Package Dependencies should look like this: @@ -151,7 +151,7 @@ You can still develop your iOS app like a normal capacitor app, but getting thin The right half of this bar lets you pick the destination device or simulator. You will need to pick the watch paired with the phone and then hit the 'Run' button or use the 'cmd+r' run shortcut. -There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the compainion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. +There can be some challenges in syncing the watch and phone apps. Sometimes you will get an error in the xcode console complaining the companion app is not present. The best solution in this case is to re-build and re-install the apps on both devices. ## Building the watch UI and sending it to the watch @@ -177,7 +177,7 @@ Will produce this: This article provides a great summary on the native methods and their implications: https://alexanderweiss.dev/blog/2023-01-18-three-ways-to-communicate-via-watchconnectivity -On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can recieve envents from the watch while your app is in the background using the following code in your runner.js: +On the phone side, you can implement these methods using the Capacitor Background Runner Plugin (https://github.com/ionic-team/capacitor-background-runner). Currently the watch plugin will mainly handle the `didReceiveUserInfo` method, and you can receive events from the watch while your app is in the background using the following code in your runner.js: ```javascript addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { @@ -185,7 +185,7 @@ addEventListener("WatchConnectivity_didReceiveUserInfo", (args) => { }) ``` -You can also implment the `runCommand` event listener for foreground procesing: +You can also implement the `runCommand` event listener for foreground processing: ```typescript Watch.addListener("runCommand", (data: {command: string}) => { @@ -193,7 +193,7 @@ Watch.addListener("runCommand", (data: {command: string}) => { }) ``` -The commands are the 2nd paramter in the `Button()` definition of the watch UI. This can be any string. +The commands are the 2nd parameter in the `Button()` definition of the watch UI. This can be any string. ## Updating watch data @@ -216,7 +216,7 @@ async function counterIncrement() { } ``` -# Persistance on the Watch +# Persistence on the Watch Capacitor Watch will persist the last UI you sent with `updateWatchUI()`. State from `updateWatchData()` is NOT preserved. diff --git a/versioned_docs/version-v7/main/guides/autofill-credentials.mdx b/versioned_docs/version-v7/main/guides/autofill-credentials.mdx index bba56b9ad..952a22c1f 100644 --- a/versioned_docs/version-v7/main/guides/autofill-credentials.mdx +++ b/versioned_docs/version-v7/main/guides/autofill-credentials.mdx @@ -90,7 +90,7 @@ Due to a [webkit bug](https://bugs.webkit.org/show_bug.cgi?id=226023) related to :::note -The `autocomplete` attribute allows auto filling of credential types like `username`, `current-pasword`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). +The `autocomplete` attribute allows auto filling of credential types like `username`, `current-password`, `new-password`. It can also be used without this additional configuration for phone numbers, one time codes, credit card information and [more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete). ::: ## Set Capacitor Server Hostname diff --git a/versioned_docs/version-v7/main/guides/games.md b/versioned_docs/version-v7/main/guides/games.md index 802c39a84..8a5e54eaa 100644 --- a/versioned_docs/version-v7/main/guides/games.md +++ b/versioned_docs/version-v7/main/guides/games.md @@ -1,6 +1,6 @@ --- title: Games -description: Game development wiht Capacitor +description: Game development with Capacitor slug: /guides/games --- diff --git a/versioned_docs/version-v7/main/guides/screen-orientation.md b/versioned_docs/version-v7/main/guides/screen-orientation.md index 21bafcd8a..3d0a2ed7a 100644 --- a/versioned_docs/version-v7/main/guides/screen-orientation.md +++ b/versioned_docs/version-v7/main/guides/screen-orientation.md @@ -18,7 +18,7 @@ To set a global setting for orientation in your Capacitor app, you'll set the co iOS allows for different screen orientations to be supported on iPhones and iPads. To limit the allowed orientations for iOS, open Xcode and open the `Info.plist` file. Find the following keys: `Supported interface orientation` and `Supported interface orientation (iPad)`. Using these values, specify the different orientations you would like supported for iPhones and for iPads. -If editting the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: +If editing the `Info.plist` file directly look for the following keys: `UISupportedInterfaceOrientations` and `UISupportedInterfaceOrientations~ipad`. For example, the following settings will limit the orientation to right-side-up `Portrait` on iPhones and either of the `Landscape` orientations on iPads: ``` UISupportedInterfaceOrientations diff --git a/versioned_docs/version-v7/main/ios/spm.md b/versioned_docs/version-v7/main/ios/spm.md index f7541a213..1261507e0 100644 --- a/versioned_docs/version-v7/main/ios/spm.md +++ b/versioned_docs/version-v7/main/ios/spm.md @@ -130,7 +130,7 @@ This tool will do the following changes: - Add the following required things to your main swift plugin file, `[Name]Plugin.swift`: - Add Conformance to the `CAPBridgedPlugin` protocol to your class. - Add 3 variables to your class. `identifier`, `jsName`, and `pluginMethods`: - - `identifer` will correspond to the first argument to the `CAP_PLUGIN` macro. + - `identifier` will correspond to the first argument to the `CAP_PLUGIN` macro. - `jsName` will correspond to the second argument to the `CAP_PLUGIN` macro. - `pluginMethods` will be an array of the methods passed to the `CAP_PLUGIN` macro. - A `Package.swift` file will be created at the root of your plugin folder. diff --git a/versioned_docs/version-v7/main/ios/viewcontroller.md b/versioned_docs/version-v7/main/ios/viewcontroller.md index 216d61199..57d8f51c5 100644 --- a/versioned_docs/version-v7/main/ios/viewcontroller.md +++ b/versioned_docs/version-v7/main/ios/viewcontroller.md @@ -13,7 +13,7 @@ Since Capacitor 3.0, you can subclass `CAPBridgeViewController` within your appl ## When to create a subclass -Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), subsituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), manipulating native views before they appear onscreen, or [registering custom plugins](../ios/custom-code.md). +Some examples of when subclassing would be necessary are overriding Capacitor's configuration values at run-time, changing the properties of the [`WKWebViewConfiguration`](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration), substituting a custom subclass of [`WKWebView`](https://developer.apple.com/documentation/webkit/wkwebview) for Capacitor to use, integrating a 3rd party SDK that suggests adding code to [`viewDidLoad()`](https://developer.apple.com/documentation/uikit/uiviewcontroller/1621495-viewdidload), manipulating native views before they appear onscreen, or [registering custom plugins](../ios/custom-code.md). If you do need to create a custom subclass, there are a couple of steps to get started. diff --git a/versioned_docs/version-v7/main/reference/config.md b/versioned_docs/version-v7/main/reference/config.md index 4ab6b7f56..68623b0f9 100644 --- a/versioned_docs/version-v7/main/reference/config.md +++ b/versioned_docs/version-v7/main/reference/config.md @@ -588,7 +588,7 @@ export interface CapacitorConfig { * Configure the local scheme on Android. * * Custom schemes on Android are unable to change the URL path as of Webview 117. Changing this value from anything other than `http` or `https` can result in your - * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarentees that this + * application unable to resolve routing. If you must change this for some reason, consider using a hash-based url strategy, but there are no guarantees that this * will continue to work long term as allowing non-standard schemes to modify query parameters and url fragments is only allowed for compatibility reasons. * https://ionic.io/blog/capacitor-android-customscheme-issue-with-chrome-117 * diff --git a/versioned_docs/version-v7/main/updating/5-0.md b/versioned_docs/version-v7/main/updating/5-0.md index 11c0e75da..462323a43 100644 --- a/versioned_docs/version-v7/main/updating/5-0.md +++ b/versioned_docs/version-v7/main/updating/5-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 5. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 5. ## iOS diff --git a/versioned_docs/version-v7/main/updating/6-0.md b/versioned_docs/version-v7/main/updating/6-0.md index 622daaad2..6999f79ea 100644 --- a/versioned_docs/version-v7/main/updating/6-0.md +++ b/versioned_docs/version-v7/main/updating/6-0.md @@ -30,7 +30,7 @@ If any of the steps for the migration are not able to be completed, additional i ## Using the VS Code Extension to Migrate -If you have the VS Code extension installed, simply check out the recomendations section of the extension to find the option to migrate your project to Capacitor 6. +If you have the VS Code extension installed, simply check out the recommendations section of the extension to find the option to migrate your project to Capacitor 6. ## iOS