Skip to content

docs(animation): add playground example for double-click gesture #3042

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jul 14, 2023
Merged

docs(animation): add playground example for double-click gesture #3042

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f9036d6
Generate playground
mapsandapps Jul 13, 2023
8911ba9
Import playground
mapsandapps Jul 13, 2023
9d5fcc0
Build out playground
mapsandapps Jul 14, 2023
b899fe5
Remove codepen
mapsandapps Jul 14, 2023
c834c3f
Apply suggestions from code review
mapsandapps Jul 14, 2023
e4d352d
Address PR feedback
mapsandapps Jul 14, 2023
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
170 changes: 2 additions & 168 deletions docs/utilities/gestures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,178 +272,12 @@ In this example, our app listens for gestures on the `.rectangle` element. When

## Double Click Gesture

### Usage
import DoubleClick from '@site/static/usage/v7/gestures/double-click/index.md';

````mdx-code-block
<Tabs
groupId="framework"
defaultValue="javascript"
values={[
{ value: 'javascript', label: 'JavaScript' },
{ value: 'angular', label: 'Angular' },
{ value: 'react', label: 'React' },
{ value: 'vue', label: 'Vue' },
]
}>
<TabItem value="javascript">

```javascript
const backgrounds = ['rgba(0, 0, 255, 0.5)', 'rgba(0, 255, 0.5)', 'rgba(255, 0, 0, 0.5)', 'rgba(255, 255, 0, 0.5)', 'rgba(255, 0, 255, 0.5)', 'rgba(0, 255, 255, 0.5)'];
const DOUBLE_CLICK_THRESHOLD = 500;
const rectangle = document.querySelector('.rectangle');
const gesture = createGesture({
el: rectangle,
threshold: 0,
onStart: () => { onStart(); }
});

gesture.enable();

let lastOnStart = 0;
let currentColor = 'rgba(0, 0, 255, 0.5)';

const onStart = () => {
const now = Date.now();

if (Math.abs(now - lastOnStart) <= DOUBLE_CLICK_THRESHOLD) {
rectangle.style.setProperty('background', getRandomBackground());
lastOnStart = 0;
} else {
lastOnStart = now;
}
}

const getRandomBackground = () => {
const options = backgrounds.filter(bg => bg !== currentColor);
currentColor = options[Math.floor(Math.random() * options.length)];

return currentColor;
}
```
</TabItem>
<TabItem value="angular">

```tsx
@ViewChild('rectangle') rectangle: ElementRef;

private backgrounds: string[] = ['rgba(0, 0, 255, 0.5)', 'rgba(0, 255, 0.5)', 'rgba(255, 0, 0, 0.5)', 'rgba(255, 255, 0, 0.5)', 'rgba(255, 0, 255, 0.5)', 'rgba(0, 255, 255, 0.5)'];
private currentColor: string = 'rgba(0, 0, 255, 0.5)';
private lastOnStart: number = 0;
private DOUBLE_CLICK_THRESHOLD: number = 500;

ngOnInit() {
const gesture = this.gestureCtrl.create({
el: this.rectangle.nativeElement,
threshold: 0,
onStart: () => { this.onStart(); }
});

gesture.enable();
}

private onStart() {
const now = Date.now();

if (Math.abs(now - this.lastOnStart) <= this.DOUBLE_CLICK_THRESHOLD) {
this.rectangle.nativeElement.style.setProperty('background', this.getRandomBackground());
this.lastOnStart = 0;
} else {
this.lastOnStart = now;
}
}

private getRandomBackground() {
const options = this.backgrounds.filter(bg => bg !== this.currentColor);
this.currentColor = options[Math.floor(Math.random() * options.length)];

return this.currentColor;
}
```
</TabItem>
<TabItem value="react">

