Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`.

Expand Down
2 changes: 1 addition & 1 deletion docs/apis/background-runner.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ backgrounded.
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 |
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task. | 1.0.0 |
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`. | 1.0.0 |
| **`interval`** | <code>number</code> | 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`** | <code>number</code> | 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`** | <code>boolean</code> | Automatically register and schedule background task on app load. | 1.0.0 |

### Examples
Expand Down
8 changes: 4 additions & 4 deletions docs/apis/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down
4 changes: 2 additions & 2 deletions docs/apis/inappbrowser.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,8 @@ Defines the options for opening a URL in the web view.
| **`allowOverScroll`** | <code>boolean</code> | Turns on the Web View bounce property. |
| **`enableViewportScale`** | <code>boolean</code> | Prevents viewport scaling through a meta tag. |
| **`allowInLineMediaPlayback`** | <code>boolean</code> | 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`** | <code>boolean</code> | Waits until all new view content is received before being rendered. |
| **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. |
| **`suppressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. |
| **`presentationStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. |
| **`animationEffect`** | <code><a href="#iosanimation">iOSAnimation</a></code> | Sets the transition style of the Web View. |
| **`allowsBackForwardNavigationGestures`** | <code>boolean</code> | Enables back and forward swipe gestures in the Web View. |

Expand Down
2 changes: 1 addition & 1 deletion docs/apis/local-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Starting on Android 12, scheduled notifications won't be exact unless this permi
<uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" />
```

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).

Expand Down
2 changes: 1 addition & 1 deletion docs/main/guides/autofill-credentials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Due to a [webkit bug](https://bugs.webkit.org/show_bug.cgi?id=226023) related to
</Tabs>

:::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
Expand Down
2 changes: 1 addition & 1 deletion docs/main/guides/screen-orientation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
<key>UISupportedInterfaceOrientations</key>
Expand Down
4 changes: 2 additions & 2 deletions docs/main/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/main/updating/5-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
{
Expand Down
4 changes: 2 additions & 2 deletions docs/main/updating/6-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion src/components/page/react/PageStyles/index.module.scss
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
padding: 50px 0px;
}
.main-flex h1 {
margin-botton: 0px;
margin-bottom: 0px;
}
.main-flex ul {
padding-left: 0;
Expand Down
2 changes: 1 addition & 1 deletion src/theme/TOC/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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 */}
<picture>
<source media="(min-width: 37.5em)" src={activeAd.ad_image.url} />
<source src={activeAd.ad_image['1x'].url} />
Expand Down
2 changes: 1 addition & 1 deletion src/utils/hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v2/apis/device.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Get the device's current language locale code
| **`model`** | <code>string</code> | The device model. For example, "iPhone" |
| **`platform`** | <code>"ios" \| "android" \| "electron" \| "web"</code> | The device platform (lowercase). |
| **`uuid`** | <code>string</code> | 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`** | <code>string</code> | The current bundle verison of the app |
| **`appVersion`** | <code>string</code> | The current bundle version of the app |
| **`appBuild`** | <code>string</code> | The current bundle build of the app |
| **`appId`** | <code>string</code> | The bundle id of the app |
| **`appName`** | <code>string</code> | The display name of the app |
Expand Down
Loading