onRelease

Wraps a handler so it fires only on key-up (release)

import { onRelease } from "@roku-sdk/navigation";
onRelease(handler: () => KeyResult): KeyPressHandler

Description

Wraps a handler so it fires only on key-up (release). Mirrors onPress: the handler's verdict is passed through on the release, and the press consumes.

Parameters

NameTypeDescription
handler() => KeyResultCalled on key-up. Return bubble to decline the release.

Return values

Returns KeyPressHandler.

Example

onKey: { play: onRelease(() => stop()) }
// equivalent to: play: press => { if (!press) stop(); }

What’s Next

Did this page help you?