firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: include Human Interface haptic information in HapticFeedback (#158587)

Browse Source 
## Description

Adding reference to the Human Interface documentation about Haptics in the `HapticFeedback` docs. 

The Human Haptic Guidelines documentation are excellent since they provide visualizations that show how these different haptics actually are with some interactive demos, for example with Impact haptics (see image below). Such helps developers decide what haptic to go for and understand when they should be used.

<img width="675" alt="Screenshot 2024-11-13 at 15 13 10" src="https://github.com/user-attachments/assets/909240d3-1981-4e25-9bed-b3b52154e662">
This commit is contained in:
Alejandro Santiago 2024-11-13 20:37:22 +00:00 committed by GitHub
parent cae3f9acd0
commit d7e1f03ee0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
packages/flutter/lib/src/services/haptic_feedback.dart
View File

@ -9,6 +9,10 @@ import 'system_channels.dart';
///
/// This API is intentionally terse since it calls default platform behavior. It
/// is not suitable for precise control of the system's haptic feedback module.
///
/// See also:
///
/// * [Human Interface Haptics Guidelines](https://developer.apple.com/design/human-interface-guidelines/playing-haptics)
abstract final class HapticFeedback {
/// Provides vibration haptic feedback to the user for a short duration.
///
@ -28,6 +32,12 @@ abstract final class HapticFeedback {
/// below 10.
///
/// On Android, this uses `HapticFeedbackConstants.VIRTUAL_KEY`.
///
/// {@template flutter.services.HapticFeedback.impact}
/// See also:
///
/// * [Human Interface Selection Playing Impact Haptic](https://developer.apple.com/design/human-interface-guidelines/playing-haptics#Impact)
/// {@endtemplate}
static Future<void> lightImpact() async {
await SystemChannels.platform.invokeMethod<void>(
'HapticFeedback.vibrate',
@ -42,6 +52,8 @@ abstract final class HapticFeedback {
/// below 10.
///
/// On Android, this uses `HapticFeedbackConstants.KEYBOARD_TAP`.
///
/// {@macro flutter.services.HapticFeedback.impact}
static Future<void> mediumImpact() async {
await SystemChannels.platform.invokeMethod<void>(
'HapticFeedback.vibrate',
@ -57,6 +69,8 @@ abstract final class HapticFeedback {
///
/// On Android, this uses `HapticFeedbackConstants.CONTEXT_CLICK` on API levels
/// 23 and above. This call has no effects on Android API levels below 23.
///
/// {@macro flutter.services.HapticFeedback.impact}
static Future<void> heavyImpact() async {
await SystemChannels.platform.invokeMethod<void>(
'HapticFeedback.vibrate',
@ -70,6 +84,10 @@ abstract final class HapticFeedback {
/// This call has no effects on iOS versions below 10.
///
/// On Android, this uses `HapticFeedbackConstants.CLOCK_TICK`.
///
/// See also:
///
/// * [Human Interface Selection Playing Selection Haptics](https://developer.apple.com/design/human-interface-guidelines/playing-haptics#Selection)
static Future<void> selectionClick() async {
await SystemChannels.platform.invokeMethod<void>(
'HapticFeedback.vibrate',