Copyright	(C) 2016-2025 David M. Johnson
License	BSD3-style (see the file LICENSE)
Maintainer	David M. Johnson <[email protected]>
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Miso.Event.Types

Description

Synopsis

data KeyInfo = KeyInfo {
- keyCode :: !KeyCode
- shiftKey :: !Bool
- metaKey :: !Bool
- ctrlKey :: !Bool
- altKey :: !Bool
}
newtype KeyCode = KeyCode Int
newtype Checked = Checked Bool
data Options = Options {
- preventDefault :: Bool
- stopPropagation :: Bool
}
defaultOptions :: Options
newtype AllowDrop = AllowDrop Bool
defaultEvents :: Map MisoString Bool

Documentation

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 # parseJSONList :: Value -> Parser [KeyCode] # omittedField :: Maybe KeyCode #
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 #

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 # parseJSONList :: Value -> Parser [Checked] # omittedField :: Maybe Checked #
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 #

data Options Source #

Options for handling event propagation.

Constructors

Options
Fields preventDefault :: Bool stopPropagation :: Bool

Instances

Instances details

Generic Options Source #

Instance details

Defined in Miso.Event.Types

Associated Types

type Rep Options

Instance details

Defined in Miso.Event.Types

type Rep Options = D1 ('MetaData "Options" "Miso.Event.Types" "miso-1.8.7.0-ApFf5miZaZXFH70WSWqfvg" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) (S1 ('MetaSel ('Just "preventDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "stopPropagation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

Methods

from :: Options -> Rep Options x #

to :: Rep Options x -> 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 #

toJSValListOf :: [Options] -> JSM JSVal #

type Rep Options Source #

Instance details

Defined in Miso.Event.Types

type Rep Options = D1 ('MetaData "Options" "Miso.Event.Types" "miso-1.8.7.0-ApFf5miZaZXFH70WSWqfvg" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) (S1 ('MetaSel ('Just "preventDefault") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "stopPropagation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

defaultOptions :: Options Source #

Default value for Options.

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

newtype AllowDrop Source #

Related to using drop-related events

Constructors

AllowDrop Bool

Instances

Instances details

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

defaultEvents :: Map MisoString Bool Source #

Default delegated events