Skip to content

Commit 7e844cd

Browse files
authored
doc(ios): various platform guide updates for 8.0.0 release (#1445)
* doc(ios): update nodejs requirement for 8.0.0 * doc(ios): remove platform centered workflow block * doc(ios): various platform guide updates
1 parent 25f8d53 commit 7e844cd

File tree

4 files changed

+22
-60
lines changed

4 files changed

+22
-60
lines changed

www/docs/en/dev/guide/platforms/ios/index.md

Lines changed: 22 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The table below outlines Cordova-iOS's prerequisites by version. Additionally, X
5656
<ul>
5757
<li>Cocoapods: >=1.16.0</li>
5858
<li>ios-deploy: >=1.12.2</li>
59-
<li>Node: >=20.5.0</li>
59+
<li>Node: >=20.17.0</li>
6060
<li>Xcode (xcodebuild): >=15.0.0</li>
6161
</ul>
6262
</td>
@@ -114,7 +114,7 @@ There are two ways to download Xcode:
114114

115115
Once Xcode is installed, several command-line tools need to be enabled
116116
for Cordova to run. From the command line, run:
117-
```bash
117+
```zsh
118118
$ xcode-select --install
119119
```
120120

@@ -125,7 +125,7 @@ to launch iOS apps on an iOS Device from the command-line.
125125

126126
Install ios-deploy via [Homebrew](https://brew.sh/) by running:
127127

128-
```bash
128+
```zsh
129129
$ brew install ios-deploy
130130
```
131131

@@ -135,7 +135,7 @@ The [CocoaPods](https://cocoapods.org/#install) tools are needed to build iOS ap
135135

136136
To install CocoaPods, run the following from command-line terminal:
137137

138-
```bash
138+
```zsh
139139
$ brew install cocoapods
140140
```
141141

@@ -149,15 +149,15 @@ For more details on installing and using the CLI, refer to [Create your first ap
149149

150150
To preview the app in the iOS simulator:
151151

152-
1. Open the workspace file (`platforms/ios/HelloWorld.xcworkspace`) from Xcode, _or_ from the command line:
152+
1. Open the workspace file (`platforms/ios/App.xcworkspace`) from Xcode, _or_ from the command line:
153153

154-
```bash
155-
$ open ./platforms/ios/HelloWorld.xcworkspace/
154+
```zsh
155+
$ open ./platforms/ios/App.xcworkspace/
156156
```
157157

158158
2. Make sure the `HelloWorld` project is selected in the left panel (1).
159159

160-
![]({{ site.baseurl }}/static/img/guide/platforms/ios/xcode10-run-project.png)
160+
![]({{ site.baseurl }}/static/img/guide/platforms/ios/xcode26-helloworld-run-project.png)
161161

162162
3. Select the intended device from the toolbar's __Scheme__ menu, such
163163
as the iPhone XR Simulator as highlighted in (2)
@@ -167,7 +167,7 @@ To preview the app in the iOS simulator:
167167
application in the simulator. A separate simulator application opens
168168
to display the app:
169169
170-
![]({{ site.baseurl }}/static/img/guide/platforms/ios/HelloWorld-running-xr.png)
170+
<img src="{{ site.baseurl }}/static/img/guide/platforms/ios/xcode26-helloworld-running-simulator.png" alt="iOS Simulator" width="400"/>
171171
172172
Only one simulator may run at a time, so if you want to test the app
173173
in a different simulator, you need to quit the simulator application
@@ -290,8 +290,10 @@ There is also support to mix and match command line arguments and parameters in
290290

291291
If you have a custom situation where you need to pass additional build flags to Xcode you would use one or more `--buildFlag` options to pass these flags to `xcodebuild`. If you use an `xcodebuild` built-in flag, it will show a warning.
292292

293-
cordova build --device --buildFlag="MYSETTING=myvalue" --buildFlag="MY_OTHER_SETTING=othervalue"
294-
cordova run --device --buildFlag="DEVELOPMENT_TEAM=FG35JLLMXX4A" --buildFlag="-scheme TestSchemeFlag"
293+
```zsh
294+
cordova build --device --buildFlag="MYSETTING=myvalue" --buildFlag="MY_OTHER_SETTING=othervalue"
295+
cordova run --device --buildFlag="DEVELOPMENT_TEAM=FG35JLLMXX4A" --buildFlag="-scheme TestSchemeFlag"
296+
```
295297

296298
You can also specify a `buildFlag` option in [`build.json` above](#using-buildjson) (the value for the `buildFlag` key is a string or an array of strings).
297299

@@ -306,69 +308,29 @@ Cordova for iOS projects can be opened in Xcode. This can be useful if
306308
you wish to use Xcode built in debugging/profiling tools or if you are
307309
developing iOS plugins. Please note that when opening your project in Xcode,
308310
it is recommended that you do NOT edit your code in the IDE. This will edit the code
309-
in the ```platforms``` folder of your project (not ```www```), and changes are liable to be overwritten.
310-
Instead, edit the ```www``` folder and copy over your changes by running ```cordova build```.
311+
in the `platforms` folder of your project (not `www`), and changes are liable to be overwritten.
312+
Instead, edit the `www` folder and copy over your changes by running `cordova build`.
311313

312-
Plugin developers wishing to edit their native code in the IDE should use the ```--link``` flag when adding their
314+
Plugin developers wishing to edit their native code in the IDE should use the `--link` flag when adding their
313315
plugin to the project via cordova plugin add. This will link the files so that changes to the plugin files in the
314316
platforms folder are reflected in your plugin's source folder (and vice versa).
315317
316-
Once the ios platform is added to your project and built using ```cordova build```, you can open it from
317-
within Xcode. Double-click to open the `${PROJECT_NAME}/platforms/ios/${PROJECT_NAME}.xcworkspace`
318+
Once the ios platform is added to your project and built using `cordova build`, you can open it from
319+
within Xcode. Double-click to open the `${PROJECT_NAME}/platforms/ios/App.xcworkspace`
318320
file or open Xcode from your terminal:
319321
320-
```bash
321-
$ open -a Xcode platforms/ios
322+
```zsh
323+
$ open -a Xcode platforms/ios/App.xcworkspace
322324
```
323325
324326
The screen should look like this:
325327
326-
![]({{ site.baseurl }}/static/img/guide/platforms/ios/xcode10-review-settings.png)
327-
328-
## Platform Centered Workflow
329-
330-
cordova-ios includes a number of scripts that allow the platform to be used
331-
without the full Cordova CLI. This development path may offer you a greater
332-
range of development options in certain situations than the cross-platform cordova CLI.
333-
For example, you need to use shell tools when deploying a custom
334-
Cordova WebView alongside native components. Before using this
335-
development path, you must still configure the SDK environment
336-
as described in [Requirements and Support](#link-requirements-and-support)
337-
above.
338-
339-
For each of the scripts discussed below, refer to
340-
[Cordova CLI Reference][cli] for more information on their
341-
arguments and usage. Each script has a name that matches the corresponding CLI
342-
command. For example, `cordova-ios/bin/create` is equivalent to
343-
`cordova create`.
344-
345-
To get started, either download the cordova-ios package from
346-
[npm](https://www.npmjs.com/package/cordova-ios) or
347-
[Github](https://github.com/apache/cordova-ios).
348-
349-
To create a project using this package, run the `create` script in the `bin`
350-
folder:
351-
352-
```bash
353-
$ cordova-ios/bin/create ...
354-
```
355-
356-
To run the app, use the `run` script in the `bin` folder:
357-
358-
```bash
359-
$ cordova-ios/bin/run
360-
```
361-
362-
The created project will have a folder named `cordova` inside that contains
363-
scripts for the project-specific Cordova commands (e.g. `run`, `build`, etc.).
364-
365-
To install plugins in this project, use the [Cordova Plugman Utility](../../../plugin_ref/plugman.html).
328+
![]({{ site.baseurl }}/static/img/guide/platforms/ios/xcode26-helloworld-general-settings.png)
366329
367330
## Upgrading
368331
369332
Refer to [this](./upgrade.html) article for instructions to upgrade your ```cordova-ios``` version.
370333
371-
372-
(Mac®, OS X®, Apple®, Xcode®, App Store℠, iPad®, iPhone®, iPod® and Finder® are Trademarks of Apple Inc.)
334+
(macOS®, Mac®, OS X®, Apple®, Xcode®, App Store℠, iPad®, iPhone®, iPod® and Finder® are Trademarks of Apple Inc.)
373335
374336
[cli]: ../../../reference/cordova-cli/index.html
742 KB
Loading
439 KB
Loading
759 KB
Loading

0 commit comments

Comments
 (0)