SyntheticEvent

У цьому довідковому матеріалі описана обгортка SyntheticEvent, яка є частиною системи подій React. Дивіться інструкцію Обробка подій для більш детальної інформації.

Огляд

Ваші обробники подій отримують екземпляр SyntheticEvent — кроcбраузерну обгортку над нативною подією браузера. Вона має такий же інтерфейс, як і браузерна подія, включаючи методи stopPropagation() та preventDefault(). Ця обгортка допомагає спрацьовувати різним подіям однаково у всіх браузерах.

Якщо ви усвідомили, що вам з якоїсь причини потрібно отримати нативну браузерну подію, то ви просто можете використати атрибут nativeEvent. Нижче наведено перелік атрибутів об’єкта SyntheticEvent:

boolean bubbles
boolean cancelable
DOMEventTarget currentTarget
boolean defaultPrevented
number eventPhase
boolean isTrusted
DOMEvent nativeEvent
void preventDefault()
boolean isDefaultPrevented()
void stopPropagation()
boolean isPropagationStopped()
DOMEventTarget target
number timeStamp
string type

Примітка:

Починаючи з версії v0.14, повернення false з обробника подій більше не припиняє розповсюдження події. Замість цього вам потрібно самотужки викликати e.stopPropagation() або e.preventDefault().

Пул подій

Події SyntheticEvent містяться в пулі. Це означає, що об’єкт SyntheticEvent буде використаний знову, а також всі його властивості будуть очищені після спрацювання функції зворотнього виклику події. Це було зроблено з міркувань збереження продуктивності. Таким чином, ви не можете отримати доступ до події асинхронним способом.

function onClick(event) {
  console.log(event); // => очищений об'єкт.
  console.log(event.type); // => "click"
  const eventType = event.type; // => "click"

  setTimeout(function() {
    console.log(event.type); // => null
    console.log(eventType); // => "click"
  }, 0);

  // Не спрацює. this.state.clickEvent зберігає тільки пусті значення.
  this.setState({clickEvent: event});

  // Ви все ще можете експортувати властивості події.
  this.setState({eventType: event.type});
}

Примітка:

Якщо ви все-таки хочете звернутися до властивостей події асинхронно, вам необхідно зробити виклик event.persist() на події. Тоді ця подія буде вилучена з пулу, в свою чергу це дозволить вашому коду утримувати посилання на цю подію.

Підтримувані події

React нормалізує події таким чином, що вони мають одинакові властивості в усіх браузерах.

Обробники, які перелічені нижче, викликаються на фазі розповсюдження (bubbling). Для того щоб зареєструвати подію на фазі перехоплення (capture), просто додайте Capture до імені події; наприклад, замість використання onClick використовуйте onClickCapture, для того щоб опрацювати подію на стадії перехоплення.


Довідка

Події буфера обміну

Назви подій:

onCopy onCut onPaste

Властивості:

DOMDataTransfer clipboardData

Композиційні події

Назви подій:

onCompositionEnd onCompositionStart onCompositionUpdate

Властивості:

string data

Події клавіатури

Назви подій:

onKeyDown onKeyPress onKeyUp

Властивості:

boolean altKey
number charCode
boolean ctrlKey
boolean getModifierState(key)
string key
number keyCode
string locale
number location
boolean metaKey
boolean repeat
boolean shiftKey
number which

Властивість key може приймати будь-які із задокументованих у DOM Level 3 Events spec значень.


Події фокусу

Назви подій:

onFocus onBlur

Ці події працюють зі всіма React- та DOM-елементами, а не тільки з елементами форм.

Властивості:

DOMEventTarget relatedTarget

Події форм

Назви подій:

onChange onInput onInvalid onSubmit

Для більш детальної інформації про подію onChange, відвідайте Форми.


Події миші

Назви подій:

onClick onContextMenu onDoubleClick onDrag onDragEnd onDragEnter onDragExit
onDragLeave onDragOver onDragStart onDrop onMouseDown onMouseEnter onMouseLeave
onMouseMove onMouseOut onMouseOver onMouseUp

Події onMouseEnter та onMouseLeave розповсюджуються з попереднього елементу до активного, замість звичайного процесу розповсюдження події, а також не мають фази перехоплення.

Властивості:

boolean altKey
number button
number buttons
number clientX
number clientY
boolean ctrlKey
boolean getModifierState(key)
boolean metaKey
number pageX
number pageY
DOMEventTarget relatedTarget
number screenX
number screenY
boolean shiftKey

Події курсору

Назви подій:

onPointerDown onPointerMove onPointerUp onPointerCancel onGotPointerCapture
onLostPointerCapture onPointerEnter onPointerLeave onPointerOver onPointerOut

Події onPointerEnter та onPointerLeave розповсюджуються з попереднього елементу до активного, замість звичайного процесу розповсюдження події, а також не мають фази перехоплення.

Властивості:

Як вказано у W3 spec, події курсору наслідують Mouse Events з наступними властивостями:

number pointerId
number width
number height
number pressure
number tangentialPressure
number tiltX
number tiltY
number twist
string pointerType
boolean isPrimary

Примітка з приводу кросбраузерності:

Події курсору ще не підтримуються всіма браузерами (на момент написання цієї статті підтримуються браузери: Chrome, Firefox, Edge, and Internet Explorer). React свідомо не поліфілізує підтримку в інших браузерах тому що це значно би збільшило розмір react-dom.

Якщо вашому застосунку необхідно використовувати події курсору, то ми радимо встановити сторонній поліфіл.


Події вибору

Назви подій:

onSelect

Сенсорні події

Назви подій:

onTouchCancel onTouchEnd onTouchMove onTouchStart

Властивості:

boolean altKey
DOMTouchList changedTouches
boolean ctrlKey
boolean getModifierState(key)
boolean metaKey
boolean shiftKey
DOMTouchList targetTouches
DOMTouchList touches

Події інтерфейсу користувача

Назви подій:

onScroll

Властивості:

number detail
DOMAbstractView view

Події коліщатка миші

Назви подій:

onWheel

Властивості:

number deltaMode
number deltaX
number deltaY
number deltaZ

Події медіа-елементів

Назви подій:

onAbort onCanPlay onCanPlayThrough onDurationChange onEmptied onEncrypted
onEnded onError onLoadedData onLoadedMetadata onLoadStart onPause onPlay
onPlaying onProgress onRateChange onSeeked onSeeking onStalled onSuspend
onTimeUpdate onVolumeChange onWaiting

Події зображень

Назви подій:

onLoad onError

Події анімацій

Назви подій:

onAnimationStart onAnimationEnd onAnimationIteration

Властивості:

string animationName
string pseudoElement
float elapsedTime

Події переходів

Назви подій:

onTransitionEnd

Властивості:

string propertyName
string pseudoElement
float elapsedTime

Інші події

Назви подій:

onToggle