You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/angular/lifecycle.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,9 @@ Ionic embraces the life cycle events provided by Angular. The two Angular events
21
21
22
22
For more info on the Angular Component Life Cycle events, visit their [component lifecycle docs](https://angular.io/guide/lifecycle-hooks).
23
23
24
-
> Components that use `ion-nav` or `ion-router-outlet` should not use the `OnPush` change detection strategy. Doing so will prevent lifecycle hooks such as `ngOnInit` from firing. Additionally, asynchronous state changes may not render properly.
24
+
:::note
25
+
Components that use `ion-nav` or `ion-router-outlet` should not use the `OnPush` change detection strategy. Doing so will prevent lifecycle hooks such as `ngOnInit` from firing. Additionally, asynchronous state changes may not render properly.
Copy file name to clipboardExpand all lines: docs/angular/navigation.md
+6-2
Original file line number
Diff line number
Diff line change
@@ -110,7 +110,9 @@ export class LoginComponent {
110
110
111
111
Both options provide the same navigation mechanism, just fitting different use cases.
112
112
113
-
> A note on navigation with relative URLs: Currently, to support multiple navigation stacks, relative URLs are something not supported
113
+
:::note
114
+
A note on navigation with relative URLs: Currently, to support multiple navigation stacks, relative URLs are something not supported
115
+
:::
114
116
115
117
## Lazy loading routes
116
118
@@ -151,7 +153,9 @@ import { LoginComponent } from './login.component';
151
153
})
152
154
```
153
155
154
-
> We're excluding some additional content and only including the necessary parts.
156
+
:::note
157
+
We're excluding some additional content and only including the necessary parts.
158
+
:::
155
159
156
160
157
161
Here, we have a typical Angular Module setup, along with a RouterModule import, but we're now using `forChild` and declaring the component in that setup. With this setup, when we run our build, we will produce separate chunks for both the app component, the login component, and the detail component.
Copy file name to clipboardExpand all lines: docs/angular/pwa.md
+12-4
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,14 @@ $ ng add @angular/pwa
18
18
19
19
Once this package has been added run `ionic build --prod` and the `www` directory will be ready to deploy as a PWA.
20
20
21
-
> By default, the `@angular/pwa` package comes with the Angular logo for the app icons. Be sure to update the manifest to use the correct app name and also replace the icons.
21
+
:::note
22
+
By default, the `@angular/pwa` package comes with the Angular logo for the app icons. Be sure to update the manifest to use the correct app name and also replace the icons.
23
+
:::
22
24
23
25
24
-
> Note: Features like Service Workers and many JavaScript APIs (such as geolocation) require the app be hosted in a secure context. When deploying an app through a hosting service, be aware that HTTPS will be required to take full advantage of Service Workers.
26
+
:::note
27
+
Features like Service Workers and many JavaScript APIs (such as geolocation) require the app be hosted in a secure context. When deploying an app through a hosting service, be aware that HTTPS will be required to take full advantage of Service Workers.
28
+
:::
25
29
26
30
## Service Worker configuration
27
31
@@ -75,7 +79,9 @@ Next, in a Terminal, install the Firebase CLI:
75
79
$ npm install -g firebase-tools
76
80
```
77
81
78
-
> Note: If it's the first time you use firebase-tools, login to your Google account with `firebase login` command.
82
+
:::note
83
+
If it's the first time you use firebase-tools, login to your Google account with `firebase login` command.
84
+
:::
79
85
80
86
With the Firebase CLI installed, run `firebase init` within your Ionic project. The CLI prompts:
81
87
@@ -85,7 +91,9 @@ With the Firebase CLI installed, run `firebase init` within your Ionic project.
85
91
86
92
**"What do you want to use as your public directory?"** Enter "www".
87
93
88
-
> Note: Answering these next two questions will ensure that routing, hard reload, and deep linking work in the app:
94
+
:::note
95
+
Answering these next two questions will ensure that routing, hard reload, and deep linking work in the app:
96
+
:::
89
97
90
98
**Configure as a single-page app (rewrite all urls to /index.html)?"** Enter "Yes".
Copy file name to clipboardExpand all lines: docs/angular/slides.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -138,7 +138,9 @@ export class SlidesExample {
138
138
</swiper>
139
139
```
140
140
141
-
> Importing `swiper-bundle.min.css` imports styles for all modules. When using the SCSS or Less styles, you will need to import the styles for each module. See <ahref="https://swiperjs.com/angular#styles"target="_blank"rel="noopener noreferrer">https://swiperjs.com/angular#styles</a> for a full list of stylesheets.
141
+
:::note
142
+
Importing `swiper-bundle.min.css` imports styles for all modules. When using the SCSS or Less styles, you will need to import the styles for each module. See <ahref="https://swiperjs.com/angular#styles"target="_blank"rel="noopener noreferrer">https://swiperjs.com/angular#styles</a> for a full list of stylesheets.
143
+
:::
142
144
## Properties
143
145
144
146
Swiper options are provided as props directly on the `<swiper>` component rather than via the `options` object in `ion-slides`.
> Looking for the previous version of this guide that covered Ionic 4 and Cordova? [See here.](../developer-resources/guides/first-app-v4/intro.md)
13
+
:::note
14
+
Looking for the previous version of this guide that covered Ionic 4 and Cordova? [See here.](../developer-resources/guides/first-app-v4/intro.md)
15
+
:::
14
16
15
17
## What We'll Build
16
18
@@ -35,15 +37,19 @@ Download and install these right away to ensure an optimal Ionic development exp
35
37
## Install Ionic Tooling
36
38
Run the following in the command line terminal to install the Ionic CLI (`ionic`), `native-run`, used to run native binaries on devices and simulators/emulators, and `cordova-res`, used to generate native app icons and splash screens:
37
39
38
-
> To open a terminal in Visual Studio Code, go to Terminal -> New Terminal.
40
+
:::note
41
+
To open a terminal in Visual Studio Code, go to Terminal -> New Terminal.
> The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
45
-
>
46
-
> Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../developing/tips.md#resolving-permission-errors) for more information.
48
+
:::note
49
+
The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
50
+
51
+
Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../developing/tips.md#resolving-permission-errors) for more information.
52
+
:::
47
53
48
54
## Create an App
49
55
Next, create an Ionic Angular app that uses the “Tabs” starter template and adds Capacitor for native functionality:
Copy file name to clipboardExpand all lines: docs/angular/your-first-app/6-deploying-mobile.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,9 @@ $ ionic cap sync
39
39
40
40
## iOS Deployment
41
41
42
-
> To build an iOS app, you’ll need a Mac computer.
42
+
:::note
43
+
To build an iOS app, you’ll need a Mac computer.
44
+
:::
43
45
44
46
Capacitor iOS apps are configured and managed through Xcode (Apple’s iOS/Mac IDE), with dependencies managed by [CocoaPods](https://cocoapods.org/). Before running this app on an iOS device, there's a couple of steps to complete.
The Ionic CLI supports a multi-app configuration setup, which involves multiple Ionic apps and shared code within a single repository, or [monorepo](../reference/glossary.md#monorepo).
113
113
114
-
> These docs give an overview of the multi-app feature of the Ionic CLI, but don't really go into details for each framework.
115
-
>
116
-
> If you're using Angular, please see [this article](https://github.com/ionic-team/ionic-cli/wiki/Angular-Monorepo) for examples.
114
+
:::note
115
+
These docs give an overview of the multi-app feature of the Ionic CLI, but don't really go into details for each framework.
116
+
117
+
If you're using Angular, please see [this article](https://github.com/ionic-team/ionic-cli/wiki/Angular-Monorepo) for examples.
118
+
:::
117
119
118
120
### Setup Steps
119
121
@@ -192,7 +194,9 @@ $ ionic start "My New App" --no-deps
192
194
193
195
If an app was created in a way other than `ionic start`, for example by using a prebuilt template, use `ionic init` to register the existing app with the multi-app project.
194
196
195
-
> Make sure the app doesn't have an existing `ionic.config.json`.
197
+
:::note
198
+
Make sure the app doesn't have an existing `ionic.config.json`.
> Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
26
+
:::note
27
+
Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
28
+
:::
27
29
28
30
### Cordova
29
31
@@ -41,7 +43,9 @@ $ ionic cordova run android -l
41
43
42
44
For iOS devices, port forwarding is not yet an option. This means you'll need to connect your device to the same Wi-Fi network as your computer and use an external address for the dev server.
43
45
44
-
> You can track [this issue](https://github.com/ionic-team/native-run/issues/20) for progress on iOS port forwarding with Ionic.
46
+
:::note
47
+
You can track [this issue](https://github.com/ionic-team/native-run/issues/20) for progress on iOS port forwarding with Ionic.
48
+
:::
45
49
46
50
In some cases, the Ionic CLI won't know the address with which to configure the Web View, so you may be prompted to select one. Be sure to select the address of your computer on your Wi-Fi network.
47
51
@@ -51,7 +55,9 @@ The following all-in-one command will start a live-reload server on **all addres
51
55
$ ionic cordova run ios -l --external
52
56
```
53
57
54
-
> Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
58
+
:::note
59
+
Remember, with the `--external` option, others on your Wi-Fi network will be able to access your app.
Copy file name to clipboardExpand all lines: docs/deployment/app-store.md
+3-1
Original file line number
Diff line number
Diff line change
@@ -62,4 +62,6 @@ An app can be updated by either submitting a new version to Apple, or by using a
62
62
63
63
With <strong>Live Updates</strong>, app changes can be pushed in realtime directly to users from the Appflow dashboard, without waiting for App Store approvals.
64
64
65
-
> In order for the iOS App Store to accept the updated build, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the same instructions above.
65
+
:::note
66
+
In order for the iOS App Store to accept the updated build, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the same instructions above.
Once that command has been ran and its prompts have been answered a file called `my-release-key.keystore` will be created in the current directory.
29
29
30
-
> WARNING: Save this file and keep it somewhere safe. If it is lost the Google Play Store will not accept updates for this app!
30
+
:::caution
31
+
Save this file and keep it somewhere safe. If it is lost the Google Play Store will not accept updates for this app!
32
+
:::
31
33
32
34
To sign the unsigned APK, run the jarsigner tool which is also included in the Android SDK:
33
35
@@ -51,7 +53,9 @@ Now that a release APK has been generated, a Play Store listing can be written a
51
53
52
54
To start, visit the [Google Play Store Developer Console](https://play.google.com/apps/publish) and create a new developer account.
53
55
54
-
> Making a developer account with Google Play costs $25 USD.
56
+
:::note
57
+
Making a developer account with Google Play costs $25 USD.
58
+
:::
55
59
56
60
Once a developer account has been created, go ahead and click the `Create an Application`
57
61
@@ -65,4 +69,6 @@ When ready, upload the signed release APK that was generated and publish the app
65
69
66
70
As an app evolves, it will need to be updated with new features and fixes. An app can be updated by either submitting a new version to the Google Play Store, or by using a live update service like Appflow's Live Update feature. Using Live Updates, changes can be pushed directly to users from the Appflow dashboard, without submitting changes to the Play Store. Learn more about Live Updates <ahref="https://ionic.io/docs/appflow/deploy/intro"target="_blank">here</a>.
67
71
68
-
> In order for the Google Play Store to accept updated APKs, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the instructions above.
72
+
:::note
73
+
In order for the Google Play Store to accept updated APKs, the config.xml file will need to be edited to increment the version value, then rebuild the app for release following the instructions above.
Copy file name to clipboardExpand all lines: docs/developer-resources/guides/first-app-v4/intro.md
+5-3
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,11 @@ Run the following in the command line:
21
21
$ npm install -g @ionic/cli cordova
22
22
```
23
23
24
-
> The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
25
-
>
26
-
> Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../../../developing/tips.md#resolving-permission-errors) for more information.
24
+
:::note
25
+
The `-g` option means _install globally_. When packages are installed globally, `EACCES` permission errors can occur.
26
+
27
+
Consider setting up npm to operate globally without elevated permissions. See [Resolving Permission Errors](../../../developing/tips.md#resolving-permission-errors) for more information.
28
+
:::
27
29
28
30
## Create an App
29
31
Next, create an Ionic Angular app using our “Tabs” app template:
Copy file name to clipboardExpand all lines: docs/developing/android.md
+12-4
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,9 @@ This guide covers how to run and debug Ionic apps on Android emulators and devic
12
12
13
13
Android Studio is also used to [create Android virtual devices](android.md#creating-an-android-virtual-device), which are required for the Android emulator. Ionic apps can also be [launched to a device](android.md#set-up-an-android-device).
14
14
15
-
> We don't recommend using Android Studio for _developing_ Ionic apps. Instead, it should only really be used to build and run your apps for the native Android platform and to manage the Android SDK and virtual devices.
15
+
:::note
16
+
We don't recommend using Android Studio for _developing_ Ionic apps. Instead, it should only really be used to build and run your apps for the native Android platform and to manage the Android SDK and virtual devices.
17
+
:::
16
18
17
19
### Installing Android Studio
18
20
@@ -97,7 +99,9 @@ Additional setup is required for Cordova to support programmatic builds. This se
97
99
98
100
Native Android apps are compiled with the <ahref="https://java.com/en/"target="_blank">Java</a> programming language. Download JDK8 from the <ahref="https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html"target="_blank">download page</a>.
99
101
100
-
> Unfortunately, Cordova is not compatible with the latest version of Java.
102
+
:::note
103
+
Unfortunately, Cordova is not compatible with the latest version of Java.
104
+
:::
101
105
102
106
### Gradle
103
107
@@ -173,15 +177,19 @@ Once an app is running on an Android device or emulator, it can be debugged with
173
177
174
178
Chrome has web developer tool support for Android simulators and devices. Go to `chrome://inspect` in Chrome while the simulator is running or a device is connected to the computer and **Inspect** the app that needs to be debugged.
175
179
176
-
> Make sure your application is running on the device or simulator, or it will not show up in the list.
180
+
:::note
181
+
Make sure your application is running on the device or simulator, or it will not show up in the list.
Copy file name to clipboardExpand all lines: docs/developing/hardware-back-button.md
+6-2
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,9 @@ import TabItem from '@theme/TabItem';
5
5
6
6
The hardware back button is found on most Android devices. In native applications it can be used to close modals, navigate to the previous view, exit an app, and more. By default in Ionic, when the back button is pressed, the current view will be popped off the navigation stack, and the previous view will be displayed. If no previous view exists in the navigation stack, nothing will happen. This guide will show how to customize the behavior of the hardware back button.
7
7
8
-
> The hardware back button refers to the physical back button on an Android device and should not be confused with either the browser back button or `ion-back-button`. The information in this guide only applies to Android devices.
8
+
:::note
9
+
The hardware back button refers to the physical back button on an Android device and should not be confused with either the browser back button or `ion-back-button`. The information in this guide only applies to Android devices.
10
+
:::
9
11
10
12
## Hardware Back Button in Capacitor and Cordova
11
13
@@ -21,7 +23,9 @@ When running your app in a mobile browser or as a PWA, hardware back button cust
21
23
22
24
For complete hardware back button support, we recommend using Capacitor or Cordova.
23
25
24
-
> The `ionBackButton` event will not be emitted when running an app in a browser or as a PWA.
26
+
:::note
27
+
The `ionBackButton` event will not be emitted when running an app in a browser or as a PWA.
0 commit comments