Skip to content

Commit 43da37f

Browse files
committed
chore(): update BREAKING
1 parent 5b6eb2c commit 43da37f

File tree

1 file changed

+45
-11
lines changed

1 file changed

+45
-11
lines changed

angular/BREAKING.md

Lines changed: 45 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,15 @@ A list of the breaking changes introduced to each component in Ionic Angular v4.
5858

5959
## Action Sheet
6060

61-
The `title` and `subTitle` properties has been renamed to `header` and `subHeader` respectively.
61+
The `title`, `subTitle` and `enableBackdropDismiss` properties has been renamed to `header`, `subHeader` and `backdropDismiss` respectively.
6262

6363
**Old Usage Example:**
6464

6565
```js
6666
const actionSheet = await actionSheetCtrl.create({
6767
title: 'This is the title',
68-
subTitle: 'this is the sub title'
68+
subTitle: 'this is the sub title',
69+
enableBackdropDismiss: false
6970
});
7071
await actionSheet.present();
7172
```
@@ -75,22 +76,24 @@ await actionSheet.present();
7576
```js
7677
const actionSheet = await actionSheetCtrl.create({
7778
header: 'This is the title',
78-
subHeader: 'this is the sub title'
79+
subHeader: 'this is the sub title',
80+
backdropDismiss: false
7981
});
8082
await actionSheet.present();
8183
```
8284

8385

8486
## Alert
8587

86-
The `title` and `subTitle` properties has been renamed to `header` and `subHeader` respectivelly.
88+
The `title`, `subTitle` and `enableBackdropDismiss` properties has been renamed to `header`, `subHeader` and `backdropDismiss` respectivelly.
8789

8890
**Old Usage Example:**
8991

9092
```js
9193
const alert = await alertCtrl.create({
9294
title: 'This is the title',
93-
subTitle: 'this is the sub title'
95+
subTitle: 'this is the sub title',
96+
enableBackdropDismiss: false
9497
});
9598
await alert.present();
9699
```
@@ -100,7 +103,8 @@ await alert.present();
100103
```js
101104
const alert = await alertCtrl.create({
102105
header: 'This is the title',
103-
subHeader: 'this is the sub title'
106+
subHeader: 'this is the sub title',
107+
backdropDismiss: false
104108
});
105109
await alert.present();
106110
```
@@ -815,6 +819,27 @@ Previously an `ion-label` would automatically get added to an `ion-list-header`
815819
You should take advantage of these APIs in order to dismiss your loading overlay explicitally.
816820

817821

822+
## Menu
823+
824+
### Prop renamed
825+
826+
The `swipeEnabled` prop has been renamed to `swipeGesture`.
827+
The `content` prop has been renamed to `contentId` and it points to the DOM id of the content:
828+
829+
**Old Usage Example:**
830+
831+
```html
832+
<ion-menu swipeEnabled="false" content="nav"> </ion-menu>
833+
<ion-nav #nav></ion-nav>
834+
```
835+
836+
**New Usage Example:**
837+
838+
```html
839+
<ion-menu swipeGesture="false" contentId="nav"> </ion-menu>
840+
<ion-nav id="nav"></ion-nav>
841+
```
842+
818843
## Menu Toggle
819844

820845
### Markup Changed
@@ -896,9 +921,12 @@ export class MyPage {
896921
### Method renamed
897922

898923
The `remove` method has been renamed to `removeIndex` to avoid conflicts with HTML and be more descriptive as to what it does.
899-
900924
The `getActiveChildNavs` method has been renamed to `getChildNavs`.
901925

926+
### Prop renamed
927+
928+
The `swipeBackEnabled` prop has been renamed to `swipeGesture`.
929+
902930

903931
## Navbar
904932

@@ -959,16 +987,21 @@ The class has been renamed from `Option` to `SelectOption` to keep it consistent
959987

960988
### Markup Changed
961989

962-
Action Sheet, Alert, Loading, Modal, Popover, and Toast should now use `async`/`await`:
990+
Action Sheet, Alert, Loading, Modal, Popover, and Toast:
991+
- Should now use `async`/`await`
992+
- `enableBackdropDismiss` has been renamed to `backdropDismiss`.
993+
994+
963995

964996
**Old Usage Example:**
965997

966998
```javascript
967999
presentPopover(ev: any) {
9681000
const popover = this.popoverController.create({
9691001
component: PopoverComponent,
970-
ev: event,
971-
translucent: true
1002+
event: event,
1003+
translucent: true,
1004+
enableBackdropDismiss: false
9721005
});
9731006
popover.present();
9741007
}
@@ -981,7 +1014,8 @@ async presentPopover(ev: any) {
9811014
const popover = await this.popoverController.create({
9821015
component: PopoverComponent,
9831016
event: event,
984-
translucent: true
1017+
translucent: true,
1018+
backdropDismiss: false
9851019
});
9861020
return await popover.present();
9871021
}

0 commit comments

Comments
 (0)