Copyright	(C) 2016-2025 David M. Johnson
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <code@dmj.io>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Miso.Event.Types

Contents

Types

Description

Synopsis

type Events = Map MisoString Capture
type Capture = Bool
data KeyInfo = KeyInfo {
- keyCode :: !KeyCode
- shiftKey :: !Bool
- metaKey :: !Bool
- ctrlKey :: !Bool
- altKey :: !Bool
}
newtype KeyCode = KeyCode Int
newtype Checked = Checked Bool
data PointerEvent = PointerEvent {
- pointerType :: PointerType
- pointerId :: Int
- isPrimary :: Bool
- client :: (Double, Double)
- screen :: (Double, Double)
- offset :: (Double, Double)
- page :: (Double, Double)
- tilt :: (Double, Double)
- pressure :: Double
- button :: Int
}
data PointerType
data Options = Options {
- _preventDefault :: Bool
- _stopPropagation :: Bool
}
defaultOptions :: Options
preventDefault :: Options
stopPropagation :: Options
defaultEvents :: Events
keyboardEvents :: Events
mouseEvents :: Events
dragEvents :: Events
pointerEvents :: Events
mediaEvents :: Events
clipboardEvents :: Events
touchEvents :: Events

Types

type Events = Map MisoString Capture Source #

Convenience type for Events

type Capture = Bool Source #

Type synonym to express capture mode for browser / mobile events.

Used to determine if *capture* should be set when using addEventListener

https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#capture

KeyboardEvent

data KeyInfo Source #

Type useful for both KeyCode and additional key press information.

Constructors

KeyInfo
Fields keyCode :: !KeyCode shiftKey :: !Bool metaKey :: !Bool ctrlKey :: !Bool altKey :: !Bool

Instances

Instances details

Show KeyInfo Source #
Instance details Defined in Miso.Event.Types Methods showsPrec :: Int -> KeyInfo -> ShowS # show :: KeyInfo -> String # showList :: [KeyInfo] -> ShowS #
Eq KeyInfo Source #
Instance details Defined in Miso.Event.Types Methods (==) :: KeyInfo -> KeyInfo -> Bool # (/=) :: KeyInfo -> KeyInfo -> Bool #

newtype KeyCode Source #

Type used for Keyboard events.

See https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode#Browser_compatibility

Constructors

KeyCode Int

Instances

Instances details

FromJSON KeyCode Source #
Instance details Defined in Miso.Event.Types Methods parseJSON :: Value -> Parser KeyCode Source # parseJSONList :: Value -> Parser [KeyCode] Source # omittedField :: Maybe KeyCode Source #
Show KeyCode Source #
Instance details Defined in Miso.Event.Types Methods showsPrec :: Int -> KeyCode -> ShowS # show :: KeyCode -> String # showList :: [KeyCode] -> ShowS #
Eq KeyCode Source #
Instance details Defined in Miso.Event.Types Methods (==) :: KeyCode -> KeyCode -> Bool # (/=) :: KeyCode -> KeyCode -> Bool #
Ord KeyCode Source #
Instance details Defined in Miso.Event.Types Methods compare :: KeyCode -> KeyCode -> Ordering # (<) :: KeyCode -> KeyCode -> Bool # (<=) :: KeyCode -> KeyCode -> Bool # (>) :: KeyCode -> KeyCode -> Bool # (>=) :: KeyCode -> KeyCode -> Bool # max :: KeyCode -> KeyCode -> KeyCode # min :: KeyCode -> KeyCode -> KeyCode #

CheckedEvent

newtype Checked Source #

Type used for Checkbox events.

Constructors

Checked Bool

Instances

Instances details

