Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(playgrounds): rename ev to event for consistency #3982

Merged
merged 6 commits into from
Dec 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/developing/hardware-back-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ The `ionBackButton` event will not be emitted when running an app in a browser o
<TabItem value="javascript">

```javascript
document.addEventListener('ionBackButton', (ev) => {
ev.detail.register(10, () => {
document.addEventListener('ionBackButton', (event) => {
event.detail.register(10, () => {
console.log('Handler was called!');
});
});
Expand Down Expand Up @@ -108,8 +108,8 @@ constructor(private platform: Platform) {
<TabItem value="react">

```tsx
document.addEventListener('ionBackButton', (ev) => {
ev.detail.register(10, () => {
document.addEventListener('ionBackButton', (event) => {
event.detail.register(10, () => {
console.log('Handler was called!');
});
});
Expand Down Expand Up @@ -157,12 +157,12 @@ Each hardware back button callback has a `processNextHandler` parameter. Calling
<TabItem value="javascript">

```javascript
document.addEventListener('ionBackButton', (ev) => {
ev.detail.register(5, () => {
document.addEventListener('ionBackButton', (event) => {
event.detail.register(5, () => {
console.log('Another handler was called!');
});

ev.detail.register(10, (processNextHandler) => {
event.detail.register(10, (processNextHandler) => {
console.log('Handler was called!');

processNextHandler();
Expand Down Expand Up @@ -216,12 +216,12 @@ constructor(private platform: Platform) {
<TabItem value="react">

```tsx
document.addEventListener('ionBackButton', (ev) => {
ev.detail.register(5, () => {
document.addEventListener('ionBackButton', (event) => {
event.detail.register(5, () => {
console.log('Another handler was called!');
});

ev.detail.register(10, (processNextHandler) => {
event.detail.register(10, (processNextHandler) => {
console.log('Handler was called!');

processNextHandler();
Expand Down Expand Up @@ -261,16 +261,16 @@ This example shows how to indicate to Ionic Framework that you want the next han
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.

```javascript
document.addEventListener('ionBackButton', (ev) => {
document.addEventListener('ionBackButton', (event) => {
// Handler A
ev.detail.register(10, (processNextHandler) => {
event.detail.register(10, (processNextHandler) => {
console.log('Handler A was called!');

processNextHandler();
});

// Handler B
ev.detail.register(10, (processNextHandler) => {
event.detail.register(10, (processNextHandler) => {
console.log('Handler B was called!');

processNextHandler();
Expand Down Expand Up @@ -305,8 +305,8 @@ import { App } from '@capacitor/app';
...

const routerEl = document.querySelector('ion-router');
document.addEventListener('ionBackButton', (ev: BackButtonEvent) => {
ev.detail.register(-1, () => {
document.addEventListener('ionBackButton', (event: BackButtonEvent) => {
event.detail.register(-1, () => {
const path = window.location.pathname;
if (path === routerEl.root) {
App.exitApp();
Expand Down Expand Up @@ -368,8 +368,8 @@ import { App } from '@capacitor/app';
...

const ionRouter = useIonRouter();
document.addEventListener('ionBackButton', (ev) => {
ev.detail.register(-1, () => {
document.addEventListener('ionBackButton', (event) => {
event.detail.register(-1, () => {
if (!ionRouter.canGoBack()) {
App.exitApp();
}
Expand Down
12 changes: 6 additions & 6 deletions docs/developing/keyboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ Detecting the presence of an on-screen keyboard is useful for adjusting the posi
<TabItem value="javascript">

```javascript
window.addEventListener('ionKeyboardDidShow', ev => {
const { keyboardHeight } = ev;
window.addEventListener('ionKeyboardDidShow', event => {
const { keyboardHeight } = event;
// Do something with the keyboard height such as translating an input above the keyboard.
});

Expand All @@ -108,8 +108,8 @@ import { Platform } from '@ionic/angular';
...

constructor(private platform: Platform) {
this.platform.keyboardDidShow.subscribe(ev => {
const { keyboardHeight } = ev;
this.platform.keyboardDidShow.subscribe(event => {
const { keyboardHeight } = event;
// Do something with the keyboard height such as translating an input above the keyboard.
});

Expand All @@ -127,8 +127,8 @@ import { Platform } from '@ionic/angular/standalone';
...

constructor(private platform: Platform) {
this.platform.keyboardDidShow.subscribe(ev => {
const { keyboardHeight } = ev;
this.platform.keyboardDidShow.subscribe(event => {
const { keyboardHeight } = event;
// Do something with the keyboard height such as translating an input above the keyboard.
});

Expand Down
12 changes: 6 additions & 6 deletions docs/utilities/gestures.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const gesture = createGesture({
el: elementRef,
threshold: 15,
gestureName: 'my-gesture',
onMove: ev => onMoveHandler(ev)
onMove: event => onMoveHandler(event)
});

```
Expand All @@ -65,7 +65,7 @@ const gesture: Gesture = createGesture({
el: elementRef,
threshold: 15,
gestureName: 'my-gesture',
onMove: ev => onMoveHandler(ev)
onMove: event => onMoveHandler(event)
});
```
</TabItem>
Expand All @@ -86,7 +86,7 @@ constructor(private gestureCtrl: GestureController) {
el: this.element.nativeElement,
threshold: 15,
gestureName: 'my-gesture',
onMove: ev => this.onMoveHandler(ev)
onMove: event => this.onMoveHandler(event)
}, true);
// The `true` above ensures that callbacks run inside NgZone.
}
Expand All @@ -110,7 +110,7 @@ constructor(private gestureCtrl: GestureController) {
el: this.element.nativeElement,
threshold: 15,
gestureName: 'my-gesture',
onMove: ev => this.onMoveHandler(ev)
onMove: event => this.onMoveHandler(event)
}, true);
// The `true` above ensures that callbacks run inside NgZone.
}
Expand All @@ -130,7 +130,7 @@ const gesture: Gesture = createGesture({
el: elementRef,
threshold: 15,
gestureName: 'my-gesture',
onMove: ev => onMoveHandler(ev)
onMove: event => onMoveHandler(event)
});
```
</TabItem>
Expand All @@ -152,7 +152,7 @@ const gesture = createGesture({
el: elementRef.value,
threshold: 15,
gestureName: 'my-gesture',
onMove: ev => onMoveHandler(ev)
onMove: event => onMoveHandler(event)
});

```
Expand Down
14 changes: 7 additions & 7 deletions src/components/global/Playground/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -388,15 +388,15 @@ export default function Playground({
useEffect(() => {
if (showConsole) {
if (frameiOS.current) {
frameiOS.current.contentWindow.addEventListener('console', (ev: CustomEvent) => {
setiOSConsoleItems((oldConsoleItems) => [...oldConsoleItems, ev.detail]);
frameiOS.current.contentWindow.addEventListener('console', (event: CustomEvent) => {
setiOSConsoleItems((oldConsoleItems) => [...oldConsoleItems, event.detail]);
consoleBodyRef.current.scrollTo(0, consoleBodyRef.current.scrollHeight);
});
}

if (frameMD.current) {
frameMD.current.contentWindow.addEventListener('console', (ev: CustomEvent) => {
setMDConsoleItems((oldConsoleItems) => [...oldConsoleItems, ev.detail]);
frameMD.current.contentWindow.addEventListener('console', (event: CustomEvent) => {
setMDConsoleItems((oldConsoleItems) => [...oldConsoleItems, event.detail]);
consoleBodyRef.current.scrollTo(0, consoleBodyRef.current.scrollHeight);
});
}
Expand Down Expand Up @@ -425,9 +425,9 @@ export default function Playground({
useEffect(() => {
const io = new IntersectionObserver(
(entries: IntersectionObserverEntry[]) => {
const ev = entries[0];
setIsInView(ev.isIntersecting);
if (!ev.isIntersecting) return;
const event = entries[0];
setIsInView(event.isIntersecting);
if (!event.isIntersecting) return;

/**
* Load the stored mode and/or usage target, if present
Expand Down
2 changes: 1 addition & 1 deletion src/components/page/theming/ColorGenerator/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ const ColorGenerator = (props) => {
</div>
<div className={styles.titleRowEnd}>
<ColorInput
onClick={(ev) => ev.stopPropagation()}
onClick={(event) => event.stopPropagation()}
color={formattedValue}
setColor={(color) =>
setColors((colors) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export default function LayeredColorsSelect({ ...props }) {
<div className={styles.selectRow}>
<ColorDot color={`var(--ion-color-${color})`} />
<InputWrapper>
<select value={color} onChange={(ev) => setColor((ev.target as HTMLSelectElement).value)}>
<select value={color} onChange={(event) => setColor((event.target as HTMLSelectElement).value)}>
<option value="primary">Primary</option>
<option value="secondary">Secondary</option>
<option value="tertiary">Tertiary</option>
Expand Down
4 changes: 2 additions & 2 deletions static/demos/api/popover/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@
buttons[i].addEventListener('click', handleButtonClick);
}

async function handleButtonClick(ev) {
async function handleButtonClick(event) {
popover = await popoverController.create({
component: 'popover-example-page',
event: ev,
event: event,
translucent: true,
});
currentPopover = popover;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ import { IonAccordion, IonAccordionGroup, IonItem, IonLabel } from '@ionic/angul
export class ExampleComponent {
private values: string[] = ['first', 'second', 'third'];

accordionGroupChange = (ev: CustomEvent) => {
const collapsedItems = this.values.filter((value) => value !== ev.detail.value);
const selectedValue = ev.detail.value;
accordionGroupChange = (event: CustomEvent) => {
const collapsedItems = this.values.filter((value) => value !== event.detail.value);
const selectedValue = event.detail.value;

console.log(
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
);
};
}
Expand Down
8 changes: 4 additions & 4 deletions static/usage/v7/accordion/listen-changes/demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@
const accordionGroup = document.querySelector('ion-accordion-group');
const values = ['first', 'second', 'third'];

accordionGroup.addEventListener('ionChange', (ev) => {
const collapsedItems = values.filter((value) => value !== ev.detail.value);
const selectedValue = ev.detail.value;
accordionGroup.addEventListener('ionChange', (event) => {
const collapsedItems = values.filter((value) => value !== event.detail.value);
const selectedValue = event.detail.value;

console.log(
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(
', '
)}`
);
Expand Down
8 changes: 4 additions & 4 deletions static/usage/v7/accordion/listen-changes/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
const accordionGroup = document.querySelector('ion-accordion-group');
const values = ['first', 'second', 'third'];

accordionGroup.addEventListener('ionChange', (ev) => {
const collapsedItems = values.filter((value) => value !== ev.detail.value);
const selectedValue = ev.detail.value;
accordionGroup.addEventListener('ionChange', (event) => {
const collapsedItems = values.filter((value) => value !== event.detail.value);
const selectedValue = event.detail.value;

console.log(
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
);
});
</script>
Expand Down
8 changes: 4 additions & 4 deletions static/usage/v7/accordion/listen-changes/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ import React from 'react';
import { IonAccordion, IonAccordionGroup, IonItem, IonLabel, AccordionGroupCustomEvent } from '@ionic/react';
function Example() {
const values = ['first', 'second', 'third'];
const accordionGroupChange = (ev: AccordionGroupCustomEvent) => {
const collapsedItems = values.filter((value) => value !== ev.detail.value);
const selectedValue = ev.detail.value;
const accordionGroupChange = (event: AccordionGroupCustomEvent) => {
const collapsedItems = values.filter((value) => value !== event.detail.value);
const selectedValue = event.detail.value;

console.log(
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(', ')}`
);
};

Expand Down
8 changes: 4 additions & 4 deletions static/usage/v7/accordion/listen-changes/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@
},
setup() {
const values = ['first', 'second', 'third'];
const accordionGroupChange = (ev: AccordionGroupCustomEvent) => {
const collapsedItems = values.filter((value) => value !== ev.detail.value);
const selectedValue = ev.detail.value;
const accordionGroupChange = (event: AccordionGroupCustomEvent) => {
const collapsedItems = values.filter((value) => value !== event.detail.value);
const selectedValue = event.detail.value;

console.log(
`Expanded: ${selectedValue === undefined ? 'None' : ev.detail.value} | Collapsed: ${collapsedItems.join(
`Expanded: ${selectedValue === undefined ? 'None' : event.detail.value} | Collapsed: ${collapsedItems.join(
', '
)}`
);
Expand Down
2 changes: 1 addition & 1 deletion static/usage/v7/action-sheet/inline/isOpen/demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
},
];

actionSheet.addEventListener('ionActionSheetDidDismiss', (ev) => {
actionSheet.addEventListener('ionActionSheetDidDismiss', (event) => {
actionSheet.isOpen = false;
});
</script>
Expand Down
2 changes: 1 addition & 1 deletion static/usage/v7/action-sheet/inline/isOpen/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
];

actionSheet.addEventListener('ionActionSheetDidDismiss', (ev) => {
actionSheet.addEventListener('ionActionSheetDidDismiss', (event) => {
actionSheet.isOpen = false;
});
</script>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export class ExampleComponent {

constructor() {}

logResult(event: CustomEvent<OverlayEventDetail<string>>) {
logResult(event: CustomEvent<OverlayEventDetail>) {
console.log(JSON.stringify(event.detail, null, 2));
}
}
Expand Down
4 changes: 2 additions & 2 deletions static/usage/v7/action-sheet/role-info-on-dismiss/demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
},
];

actionSheet.addEventListener('ionActionSheetDidDismiss', (ev) => {
console.log(JSON.stringify(ev.detail, null, 2));
actionSheet.addEventListener('ionActionSheetDidDismiss', (event) => {
console.log(JSON.stringify(event.detail, null, 2));
});
</script>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
},
];

actionSheet.addEventListener('ionActionSheetDidDismiss', (ev) => {
console.log(JSON.stringify(ev.detail, null, 2));
actionSheet.addEventListener('ionActionSheetDidDismiss', (event) => {
console.log(JSON.stringify(event.detail, null, 2));
});
</script>
```
4 changes: 2 additions & 2 deletions static/usage/v7/action-sheet/role-info-on-dismiss/vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@
},
];

const logResult = (ev: CustomEvent) => {
console.log(JSON.stringify(ev.detail, null, 2));
const logResult = (event: CustomEvent) => {
console.log(JSON.stringify(event.detail, null, 2));
};

return {
Expand Down
Loading