Skip to content

Add documentation about pauseOnBackgroundTap feature #911

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

Open
Ortes wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add documentation about pauseOnBackgroundTap feature #911

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf15b17
Add documentation about pauseOnBackgroundTap feature
Ortes Apr 2, 2025
6a501e4
docs: add CHANGELOG entry for #911
Ortes Aug 15, 2026
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## [Unreleased]
* 📝 [#911](https://github.com/fluttercommunity/chewie/pull/911): Document the `pauseOnBackgroundTap` option in the README. Thanks [Ortes](https://github.com/Ortes).

## [1.15.0]
* 🌐 [#946](https://github.com/fluttercommunity/chewie/pull/946): Web: enter the browser's native (OS-level) fullscreen via the Fullscreen API instead of only expanding the Flutter view inside the browser window. Pressing Escape to leave browser fullscreen also exits Chewie's fullscreen. Controlled by the new `ChewieController.useNativeFullScreenOnWeb` flag (defaults to `true`; no effect on non-web platforms). Thanks [Ortes](https://github.com/Ortes).
* 🖱️ [#950](https://github.com/fluttercommunity/chewie/pull/950): Show click cursor on hover over Material controls and progress bar. Thanks [Ortes](https://github.com/Ortes).
Expand Down
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,21 @@ optionsBuilder: (context, defaultOptions) async {

Your `additionalOptions` are already included here (if you provided `additionalOptions`)!

### `pauseOnBackgroundTap` (Tap Anywhere to Pause/Play)

The `pauseOnBackgroundTap` feature allows the video to be paused or played by tapping anywhere on the video player area.
This eliminates the need for users to tap the play/pause icon in the center of the video.

This feature can be enabled by setting the `pauseOnBackgroundTap` property in the ChewieController.
When enabled, tapping anywhere on the video will toggle between play and pause states.

```dart
final chewieController = ChewieController(
videoPlayerController: videoPlayerController,
pauseOnBackgroundTap: true, // Allow tapping anywhere on the video to pause/play
);
```

### Translations

What is an option without proper translation?
Expand Down