Skip to content

Commit ebb2fa5

Browse files
authored
Merge branch 'main' into fix-autofill-doc
2 parents 419af8b + 2bf53e3 commit ebb2fa5

File tree

114 files changed

+6215
-3384
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+6215
-3384
lines changed

docs/apis/action-sheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npx cap sync
2121

2222
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
2323

24-
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.12.0`)
24+
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.13.0`)
2525

2626
## PWA Notes
2727

docs/apis/background-runner.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,18 @@ If you will be making use of Geolocation or Push Notifications, enable `Location
3131

3232
![Configure Background Modes in Xcode](https://github.com/ionic-team/capacitor-background-runner/raw/main/docs/configure_background_modes.png)
3333

34+
You will also need to add the following entry into your `Info.plist` file:
35+
```
36+
<key>BGTaskSchedulerPermittedIdentifiers</key>
37+
<array>
38+
<string>com.example.background.task</string>
39+
</array>
40+
```
41+
42+
Read about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode.
43+
44+
Make sure you use the same id that you use for `BGTaskSchedulerPermittedIdentifiers` (for example "com.example.background.task") in the `label` field in the plugin configuration.
45+
3446
After enabling the Background Modes capability, add the following to your app's `AppDelegate.swift`:
3547

3648
At the top of the file, under `import Capacitor` add:
@@ -73,8 +85,6 @@ Apple requires privacy descriptions to be specified in `Info.plist` for location
7385
- `NSLocationAlwaysUsageDescription` (`Privacy - Location Always Usage Description`)
7486
- `NSLocationWhenInUseUsageDescription` (`Privacy - Location When In Use Usage Description`)
7587

76-
Read about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode
77-
7888
## Android
7989

8090
Insert the following line to `android/app/build.gradle`:

docs/apis/barcode-scanner.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ Note: iOS supports all formats except `MAXICODE` and `UPC_EAN_EXTENSION` - using
5353
Interface defining the contract for a plugin capable of scanning barcodes.
5454
Requires implementation of the scanBarcode method, which initiates a barcode scan with given options.
5555

56+
Starting in Android targetSdk 36, the scanOrientation parameter has no effect for large screens (e.g. tablets) on Android 16 and higher.
57+
You may opt-out of this behavior in your app by adding `<property android:name="android.window.PROPERTY_COMPAT_ALLOW_RESTRICTED_RESIZABILITY" android:value="true" />` to your `AndroidManifest.xml` inside `<application>` or `<activity>`.
58+
Keep in mind though that this opt-out is temporary and will no longer work for Android 17. Android discourages setting specific orientations for large screens.
59+
Regular Android phones are unaffected by this change.
60+
For more information check the Android docs at https://developer.android.com/about/versions/16/behavior-changes-16#adaptive-layouts
61+
5662
### scanBarcode(...)
5763

5864
```typescript
@@ -149,7 +155,7 @@ Defines the options for configuring a barcode scan.
149155

150156
| Members | Value |
151157
| ----------- | -------------------- |
152-
| **`ZXING`** | <code>'zxing'</code> |
153-
| **`MLKIT`** | <code>'mlkit'</code> |
158+
| **`ZXING`** | <code>"zxing"</code> |
159+
| **`MLKIT`** | <code>"mlkit"</code> |
154160

155161
</docgen-api>

docs/apis/browser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npx cap sync
2525

2626
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
2727

28-
- `androidxBrowserVersion`: version of `androidx.browser:browser` (default: `1.8.0`)
28+
- `androidxBrowserVersion`: version of `androidx.browser:browser` (default: `1.9.0`)
2929

3030
## Example
3131

docs/apis/camera.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ Additionally, because the Camera API launches a separate Activity to handle taki
7676

