> For the complete documentation index, see [llms.txt](https://pwa.spomky-labs.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pwa.spomky-labs.com/1.3.x/symfony-ux/vibration.md).

# Vibration

### Overview of the Vibration API

The Vibration API is a powerful tool that allows web developers to enhance user experience on mobile devices by enabling vibration functionality. This API provides a means for web applications to programmatically trigger vibrations, thereby making web interactions more tactile and engaging.

#### Considerations

* **Device Support**: Ensure that the target mobile device supports vibration functionality, as some devices may not have this feature.
* **Battery Usage**: Frequent or lengthy vibrations may affect battery life, so it’s essential to use the Vibration API judiciously.

```html
<button
    data-controller="pwa--vibration"
    data-action="pwa--vibration#vibrate"
    data-pwa--vibration-pattern-param="[300,300,300,300,300,900,900,300,900,300,900,900,300,300,300,300,300]"
>
SOS
</button>
```

### Parameters

None

### Actions

`vibrate` : starts the vibration sequence given in the parameter `pattern`. See <https://developer.mozilla.org/en-US/docs/Web/API/Navigator/vibrate#pattern>. If the parameter `interval` (`integer`) is defined, the pattern will be repeated unless stopped or the page refreshed. The `interval` is in milliseconds).

`stop` : stop the persistent vibrations.

### Targets

None

### Events

`pwa--vibration:triggered`&#x20;

`pwa--vibration:stopped`&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://pwa.spomky-labs.com/1.3.x/symfony-ux/vibration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.