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.Lynx.Element.View.Method

Contents

Methods
Types
Smart constructors

Description

Synopsis

boundingClientRect :: MisoString -> BoundingClientRect -> (Rect -> action) -> (MisoString -> action) -> Effect parent model action
takeScreenshot :: MisoString -> TakeScreenshot -> (JSVal -> action) -> (MisoString -> action) -> Effect parent model action
requestAccessibilityFocus :: MisoString -> (JSVal -> action) -> (MisoString -> action) -> Effect parent model action
data Rect = Rect {
- x :: Double
- y :: Double
- width :: Double
- height :: Double
- top :: Double
- bottom :: Double
- right :: Double
- left :: Double
}
data BoundingClientRect = BoundingClientRect {
- androidEnableTransformProps :: Bool
- relativeTo :: Maybe JSVal
}
data TakeScreenshot = TakeScreenshot {
- format :: MisoString
- scale :: Double
}
defaultBoundingClientRect :: BoundingClientRect
defaultTakeScreenshot :: TakeScreenshot

Methods

boundingClientRect :: MisoString -> BoundingClientRect -> (Rect -> action) -> (MisoString -> action) -> Effect parent model action Source #

https://lynxjs.org/api/elements/built-in/view.html#boundingclientrect

The front end can execute boundingClientRect through the SelectorQuery API.

data Action
  = Success Rect
  | Failure MisoString
  | GetRect

update :: Action -> Effect model Action
update GetRect =
  boundingClientRect defaultBoundingClientRect "#box" Success Failure
update (Succes Rect {..}) =
  consoleLog "Successfuly got Rect"
update (Failure errorMsg) =
  consoleLog ("Failed to call getClientBoundingRect: " <> errorMsg)

takeScreenshot :: MisoString -> TakeScreenshot -> (JSVal -> action) -> (MisoString -> action) -> Effect parent model action Source #

https://lynxjs.org/api/elements/built-in/view.html#takescreenshot

The front end can execute takeScreenshot through the SelectorQuery API.

data Action
  = Success Image
  | Failure MisoString
  | GetScreenshot

update :: Action -> Effect model Action
update GetScreenshot = takeScreenshot
  defaultTakeScreenshot "#my-view" Success Failure
update (Succes image) =
  consoleLog "Successfuly got image"
  consoleLog' image
update (Failure errorMsg) =
  consoleLog ("Failed to call takeScreenshot: " <> errorMsg)

requestAccessibilityFocus :: MisoString -> (JSVal -> action) -> (MisoString -> action) -> Effect parent model action Source #

https://lynxjs.org/api/elements/built-in/view.html#requestaccessibilityfocus

The front end can execute requestAccessiblityFocus through the SelectorQuery API.

data Action
  = Success
  | Failure MisoString
  | GetFocus

update :: Action -> Effect model Action
update GetFocus = requestAccessibilityFocus "#my-view" Success Failure
update Success = consoleLog "Successfuly got focus"
update (Failure errorMsg) =
  consoleLog ("Failed to call requestAccessibilityFocus: " <> errorMsg)

Types

data Rect Source #

Result of calling getClientBoundingRect

Constructors

Rect
Fields x :: Double y :: Double width :: Double height :: Double top :: Double bottom :: Double right :: Double left :: Double

Instances

Instances details

Show Rect Source #
Instance details Defined in Miso.Lynx.Element.View.Method Methods showsPrec :: Int -> Rect -> ShowS # show :: Rect -> String # showList :: [Rect] -> ShowS #
Eq Rect Source #
Instance details Defined in Miso.Lynx.Element.View.Method Methods (==) :: Rect -> Rect -> Bool # (/=) :: Rect -> Rect -> Bool #
FromJSVal Rect Source #
Instance details Defined in Miso.Lynx.Element.View.Method Methods fromJSVal :: JSVal -> JSM (Maybe Rect) Source # fromJSValUnchecked :: JSVal -> JSM Rect Source # fromJSValListOf :: JSVal -> JSM (Maybe [Rect]) Source # fromJSValUncheckedListOf :: JSVal -> JSM [Rect] Source #

data BoundingClientRect Source #

Constructors

BoundingClientRect
Fields androidEnableTransformProps :: Bool Specifies whether to consider the transform attribute when calculating the position on Android. The default value is `False` relativeTo :: Maybe JSVal Specify the reference node, relative to LynxView by default.

Instances

Instances details

ToJSVal BoundingClientRect Source #
Instance details Defined in Miso.Lynx.Element.View.Method Methods toJSVal :: BoundingClientRect -> JSM JSVal Source # toJSValListOf :: [BoundingClientRect] -> JSM JSVal Source #

data TakeScreenshot Source #

Constructors

TakeScreenshot
Fields format :: MisoString e.g. Specify the image format, supports jpeg and png, the default is jpeg scale :: Double e.g. Specify the image quality, 0 < scale <= 1, the default is 1, the smaller the value, the blurrier and smaller the size.

Instances

Instances details

ToJSVal TakeScreenshot Source #
Instance details Defined in Miso.Lynx.Element.View.Method Methods toJSVal :: TakeScreenshot -> JSM JSVal Source # toJSValListOf :: [TakeScreenshot] -> JSM JSVal Source #

Smart constructors

defaultBoundingClientRect :: BoundingClientRect Source #

Smart constructor for constructing boundingClientRect

defaultTakeScreenshot :: TakeScreenshot Source #

Smart constructor for calling TakeScreenshot