7777
This plugin will use the following project variables (defined in your app's `variables.gradle` file):
7878

79-
- `androidxExifInterfaceVersion`: version of `androidx.exifinterface:exifinterface` (default: `1.3.7`)
80-
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.12.0`)
79+
- `androidxExifInterfaceVersion`: version of `androidx.exifinterface:exifinterface` (default: `1.4.1`)
80+
- `androidxMaterialVersion`: version of `com.google.android.material:material` (default: `1.13.0`)
8181

8282
## PWA Notes
8383

@@ -151,7 +151,7 @@ with the camera.
151151
pickImages(options: GalleryImageOptions) => Promise<GalleryPhotos>
152152
```
153153

154-
Allows the user to pick multiplef pictures from the photo gallery.
154+
Allows the user to pick multiple pictures from the photo gallery.
155155

156156
| Param | Type |
157157
| ------------- | ------------------------------------------------------------------- |

docs/apis/file-transfer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: File Transfer Capacitor Plugin API
33
description: The FileTransfer API provides mechanisms for downloading and uploading files.
4-
custom_edit_url: https://github.com/ionic-team/capacitor-file-transfer/blob/next/packages/capacitor-plugin/README.md
5-
editApiUrl: https://github.com/ionic-team/capacitor-file-transfer/blob/next/packages/capacitor-plugin/src/definitions.ts
4+
custom_edit_url: https://github.com/ionic-team/capacitor-file-transfer/blob/main/packages/capacitor-plugin/README.md
5+
editApiUrl: https://github.com/ionic-team/capacitor-file-transfer/blob/main/packages/capacitor-plugin/src/definitions.ts
66
sidebar_label: File Transfer
77
---
88

@@ -62,7 +62,7 @@ const fileInfo = await Filesystem.getUri({
6262

6363
try {
6464
// Then use the FileTransfer plugin to upload
65-
const result = await FileTransfer.downloadFile({
65+
const result = await FileTransfer.uploadFile({
6666
url: 'https://example.com/upload_api',
6767
path: fileInfo.uri,
6868
chunkedMode: true,

docs/apis/file-viewer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: File Viewer Capacitor Plugin API
33
description: The FileViewer API provides mechanisms for opening files and previewing media. Not available on web.
4-
custom_edit_url: https://github.com/ionic-team/capacitor-file-viewer/blob/next/packages/capacitor-plugin/README.md
5-
editApiUrl: https://github.com/ionic-team/capacitor-file-viewer/blob/next/packages/capacitor-plugin/src/definitions.ts
4+
custom_edit_url: https://github.com/ionic-team/capacitor-file-viewer/blob/main/packages/capacitor-plugin/README.md
5+
editApiUrl: https://github.com/ionic-team/capacitor-file-viewer/blob/main/packages/capacitor-plugin/src/definitions.ts
66
sidebar_label: File Viewer
77
---
88

docs/apis/filesystem.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Filesystem Capacitor Plugin API
33
description: The Filesystem API provides a NodeJS-like API for working with files on the device.
4-
custom_edit_url: https://github.com/ionic-team/capacitor-filesystem/blob/next/packages/capacitor-plugin/README.md
5-
editApiUrl: https://github.com/ionic-team/capacitor-filesystem/blob/next/packages/capacitor-plugin/src/definitions.ts
4+
custom_edit_url: https://github.com/ionic-team/capacitor-filesystem/blob/main/packages/capacitor-plugin/README.md
5+
editApiUrl: https://github.com/ionic-team/capacitor-filesystem/blob/main/packages/capacitor-plugin/src/definitions.ts
66
sidebar_label: Filesystem
77
---
88

@@ -549,11 +549,13 @@ We recommend using the @capacitor/file-transfer plugin instead, in conjunction w
549549

550550
#### ReadFileOptions
551551

552-
| Prop | Type | Description | Since |
553-
| --------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
554-
| **`path`** | <code>string</code> | The path of the file to read | 1.0.0 |
555-
| **`directory`** | <code><a href="#directory">Directory</a></code> | The <a href="#directory">`Directory`</a> to read the file from | 1.0.0 |
556-
| **`encoding`** | <code><a href="#encoding">Encoding</a></code> | The encoding to read the file in, if not provided, data is read as binary and returned as base64 encoded. Pass <a href="#encoding">Encoding.UTF8</a> to read data as string | 1.0.0 |
552+
| Prop | Type | Description | Default | Since |
553+
| --------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------- | ----- |
554+
| **`path`** | <code>string</code> | The path of the file to read | | 1.0.0 |
555+
| **`directory`** | <code><a href="#directory">Directory</a></code> | The <a href="#directory">`Directory`</a> to read the file from | | 1.0.0 |
556+
| **`encoding`** | <code><a href="#encoding">Encoding</a></code> | The encoding to read the file in, if not provided, data is read as binary and returned as base64 encoded. Pass <a href="#encoding">Encoding.UTF8</a> to read data as string | | 1.0.0 |
557+
| **`offset`** | <code>number</code> | The offset to start reading the file from, in bytes. Native only (not available in web). Can be used in conjunction with length to partially read files. | <code>0</code> | 8.1.0 |
558+
| **`length`** | <code>number</code> | The length of data to read, in bytes. Any non-positive value means to read to the end of the file. Native only (not available in web). Can be used in conjunction with offset to partially read files. | <code>-1</code> | 8.1.0 |
557559

558560

559561
#### ReadFileInChunksOptions

0 commit comments

Comments
 (0)