```javascript
const backgrounds = ['rgba(0, 0, 255, 0.5)', 'rgba(0, 255, 0.5)', 'rgba(255, 0, 0, 0.5)', 'rgba(255, 255, 0, 0.5)', 'rgba(255, 0, 255, 0.5)', 'rgba(0, 255, 255, 0.5)'];
const DOUBLE_CLICK_THRESHOLD = 500;
const rectangle = document.querySelector('.rectangle');
const gesture = createGesture({
el: rectangle,
threshold: 0,
onStart: () => { onStart(); }
});

gesture.enable();

let lastOnStart = 0;
let currentColor = 'rgba(0, 0, 255, 0.5)';

const onStart = () => {
const now = Date.now();

if (Math.abs(now - lastOnStart) <= DOUBLE_CLICK_THRESHOLD) {
rectangle.style.setProperty('background', getRandomBackground());
lastOnStart = 0;
} else {
lastOnStart = now;
}
}

const getRandomBackground = () => {
const options = backgrounds.filter(bg => bg !== currentColor);
currentColor = options[Math.floor(Math.random() * options.length)];

return currentColor;
}
```
</TabItem>
<TabItem value="vue">

```javascript
import { createGesture } from '@ionic/vue';
import { ref } from 'vue';

...

const backgrounds = ['rgba(0, 0, 255, 0.5)', 'rgba(0, 255, 0.5)', 'rgba(255, 0, 0, 0.5)', 'rgba(255, 255, 0, 0.5)', 'rgba(255, 0, 255, 0.5)', 'rgba(0, 255, 255, 0.5)'];
const DOUBLE_CLICK_THRESHOLD = 500;
const rectangleRef = ref();
const gesture = createGesture({
el: rectangleRef.value,
threshold: 0,
onStart: () => { onStart(); }
});

gesture.enable();

let lastOnStart = 0;
let currentColor = 'rgba(0, 0, 255, 0.5)';

const onStart = () => {
const now = Date.now();

if (Math.abs(now - lastOnStart) <= DOUBLE_CLICK_THRESHOLD) {
rectangleRef.value.style.setProperty('background', getRandomBackground());
lastOnStart = 0;
} else {
lastOnStart = now;
}
}

const getRandomBackground = () => {
const options = backgrounds.filter(bg => bg !== currentColor);
currentColor = options[Math.floor(Math.random() * options.length)];

return currentColor;
}
```
</TabItem>
</Tabs>
````
<DoubleClick />

In the example above, we want to be able to detect double clicks on an element. By setting our `threshold` to `0`, we can ensure our gesture object can detect clicks. Additionally, we define a click threshold so that only 2 clicks that occur in quick succession count as a double click.

<Codepen user="ionic" slug="oNvVEwE" />

## Gesture Animations

