Skip to content

Commit af0d981

Browse files
docs(playgrounds): rename ev to event for consistency (#3982)
1 parent e2542fe commit af0d981

File tree

205 files changed

+616
-622
lines changed

Some content is hidden

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

205 files changed

+616
-622
lines changed

docs/developing/hardware-back-button.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ The `ionBackButton` event will not be emitted when running an app in a browser o
6767
<TabItem value="javascript">
6868
6969
```javascript
70-
document.addEventListener('ionBackButton', (ev) => {
71-
ev.detail.register(10, () => {
70+
document.addEventListener('ionBackButton', (event) => {
71+
event.detail.register(10, () => {
7272
console.log('Handler was called!');
7373
});
7474
});
@@ -108,8 +108,8 @@ constructor(private platform: Platform) {
108108
<TabItem value="react">
109109
110110
```tsx
111-
document.addEventListener('ionBackButton', (ev) => {
112-
ev.detail.register(10, () => {
111+
document.addEventListener('ionBackButton', (event) => {
112+
event.detail.register(10, () => {
113113
console.log('Handler was called!');
114114
});
115115
});
@@ -157,12 +157,12 @@ Each hardware back button callback has a `processNextHandler` parameter. Calling
157157
<TabItem value="javascript">
158158
159159
```javascript
160-
document.addEventListener('ionBackButton', (ev) => {
161-
ev.detail.register(5, () => {
160+
document.addEventListener('ionBackButton', (event) => {
161+
event.detail.register(5, () => {
162162
console.log('Another handler was called!');
163163
});
164164
165-
ev.detail.register(10, (processNextHandler) => {
165+
event.detail.register(10, (processNextHandler) => {
166166
console.log('Handler was called!');
167167
168168
processNextHandler();
@@ -216,12 +216,12 @@ constructor(private platform: Platform) {
216216
<TabItem value="react">
217217
218218
```tsx
219-
document.addEventListener('ionBackButton', (ev) => {
220-
ev.detail.register(5, () => {
219+
document.addEventListener('ionBackButton', (event) => {
220+
event.detail.register(5, () => {
221221
console.log('Another handler was called!');
222222
});
223223
224-
ev.detail.register(10, (processNextHandler) => {
224+
event.detail.register(10, (processNextHandler) => {
225225
console.log('Handler was called!');
226226
227227
processNextHandler();
@@ -261,16 +261,16 @@ This example shows how to indicate to Ionic Framework that you want the next han
261261
Internally, Ionic Framework uses something similar to a priority queue to manage hardware back button handlers. The handler with the largest priority value will be called first. In the event that there are multiple handlers with the same priority value, the _last_ handler of the same priority added to this queue will be the first handler to be called.
262262

263263
```javascript
264-
document.addEventListener('ionBackButton', (ev) => {
264+
document.addEventListener('ionBackButton', (event) => {
265265
// Handler A
266-
ev.detail.register(10, (processNextHandler) => {
266+
event.detail.register(10, (processNextHandler) => {
267267
console.log('Handler A was called!');
268268

269269
processNextHandler();
270270
});
271271

272272
// Handler B
273-
ev.detail.register(10, (processNextHandler) => {
273+
event.detail.register(10, (processNextHandler) => {
274274
console.log('Handler B was called!');
275275

276276
processNextHandler();
@@ -305,8 +305,8 @@ import { App } from '@capacitor/app';
305305
...
306306
307307
const routerEl = document.querySelector('ion-router');
308-
document.addEventListener('ionBackButton', (ev: BackButtonEvent) => {
309-
ev.detail.register(-1, () => {
308+
document.addEventListener('ionBackButton', (event: BackButtonEvent) => {
309+
event.detail.register(-1, () => {
310310
const path = window.location.pathname;
311311
if (path === routerEl.root) {
312312
App.exitApp();
@@ -368,8 +368,8 @@ import { App } from '@capacitor/app';
368368
...
369369
370370
const ionRouter = useIonRouter();
371-
document.addEventListener('ionBackButton', (ev) => {
372-
ev.detail.register(-1, () => {
371+
document.addEventListener('ionBackButton', (event) => {
372+
event.detail.register(-1, () => {
373373
if (!ionRouter.canGoBack()) {
374374
App.exitApp();
375375
}

docs/developing/keyboard.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ Detecting the presence of an on-screen keyboard is useful for adjusting the posi
9090
<TabItem value="javascript">
9191
9292
```javascript
93-
window.addEventListener('ionKeyboardDidShow', ev => {
94-
const { keyboardHeight } = ev;
93+
window.addEventListener('ionKeyboardDidShow', event => {
94+
const { keyboardHeight } = event;
9595
// Do something with the keyboard height such as translating an input above the keyboard.
9696
});
9797
@@ -108,8 +108,8 @@ import { Platform } from '@ionic/angular';
108108
...
109109
110110
constructor(private platform: Platform) {
111-
this.platform.keyboardDidShow.subscribe(ev => {
112-
const { keyboardHeight } = ev;
111+
this.platform.keyboardDidShow.subscribe(event => {
112+
const { keyboardHeight } = event;
113113
// Do something with the keyboard height such as translating an input above the keyboard.
114114
});
115115
@@ -127,8 +127,8 @@ import { Platform } from '@ionic/angular/standalone';
127127
...
128128
129129
constructor(private platform: Platform) {
130-
this.platform.keyboardDidShow.subscribe(ev => {
131-
const { keyboardHeight } = ev;
130+
this.platform.keyboardDidShow.subscribe(event => {
131+
const { keyboardHeight } = event;
132132
// Do something with the keyboard height such as translating an input above the keyboard.
133133
});
134134

docs/utilities/gestures.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const gesture = createGesture({
4747
el: elementRef,
4848
threshold: 15,
4949
gestureName: 'my-gesture',
50-
onMove: ev => onMoveHandler(ev)
50+
onMove: event => onMoveHandler(event)
5151
});
5252
5353
```
@@ -65,7 +65,7 @@ const gesture: Gesture = createGesture({
6565
el: elementRef,
6666
threshold: 15,
6767
gestureName: 'my-gesture',
68-
onMove: ev => onMoveHandler(ev)
68+
onMove: event => onMoveHandler(event)
6969
});
7070
```
7171
</TabItem>
@@ -86,7 +86,7 @@ constructor(private gestureCtrl: GestureController) {
8686
el: this.element.nativeElement,
8787
threshold: 15,
8888
gestureName: 'my-gesture',
89-
onMove: ev => this.onMoveHandler(ev)
89+
onMove: event => this.onMoveHandler(event)
9090
}, true);
9191
// The `true` above ensures that callbacks run inside NgZone.
9292
}
@@ -110,7 +110,7 @@ constructor(private gestureCtrl: GestureController) {
110110
el: this.element.nativeElement,
111111
threshold: 15,
112112
gestureName: 'my-gesture',
113-
onMove: ev => this.onMoveHandler(ev)
113+
onMove: event => this.onMoveHandler(event)
114114
}, true);
115115
// The `true` above ensures that callbacks run inside NgZone.
116116
}
@@ -130,7 +130,7 @@ const gesture: Gesture = createGesture({
130130
el: elementRef,
131131
threshold: 15,
132132
gestureName: 'my-gesture',
133-
onMove: ev => onMoveHandler(ev)
133+
onMove: event => onMoveHandler(event)
134134
});
135135
```
136136
</TabItem>
@@ -152,7 +152,7 @@ const gesture = createGesture({
152152
el: elementRef.value,
153153
threshold: 15,
154154
gestureName: 'my-gesture',
155-
onMove: ev => onMoveHandler(ev)
155+
onMove: event => onMoveHandler(event)
156156
});
157157
158158
```

src/components/global/Playground/index.tsx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -388,15 +388,15 @@ export default function Playground({
388388
useEffect(() => {
389389
if (showConsole) {
390390
if (frameiOS.current) {
391-
frameiOS.current.contentWindow.addEventListener('console', (ev: CustomEvent) => {
392-
setiOSConsoleItems((oldConsoleItems) => [...oldConsoleItems, ev.detail]);
391+
frameiOS.current.contentWindow.addEventListener('console', (event: CustomEvent) => {
392+
setiOSConsoleItems((oldConsoleItems) => [...oldConsoleItems, event.detail]);
393393
consoleBodyRef.current.scrollTo(0, consoleBodyRef.current.scrollHeight);
394394
});
395395
}
396396

397397
if (frameMD.current) {
398-
frameMD.current.contentWindow.addEventListener('console', (ev: CustomEvent) => {
399-
setMDConsoleItems((oldConsoleItems) => [...oldConsoleItems, ev.detail]);
398+
frameMD.current.contentWindow.addEventListener('console', (event: CustomEvent) => {
399+
setMDConsoleItems((oldConsoleItems) => [...oldConsoleItems, event.detail]);
400400
consoleBodyRef.current.scrollTo(0, consoleBodyRef.current.scrollHeight);
401401
});
402402
}
@@ -425,9 +425,9 @@ export default function Playground({
425425
useEffect(() => {
426426
const io = new IntersectionObserver(
427427
(entries: IntersectionObserverEntry[]) => {
428-
const ev = entries[0];
429-
setIsInView(ev.isIntersecting);
430-
if (!ev.isIntersecting) return;
428+
const event = entries[0];
429+
setIsInView(event.isIntersecting);
430+
if (!event.isIntersecting) return;
431431

432432
/**
433433
* Load the stored mode and/or usage target, if present

src/components/page/theming/ColorGenerator/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ const ColorGenerator = (props) => {
6060
</div>
6161
<div className={styles.titleRowEnd}>
6262
<ColorInput
63-
onClick={(ev) => ev.stopPropagation()}
63+
onClick={(event) => event.stopPropagation()}
6464
color={formattedValue}
6565
setColor={(color) =>
6666
setColors((colors) => {

src/components/page/theming/LayeredColorsSelect/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ export default function LayeredColorsSelect({ ...props }) {
7272
<div className={styles.selectRow}>
7373
<ColorDot color={`var(--ion-color-${color})`} />
7474
<InputWrapper>
75-
<select value={color} onChange={(ev) => setColor((ev.target as HTMLSelectElement).value)}>
75+
<select value={color} onChange={(event) => setColor((event.target as HTMLSelectElement).value)}>
7676
<option value="primary">Primary</option>
7777
<option value="secondary">Secondary</option>
7878
<option value="tertiary">Tertiary</option>

static/demos/api/popover/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@
4545
buttons[i].addEventListener('click', handleButtonClick);
4646
}
4747

48-
async function handleButtonClick(ev) {
48+
async function handleButtonClick(event) {
4949
popover = await popoverController.create({
5050
component: 'popover-example-page',
51-
event: ev,
51+
event: event,
5252
translucent: true,
5353
});
5454
currentPopover = popover;

static/usage/v7/accordion/listen-changes/angular/example_component_ts.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ import { IonAccordion, IonAccordionGroup, IonItem, IonLabel } from '@ionic/angul
1111
export class ExampleComponent {
1212
private values: string[] = ['first', 'second', 'third'];
1313

14-
accordionGroupChange = (ev: CustomEvent) => {
15-
const collapsedItems = this.values.filter((value) => value !== ev.detail.value);
16-
const selectedValue = ev.detail.value;
14+
accordionGroupChange = (event: CustomEvent) => {
15+
const collapsedItems = this.values.filter((value) => value !== event.detail.value);
16+
const selectedValue = event.detail.value;
1717

1818
console.log(
19-
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
19+
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
2020
);
2121
};
2222
}

static/usage/v7/accordion/listen-changes/demo.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@
4242
const accordionGroup = document.querySelector('ion-accordion-group');
4343
const values = ['first', 'second', 'third'];
4444

45-
accordionGroup.addEventListener('ionChange', (ev) => {
46-
const collapsedItems = values.filter((value) => value !== ev.detail.value);
47-
const selectedValue = ev.detail.value;
45+
accordionGroup.addEventListener('ionChange', (event) => {
46+
const collapsedItems = values.filter((value) => value !== event.detail.value);
47+
const selectedValue = event.detail.value;
4848

4949
console.log(
50-
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(
50+
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(
5151
', '
5252
)}`
5353
);

static/usage/v7/accordion/listen-changes/javascript.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
const accordionGroup = document.querySelector('ion-accordion-group');
2525
const values = ['first', 'second', 'third'];
2626
27-
accordionGroup.addEventListener('ionChange', (ev) => {
28-
const collapsedItems = values.filter((value) => value !== ev.detail.value);
29-
const selectedValue = ev.detail.value;
27+
accordionGroup.addEventListener('ionChange', (event) => {
28+
const collapsedItems = values.filter((value) => value !== event.detail.value);
29+
const selectedValue = event.detail.value;
3030
3131
console.log(
32-
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
32+
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
3333
);
3434
});
3535
</script>

0 commit comments

Comments
 (0)