Skip to content

docs(gesture): add playground example for basic usage #3038

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
sean-perkins merged 6 commits into from
Jul 17, 2023
Merged

docs(gesture): add playground example for basic usage #3038

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
79f5c6c
docs(gesture): add playground example for basic usage
sean-perkins Jul 12, 2023
b5c34f8
chore: use gestureName
sean-perkins Jul 13, 2023
b911d6a
chore: remove legacy basic example
sean-perkins Jul 13, 2023
caabed7
chore: remove extra whitespace
sean-perkins Jul 13, 2023
465e885
docs: add explanation for example
sean-perkins Jul 13, 2023
84765c7
chore: content updates
sean-perkins Jul 17, 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
131 changes: 0 additions & 131 deletions docs/utilities/gestures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,137 +141,6 @@ import Basic from '@site/static/usage/v7/gestures/basic/index.md';

<Basic />

````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
let p = document.querySelector('p');
const gesture = createGesture({
el: document.querySelector('.rectangle'),
onMove: (detail) => { onMove(detail); }
})

gesture.enable();

const onMove = (detail) => {
const type = detail.type;
const currentX = detail.currentX;
const deltaX = detail.deltaX;
const velocityX = detail.velocityX;

p.innerHTML = `
<div>Type: ${type}</div>
<div>Current X: ${currentX}</div>
<div>Delta X: ${deltaX}</div>
<div>Velocity X: ${velocityX}</div>
`
}
```
</TabItem>
<TabItem value="angular">

```javascript
@ViewChild('paragraph') p: ElementRef;

ngOnInit() {
const gesture = this.gestureCtrl.create({
el: this.rectangle.nativeElement,
onMove: (detail) => { this.onMove(detail); }
})

gesture.enable();
}

private onMove(detail) {
const type = detail.type;
const currentX = detail.currentX;
const deltaX = detail.deltaX;
const velocityX = detail.velocityX;

this.p.innerHTML = `
<div>Type: ${type}</div>
<div>Current X: ${currentX}</div>
<div>Delta X: ${deltaX}</div>
<div>Velocity X: ${velocityX}</div>
`
}
```
</TabItem>
<TabItem value="react">

```javascript
let p = document.querySelector('p');
const gesture = createGesture({
el: document.querySelector('.rectangle'),
onMove: (detail) => { onMove(detail); }
})

gesture.enable();

const onMove = (detail) => {
const type = detail.type;
const currentX = detail.currentX;
const deltaX = detail.deltaX;
const velocityX = detail.velocityX;

p.innerHTML = `
<div>Type: ${type}</div>
<div>Current X: ${currentX}</div>
<div>Delta X: ${deltaX}</div>
<div>Velocity X: ${velocityX}</div>
`
}
```
</TabItem>
<TabItem value="vue">

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

...

let pRef = ref();
const rectangleRef = ref();
const gesture = createGesture({
el: rectangleRef.value,
onMove: (detail) => { onMove(detail); }
})

gesture.enable();

const onMove = (detail) => {
const type = detail.type;
const currentX = detail.currentX;
const deltaX = detail.deltaX;
const velocityX = detail.velocityX;

pRef.value.innerHTML = `
<div>Type: ${type}</div>
<div>Current X: ${currentX}</div>
<div>Delta X: ${deltaX}</div>
<div>Velocity X: ${velocityX}</div>
`
}
```
</TabItem>
</Tabs>
````

In this example, our app listens for gestures on the `.rectangle` element. When a gesture movement is detected, the `onMove` function is called, and our app logs the current gesture information.

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

## Double Click Gesture

### Usage
Expand Down
2 changes: 1 addition & 1 deletion static/usage/v7/gestures/basic/demo.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
onStart,
onMove,
onEnd,
name: 'example',
gestureName: 'example',
});

gesture.enable();
Expand Down
1 change: 1 addition & 0 deletions static/usage/v7/gestures/basic/javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
onStart,
onMove,
onEnd,
gestureName: 'example',
});

gesture.enable();
Expand Down
2 changes: 1 addition & 1 deletion static/usage/v7/gestures/basic/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
onStart: () => onStart(),
onMove: (detail) => onMove(detail),
onEnd: () => onEnd(),
name: 'example',
gestureName: 'example',
});

gesture.enable();
Expand Down