FromJSON Checked Source #
Instance details Defined in Miso.Event.Types Methods parseJSON :: Value -> Parser Checked Source # parseJSONList :: Value -> Parser [Checked] Source # omittedField :: Maybe Checked Source #
Show Checked Source #
Instance details Defined in Miso.Event.Types Methods showsPrec :: Int -> Checked -> ShowS # show :: Checked -> String # showList :: [Checked] -> ShowS #
Eq Checked Source #
Instance details Defined in Miso.Event.Types Methods (==) :: Checked -> Checked -> Bool # (/=) :: Checked -> Checked -> Bool #
Ord Checked Source #
Instance details Defined in Miso.Event.Types Methods compare :: Checked -> Checked -> Ordering # (<) :: Checked -> Checked -> Bool # (<=) :: Checked -> Checked -> Bool # (>) :: Checked -> Checked -> Bool # (>=) :: Checked -> Checked -> Bool # max :: Checked -> Checked -> Checked # min :: Checked -> Checked -> Checked #

PointerEvent

data PointerEvent Source #

Type used for Pointer events. https://w3c.github.io/pointerevents

Constructors

PointerEvent
Fields pointerType :: PointerType pointerId :: Int isPrimary :: Bool client :: (Double, Double) clientX, clientY screen :: (Double, Double) screenX, screenY offset :: (Double, Double) offsetX, offsetY page :: (Double, Double) pageX, pageY tilt :: (Double, Double) tiltX, tiltY pressure :: Double button :: Int https://w3c.github.io/pointerevents/#the-button-property

Instances

Instances details

Show PointerEvent Source #
Instance details Defined in Miso.Event.Types Methods showsPrec :: Int -> PointerEvent -> ShowS # show :: PointerEvent -> String # showList :: [PointerEvent] -> ShowS #
Eq PointerEvent Source #
Instance details Defined in Miso.Event.Types Methods (==) :: PointerEvent -> PointerEvent -> Bool # (/=) :: PointerEvent -> PointerEvent -> Bool #

data PointerType Source #

Pointer type https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/pointerType

Constructors

MousePointerType
PenPointerType
TouchPointerType
UnknownPointerType MisoString

Instances

Instances details

FromJSON PointerType Source #
Instance details Defined in Miso.Event.Types Methods parseJSON :: Value -> Parser PointerType Source # parseJSONList :: Value -> Parser [PointerType] Source # omittedField :: Maybe PointerType Source #
Show PointerType Source #
Instance details Defined in Miso.Event.Types Methods showsPrec :: Int -> PointerType -> ShowS # show :: PointerType -> String # showList :: [PointerType] -> ShowS #
Eq PointerType Source #
Instance details Defined in Miso.Event.Types Methods (==) :: PointerType -> PointerType -> Bool # (/=) :: PointerType -> PointerType -> Bool #

Options

data Options Source #

Options for handling event propagation.

Constructors

Options
Fields _preventDefault :: Bool _stopPropagation :: Bool

Instances

Instances details

Monoid Options Source #
Instance details Defined in Miso.Event.Types Methods mempty :: Options # mappend :: Options -> Options -> Options # mconcat :: [Options] -> Options #
Semigroup Options Source #
Instance details Defined in Miso.Event.Types Methods (<>) :: Options -> Options -> Options # sconcat :: NonEmpty Options -> Options # stimes :: Integral b => b -> Options -> Options #
Show Options Source #
Instance details Defined in Miso.Event.Types Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #
Eq Options Source #
Instance details Defined in Miso.Event.Types Methods (==) :: Options -> Options -> Bool # (/=) :: Options -> Options -> Bool #
ToJSVal Options Source #
Instance details Defined in Miso.Event.Types Methods toJSVal :: Options -> JSM JSVal Source # toJSValListOf :: [Options] -> JSM JSVal Source #

defaultOptions :: Options Source #

Default value for Options.

defaultOptions = Options { preventDefault = False, stopPropagation = False }

preventDefault :: Options Source #

Smart constructor for specifying preventDefault

Since: 1.9.0.0

stopPropagation :: Options Source #

Smart constructor for specifying stopPropagation

Since: 1.9.0.0

Events

defaultEvents :: Events Source #

Default delegated events

keyboardEvents :: Events Source #

Keyboard events

mouseEvents :: Events Source #

Mouse events

dragEvents :: Events Source #

Drag events

pointerEvents :: Events Source #

Pointer events

mediaEvents :: Events Source #

Audio video events For use with the <audio> and <video> tags.

clipboardEvents :: Events Source #

Clipboard events

touchEvents :: Events Source #

Touch events