-
Notifications
You must be signed in to change notification settings - Fork 146
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.
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
WIP: Add Reflex.Dom.Event to expose addEventListener options #402
Open
3noch
wants to merge
1
commit into
develop
Choose a base branch
from
eac@expose-addEventListener-options
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+110
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
{-# LANGUAGE CPP #-} | ||
{-# LANGUAGE OverloadedStrings #-} | ||
|
||
#ifdef USE_TEMPLATE_HASKELL | ||
{-# LANGUAGE TemplateHaskell #-} | ||
#endif | ||
module Reflex.Dom.Event where | ||
|
||
import Data.Aeson (toJSON) | ||
import Data.Default (Default, def) | ||
import Data.Text (Text) | ||
import GHCJS.DOM.EventM (EventM, EventName, SaferEventListener(..), newListenerAsync, newListenerSync, releaseListener, removeListener) | ||
import qualified Data.Map as Map | ||
import GHCJS.DOM.Types | ||
( AddEventListenerOptions (..), DOM, EventListener (..), IsEvent, IsEventTarget, JSM, ToJSVal | ||
, toAddEventListenerOptionsOrBool, toJSVal | ||
) | ||
import GHCJS.DOM.EventTarget (addEventListener) | ||
import GHCJS.DOM.EventTargetClosures (EventName (..), eventNameString) | ||
|
||
#ifdef USE_TEMPLATE_HASKELL | ||
import Control.Lens.TH (makeLenses) | ||
#endif | ||
|
||
-- | Options for 'addEventListener'. | ||
-- | ||
-- C.f. @options@ in https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Parameters | ||
data EventListenerOptions = EventListenerOptions | ||
{ _eventListenerOptions_capture :: !Bool | ||
, _eventListenerOptions_passive :: !Bool | ||
} deriving (Eq, Ord, Show) | ||
|
||
instance Default EventListenerOptions where | ||
def = defaultEventListenerOptions | ||
{-# INLINABLE def #-} | ||
|
||
instance ToJSVal EventListenerOptions where | ||
toJSVal opts = toJSVal $ toJSON $ Map.fromList | ||
( [ ("capture", _eventListenerOptions_capture opts) | ||
, ("passive", _eventListenerOptions_passive opts) | ||
] :: [(Text, Bool)] | ||
) | ||
{-# INLINABLE toJSVal #-} | ||
|
||
-- | Default 'EventListenerOptions' where both @capture@ and @passive@ are disabled. | ||
defaultEventListenerOptions :: EventListenerOptions | ||
defaultEventListenerOptions = EventListenerOptions False False | ||
{-# INLINABLE defaultEventListenerOptions #-} | ||
|
||
-- | Like 'GHCJS.DOM.EventM.on' but normalizes defaults to be the same across all browsers. | ||
-- | ||
-- See 'normalizedDefaultEventListenerOptions' for how normalization is done. | ||
on :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> EventM t e () -> DOM (DOM ()) | ||
on target eventName@(EventNameSyncDefault _) = onSyncWithOptions (normalizedDefaultEventListenerOptions eventName) target eventName | ||
on target eventName@(EventNameAsyncDefault _) = onAsyncWithOptions (normalizedDefaultEventListenerOptions eventName) target eventName | ||
{-# INLINABLE on #-} | ||
|
||
-- | Per-event default for 'EventListenerOptions' that is the same for all browsers. | ||
-- | ||
-- * @capture@ is always 'False'. | ||
-- | ||
-- * @passive@ is always 'False' unless the event is @touchstart@ or @touchmove@. | ||
-- See https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Browser_compatibility | ||
-- for differences. | ||
normalizedDefaultEventListenerOptions :: EventName t e -> EventListenerOptions | ||
normalizedDefaultEventListenerOptions e = case eventNameString e of | ||
name | name == "touchstart" || name == "touchmove" -> defaultEventListenerOptions { _eventListenerOptions_passive = True } | ||
_ -> defaultEventListenerOptions | ||
{-# INLINABLE normalizedDefaultEventListenerOptions #-} | ||
|
||
-- | Like 'GHCJS.DOM.EventM.on' but with @addEventListener@ options. | ||
onWithOptions :: (IsEventTarget t, IsEvent e) => EventListenerOptions -> t -> EventName t e -> EventM t e () -> DOM (DOM ()) | ||
onWithOptions opts target eventName@(EventNameSyncDefault _) = onSyncWithOptions opts target eventName | ||
onWithOptions opts target eventName@(EventNameAsyncDefault _) = onAsyncWithOptions opts target eventName | ||
{-# INLINABLE onWithOptions #-} | ||
|
||
-- | Like 'GHCJS.DOM.EventM.onSync' but with @addEventListener@ options. | ||
onSyncWithOptions :: (IsEventTarget t, IsEvent e) => EventListenerOptions -> t -> EventName t e -> EventM t e () -> DOM (DOM ()) | ||
onSyncWithOptions opts target eventName callback = do | ||
l <- newListenerSync callback | ||
addListenerWithOptions target eventName l opts | ||
return $ do | ||
removeListener target eventName l False | ||
releaseListener l | ||
{-# INLINABLE onSyncWithOptions #-} | ||
|
||
-- | Like 'GHCJS.DOM.EventM.onAsync' but with @addEventListener@ options. | ||
onAsyncWithOptions :: (IsEventTarget t, IsEvent e) => EventListenerOptions -> t -> EventName t e -> EventM t e () -> JSM (JSM ()) | ||
onAsyncWithOptions opts target eventName callback = do | ||
l <- newListenerAsync callback | ||
addListenerWithOptions target eventName l opts | ||
return $ do | ||
removeListener target eventName l False | ||
releaseListener l | ||
{-# INLINABLE onAsyncWithOptions #-} | ||
|
||
-- | Like 'GHCJS.DOM.EventM.addListener' but with @addEventListener@ options. | ||
addListenerWithOptions :: (IsEventTarget t, IsEvent e) => t -> EventName t e -> SaferEventListener t e -> EventListenerOptions -> DOM () | ||
addListenerWithOptions target eventName l opts = do | ||
raw <- EventListener <$> toJSVal l | ||
optsVal <- toAddEventListenerOptionsOrBool . AddEventListenerOptions <$> toJSVal opts | ||
addEventListener target (eventNameString eventName) (Just raw) optsVal | ||
{-# INLINABLE addListenerWithOptions #-} | ||
|
||
|
||
#ifdef USE_TEMPLATE_HASKELL | ||
makeLenses ''EventListenerOptions | ||
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Downside to this approach is that it's a perf hit to every usage of
on