Skip to content

Commit ef46eae

Browse files
committed
Merge branch 'main' of github.com:ionic-team/capacitor-docs
# Conflicts: # docs/main/getting-started/environment-setup.md # docs/main/getting-started/faqs.md
2 parents deb8997 + 4a61d6c commit ef46eae

File tree

13 files changed

+31
-99
lines changed

13 files changed

+31
-99
lines changed

docs/apis/geolocation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ Apple requires privacy descriptions to be specified in `Info.plist` for location
2424
- `NSLocationAlwaysAndWhenInUseUsageDescription` (`Privacy - Location Always and When In Use Usage Description`)
2525
- `NSLocationWhenInUseUsageDescription` (`Privacy - Location When In Use Usage Description`)
2626

27+
> [!NOTE]
28+
> This Capacitor plugin does not support background geolocation directly. However, it relies on
29+
> [`ion-ios-geolocation`](https://github.com/ionic-team/ion-ios-geolocation), which can report
30+
> location in the background. As a result, Apple requires you to include a
31+
> `NSLocationAlwaysAndWhenInUseUsageDescription` entry in your `Info.plist`. Since this permission
32+
> prompt won’t appear to users, you can safely use the same description string as for
33+
> `NSLocationWhenInUseUsageDescription`.
34+
2735
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
2836

2937
## Android

docs/apis/inappbrowser.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,9 +216,10 @@ Removes all listeners for the browser events.
216216

217217
Defines the options for opening a URL in the web view.
218218

219-
| Prop | Type | Description |
220-
| ------------- | --------------------------------------------------------- | -------------------------------------------------------------------- |
221-
| **`options`** | <code><a href="#webviewoptions">WebViewOptions</a></code> | A structure containing some configurations to apply to the Web View. |
219+
| Prop | Type | Description |
220+
| ------------------- | --------------------------------------------------------- | -------------------------------------------------------------------- |
221+
| **`options`** | <code><a href="#webviewoptions">WebViewOptions</a></code> | A structure containing some configurations to apply to the Web View. |
222+
| **`customHeaders`** | <code>{ [key: string]: string; }</code> | A map of custom headers to be sent with the request. |
222223

223224

224225
#### WebViewOptions

docs/main/android/setting-target-sdk.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /android/setting-target-sdk
88
All Android applications must specify a target SDK version, or the version of Android that the application is designed to run on. Each year, Google releases updates to the Android operating system and subsequently bumps the version number that applications are required to target. Typically, [this date is August 31st](https://support.google.com/googleplay/android-developer/answer/11926878?hl=en) of each year. Because of this, it is important to keep your application up to date with the latest version of Android. In a Capacitor application, this is done by specifying your target SDK in the `/android/variables.gradle` file.
99

1010
```groovy
11-
targetSdkVersion = 34
11+
targetSdkVersion = 35
1212
```
1313

1414
## Capacitor Android Requirements
@@ -21,6 +21,7 @@ The following table shows the target SDK versions that are supported by Capacito
2121

2222
| Capacitor Android | Target SDK Version |
2323
| ----------------- | ------------------ |
24+
| 7.x | 35 |
2425
| 6.x | 34 |
2526
| 5.x | 33 |
2627
| 4.x | 32 |
@@ -30,4 +31,4 @@ The following table shows the target SDK versions that are supported by Capacito
3031

3132
## Custom Target SDK Versions
3233

33-
Capacitor Android does not support custom target SDK versions. Each version of Capacitor Android requires a specific target SDK version and support is only provided for that matching version.
34+
Capacitor Android does not support custom target SDK versions. Each version of Capacitor Android requires a specific target SDK version and support is only provided for that matching version.

docs/main/getting-started/environment-setup.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ slug: /getting-started/environment-setup
88

99
Capacitorは3つのアプリケーションターゲットを公式にサポートしています。Android、iOS、そしてWebです。3つのプラットフォームすべてに対応したアプリケーションを作成するためには、以下の依存関係をすべてインストールする必要があります。ネイティブモバイルターゲットのいずれかをターゲットにしていない場合は、関連するセクションをスキップすることができます。
1010

11-
:::info
12-
デスクトップのサポートが必要ですか?Capacitorを使用して[Windows](https://ionic.io/docs/windows/usage)または[Electron](https://github.com/capacitor-community/electron)アプリをビルドすることも可能です!
13-
:::
14-
1511
## 要件
1612

1713
Capacitorでアプリケーションを開発するには、NodeJS 20以上がインストールされている必要があります。Nodeをインストールするには、[Nodeのウェブサイト](https://nodejs.org)のインストーラを使用するか、JavaScriptツールマネージャの [Volta](https://volta.sh/) を使用するか、[homebrew](https://brew.sh/)[Chocolatey](https://chocolatey.org/)のようなパッケージマネージャを使用します。
@@ -95,18 +91,7 @@ CocoaPodsはRuby Gemで直接インストールすることができます。イ
9591
sudo gem install cocoapods
9692
```
9793

98-
しかし、この方法でCocoaPodsをインストールすると、Apple Silicon Macでは**うまくいきません**。Rosettaを有効にしてCocoaPodsを実行する必要があります。これを行うには、以下のコマンドを実行します。
99-
100-
```bash
101-
sudo arch -x86_64 gem install ffi
102-
```
103-
104-
それから、新しいバージョンのWebコードを使用するためにアプリケーションを更新したいときはいつでも、次のコマンドを実行する必要があります。
105-
106-
```bash
107-
npx cap copy
108-
arch -x86_64 pod install
109-
```
94+
For running without sudo see [CocoaPods sudo-less installation docs](https://guides.cocoapods.org/using/getting-started.html#sudo-less-installation)
11095

11196
## Androidの要件
11297

docs/main/getting-started/faqs.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Capacitorは公式プラットフォームとコミュニティプラットフ
1616
### 公式プラットフォーム
1717

1818
Capacitorは以下のプラットフォームを公式にサポートしています。
19-
- iOS 13+
20-
- Android 5.1+
19+
- iOS 14+
20+
- Android 6+
2121
- Requires Chrome WebView 60+
2222
- Modern Web Browsers
2323
- Chrome
@@ -30,9 +30,6 @@ Capacitorは以下のプラットフォームを公式にサポートしてい
3030
Capacitorは、クロスプラットフォームのデスクトップフレームワークをターゲットにしたコミュニティプラットフォームも用意しています。現在、コミュニティで対象としているのは以下の通りです。
3131
- Electron
3232
- https://github.com/capacitor-community/electron
33-
- Tauri (alpha)
34-
- https://github.com/capacitor-community/tauri
35-
3633

3734
## CapacitorでIonic Frameworkを使う必要があるのでしょうか?
3835

@@ -66,25 +63,5 @@ CapacitorがCordovaプラグインをサポートしていることをご存知
6663

6764
## Androidエミュレータで実行すると、なぜ空白の画面が表示されるのですか?
6865

69-
CapacitorはAndroid 5.1およびWebViewのバージョン60以上を必要とします。例えばAndroid 6や7のエミュレータを作成した場合、最新バージョンのWebViewがインストールされないため、真っ白な画面が表示されます。これを回避するには、アプリケーションのテスト用に、より新しいAndroidエミュレータをインストールすることができます。
70-
71-
## なぜApple Silicon DeviceでCocoaPodsのエラーが発生するのでしょうか?
72-
73-
If you installed CocoaPods with `sudo gem install cocoapods` and you're using an Apple Silicon-powered Mac, you might encounter something like this when running `npx cap update`:
74-
75-
```
76-
[error] Analyzing dependencies
77-
/Library/Ruby/Gems/2.6.0/gems/ffi-1.15.3/lib/ffi/library.rb:275: [BUG] Bus Error at 0x0000000000000000
78-
ruby 2.6.3p62 (2019-04-16 revision 67580) [universal.arm64e-darwin20]
79-
```
80-
81-
This is a CocoaPods bug related to `ffi` not installing on Apple Silicon computers.
82-
We recommend using [Homebrew to install CocoaPods](/main/getting-started/environment-setup.md#homebrew).
83-
Alternatively, if you have Rosetta installed, you can install `ffi` on a `x86_64` architecture and run `pod install` using the simulated Intel architecture for the first time.
84-
85-
```
86-
$ sudo arch -x86_64 gem install ffi
87-
$ arch -x86_64 pod install
88-
```
66+
Capacitor requires Android 6 as well as a WebView version of 60 or higher. If you create an Android 6 or 7 emulator for example, the newest version of the WebView won't be installed, and you'll get a blank white screen. To get around this, you can install a newer Android emulator for testing your application.
8967

90-
After that, running Capacitor should work as expected.

docs/main/ios/spm.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,27 +124,29 @@ At this point you're done and can build and work as normal.
124124

125125
If your plugin only contains Swift aside from the required `[Name]Plugin.m` and `[Name]Plugin.h` you can use the [capacitor-plugin-converter](https://github.com/ionic-team/capacitor-plugin-converter).
126126

127-
This tool will add the following required things to your main swift plugin file, `[Name]Plugin.swift`:
128-
129-
- Add Conformance to the `CAPBridgedPlugin` protocol to your class
130-
- Add 3 variables to your class. `identifier`, `jsName`, and `pluginMethods`
131-
- `identifer` will correspond to the first argument to the `CAP_PLUGIN` macro
132-
- `jsName` will correspond to the second argument to the `CAP_PLUGIN` macro
133-
- `pluginMethods` will be an array of the methods passed to the `CAP_PLUGIN` macro
127+
This tool will do the following changes:
128+
129+
- Add the following required things to your main swift plugin file, `[Name]Plugin.swift`:
130+
- Add Conformance to the `CAPBridgedPlugin` protocol to your class.
131+
- Add 3 variables to your class. `identifier`, `jsName`, and `pluginMethods`:
132+
- `identifer` will correspond to the first argument to the `CAP_PLUGIN` macro.
133+
- `jsName` will correspond to the second argument to the `CAP_PLUGIN` macro.
134+
- `pluginMethods` will be an array of the methods passed to the `CAP_PLUGIN` macro.
135+
- A `Package.swift` file will be created at the root of your plugin folder.
134136
- The following files will be removed as they are no longer needed:
135137
- `Plugin.xcodeproj`
136138
- `Plugin.xcworkspace`
137139
- `Plugin/Info.plist`
138140
- `PluginTests/Info.plist`
139141
- `Podfile`
140-
- To fit SPM best practices, the Project files will be moved to `Sources` and `Tests` directories
141-
- The plugins `package.json` will get the following fixes:
142+
- To fit SPM best practices, the Project files will be moved to `Sources` and `Tests` directories.
143+
- The plugins `package.json` will get the following changes:
142144
- The files array will add these files or directories:
143145
- `ios/Sources`
144146
- `ios/Tests`
145147
- `Package.swift`
146148
- `verify:ios` will be changed to `xcodebuild -scheme YourPluginName -destination generic/platform=iOS` to allow it to continue to work as you expect.
147-
- Your plugin podspec will be changed so that `s.source_files` now points to the `Sources` directory rather than the `Plugin` directory
149+
- Your plugin podspec will be changed so that `s.source_files` now points to the `Sources` directory rather than the `Plugin` directory.
148150

149151

150152
See the documentation in the repository at [capacitor-plugin-converter](https://github.com/ionic-team/capacitor-plugin-converter) for more.

docs/main/ios/troubleshooting.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -67,27 +67,6 @@ Xcode は時々、永遠にインデックス作成に行き詰まることが
6767

6868
唯一の解決策は、アクティビティモニタを使って Xcode を強制終了し、再度起動させることです。
6969

70-
## Apple Silicon: `ffi` Bus Error
71-
72-
If you installed CocoaPods with `sudo gem install cocoapods` and you're using an Apple Silicon-powered Mac, you might encounter something like this when running `npx cap update`:
73-
74-
```
75-
[error] Analyzing dependencies
76-
/Library/Ruby/Gems/2.6.0/gems/ffi-1.15.3/lib/ffi/library.rb:275: [BUG] Bus Error at 0x0000000000000000
77-
ruby 2.6.3p62 (2019-04-16 revision 67580) [universal.arm64e-darwin20]
78-
```
79-
80-
This is a CocoaPods bug related to `ffi` not installing on Apple Silicon computers.
81-
We recommend using [Homebrew to install CocoaPods](/main/getting-started/environment-setup.md#homebrew).
82-
Alternatively, if you have Rosetta installed, you can install `ffi` on a `x86_64` architecture and run `pod install` using the simulated Intel architecture for the first time.
83-
84-
```
85-
$ sudo arch -x86_64 gem install ffi
86-
$ arch -x86_64 pod install
87-
```
88-
89-
After that, running Capacitor should work as expected.
90-
9170
## CocoaPods: Failed to connect to GitHub
9271

9372
このエラーは、古いバージョンの openssl と ruby がインストールされた Mac で発生する可能性があります。

versioned_docs/version-v4/main/getting-started/environment-setup.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ slug: /getting-started/environment-setup
88

99
Capacitor has three officially supported application targets: Android, iOS, and Web. In order to create applications for all three platforms, you'll need to install all of the following dependencies. If you are not targeting one of the native mobile targets, you can skip the associated section.
1010

11-
:::info
12-
Do you need to support Desktops? You can use Capacitor to build [Windows](https://ionic.io/docs/windows/usage) or [Electron](https://github.com/capacitor-community/electron) apps as well!
13-
:::
14-
1511
## Core Requirements
1612

1713
In order to develop any application with Capacitor, you will need NodeJS 12 or higher installed. You can install Node by using the installer on [the Node website](https://nodejs.org), using [Volta](https://volta.sh/): a JavaScript tools manager, or installing it with a package manager like [homebrew](https://brew.sh/), or [Chocolatey](https://chocolatey.org/).

versioned_docs/version-v4/main/getting-started/faqs.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ Capacitor officially supports the following platforms:
3030
Capacitor also has community platforms to target cross platform desktop frameworks. The current community targets are the following.
3131
- Electron
3232
- https://github.com/capacitor-community/electron
33-
- Tauri (alpha)
34-
- https://github.com/capacitor-community/tauri
35-
3633

3734
## Do I need to use Ionic Framework with Capacitor?
3835

versioned_docs/version-v5/main/getting-started/environment-setup.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ slug: /getting-started/environment-setup
88

99
Capacitor has three officially supported application targets: Android, iOS, and Web. In order to create applications for all three platforms, you'll need to install all of the following dependencies. If you are not targeting one of the native mobile targets, you can skip the associated section.
1010

11-
:::info
12-
Do you need to support Desktops? You can use Capacitor to build [Windows](https://ionic.io/docs/windows/usage) or [Electron](https://github.com/capacitor-community/electron) apps as well!
13-
:::
14-
1511
## Core Requirements
1612

1713
In order to develop any application with Capacitor, you will need NodeJS 16 or higher installed. You can install Node by using the installer on [the Node website](https://nodejs.org), using [Volta](https://volta.sh/): a JavaScript tools manager, or installing it with a package manager like [homebrew](https://brew.sh/), or [Chocolatey](https://chocolatey.org/).

0 commit comments

Comments
 (0)