See our guide on implementing gesture animations: [Gesture Animations with Ionic Animations](animations.md#gesture-animations)
Expand Down
3 changes: 2 additions & 1 deletion static/code/stackblitz/v7/html/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { defineCustomElements } from '@ionic/core/loader';

import { createAnimation, loadingController, modalController, pickerController, toastController } from '@ionic/core';
import { createAnimation, createGesture, loadingController, modalController, pickerController, toastController } from '@ionic/core';

/* Core CSS required for Ionic components to work properly */
import '@ionic/core/css/core.css';
Expand Down Expand Up @@ -28,3 +28,4 @@ defineCustomElements();
(window as any).pickerController = pickerController;
(window as any).toastController = toastController;
(window as any).createAnimation = createAnimation;
(window as any).createGesture = createGesture;
6 changes: 6 additions & 0 deletions static/usage/v7/gestures/double-click/angular/example_component_css.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
```css
ion-card {
transform: translateX(0);
user-select: none;
}
```
5 changes: 5 additions & 0 deletions static/usage/v7/gestures/double-click/angular/example_component_html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```html
<ion-card #card>
<ion-card-content>Double click me to move the card.</ion-card-content>
</ion-card>
```
53 changes: 53 additions & 0 deletions static/usage/v7/gestures/double-click/angular/example_component_ts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
```ts
import { Component, ElementRef, ViewChild } from '@angular/core';
import { GestureController, IonCard } from '@ionic/angular';

@Component({
selector: 'app-example',
templateUrl: 'example.component.html',
styleUrls: ['./example.component.css'],
})
export class ExampleComponent {
@ViewChild('card', { read: ElementRef }) card: ElementRef<HTMLIonCardElement>;

private currentOffset: number = 0;
private lastOnStart: number = 0;
private DOUBLE_CLICK_THRESHOLD: number = 500;

constructor(private el: ElementRef, private gestureCtrl: GestureController) {}

ngAfterViewInit() {
const gesture = this.gestureCtrl.create({
el: this.card.nativeElement,
threshold: 0,
onStart: () => {
this.onStart();
},
gestureName: 'double-click',
});

gesture.enable();
}

private onStart() {
const now = Date.now();

if (Math.abs(now - this.lastOnStart) <= this.DOUBLE_CLICK_THRESHOLD) {
this.card.nativeElement.style.setProperty('transform', this.getNewTransform());
this.lastOnStart = 0;
} else {
this.lastOnStart = now;
}
}

private getNewTransform() {
if (this.currentOffset >= 100) {
this.currentOffset = 0;
} else {
this.currentOffset += 20;
}

return `translateX(${this.currentOffset}px)`;
}
}
```
70 changes: 70 additions & 0 deletions static/usage/v7/gestures/double-click/demo.html
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, why was the example changed from using colors to movements?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original PR had both a background (like the pre-PR code) and a transform (unlike the pre-PR code). The author mentioned accessibility concerns, and I agreed. Especially since I wanted the card to have instructions in it, it's now hard to get the text contrast sufficient with different background colors in both light & dark modes, on top of the different background colors potentially being difficult to distinguish from each other. Also, I thought the code was a bit simpler to read having it just increment by n pixels every time instead of having an array of colors to rotate through. I'd be totally fine with changing to something other than translateX, but I don't think background color was working well.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completely agree, thank you for making this change!! I have no issues with translateX, it's easy to see the gesture and straight forward code.

Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Double-Click Gestures</title>
<link rel="stylesheet" href="../../../common.css" />
<script src="../../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@7/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@7/css/ionic.bundle.css" />

<script type="module">
import { createGesture } from 'https://cdn.jsdelivr.net/npm/@ionic/core@7/dist/ionic/index.esm.js';
window.createGesture = createGesture;

const DOUBLE_CLICK_THRESHOLD = 500;
const card = document.querySelector('ion-card');
const gesture = createGesture({
el: card,
threshold: 0,
onStart: () => {
onStart();
},
gestureName: 'double-click',
});

gesture.enable();

let lastOnStart = 0;
// TODO: change to not random in angular & javascript
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the TODO

let currentOffset = 0;

const onStart = () => {
const now = Date.now();

if (Math.abs(now - lastOnStart) <= DOUBLE_CLICK_THRESHOLD) {
card.style.setProperty('transform', getNewTransform());
lastOnStart = 0;
} else {
lastOnStart = now;
}
};

const getNewTransform = () => {
if (currentOffset >= 100) {
currentOffset = 0;
} else {
currentOffset += 20;
}

return `translateX(${currentOffset}px)`;
};
</script>

<style>
ion-card {
transform: translateX(0);
user-select: none;
}
</style>
</head>

<body>
<ion-content>
<ion-card>
<ion-card-content>Double click me to move the card.</ion-card-content>
</ion-card>
</ion-content>
</body>
</html>
34 changes: 34 additions & 0 deletions static/usage/v7/gestures/double-click/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import Playground from '@site/src/components/global/Playground';

import javascript from './javascript.md';

import react_main_tsx from './react/main_tsx.md';
import react_main_css from './react/main_css.md';

import vue from './vue.md';

import angular_example_component_html from './angular/example_component_html.md';
import angular_example_component_ts from './angular/example_component_ts.md';
import angular_example_component_css from './angular/example_component_css.md';

<Playground
version="7"
code={{
javascript,
react: {
files: {
'src/main.tsx': react_main_tsx,
'src/main.css': react_main_css,
},
},
vue,
angular: {
files: {
'src/app/example.component.html': angular_example_component_html,
'src/app/example.component.ts': angular_example_component_ts,
'src/app/example.component.css': angular_example_component_css,
},
},
}}
src="usage/v7/gestures/double-click/demo.html"
/>
Loading