Safe Haskell	Safe-Inferred
Language	GHC2021

Butler.Display.GUI

Contents

triggers
helpers
Widget
CSS class
Re-exports

Description

GUI toolkit

Synopsis

newtype WinID = WinID Int
data GuiEvent = GuiEvent {
- client :: DisplayClient
- trigger :: TriggerName
- body :: Value
}
newtype TriggerName = TriggerName Text
data HtmxEvent = HtmxEvent {
- trigger :: Text
- body :: Value
}
decodeTriggerName :: Text -> Maybe (WinID, TriggerName)
renderOnChange :: MonadIO m => HtmlT STM () -> (HtmlT STM () -> m ()) -> m Void
wid_ :: WinID -> Text -> _
withTrigger :: With a => Text -> WinID -> TriggerName -> [Pair] -> a -> [Attribute] -> a
withTrigger_ :: With a => Text -> WinID -> TriggerName -> a -> [Attribute] -> a
withoutWID :: TriggerName -> TriggerName
withWID :: WinID -> Text -> Text
with' :: With a => a -> Text -> a
hyper_ :: Text -> Attribute
wsSend :: Attribute
encodeVal :: [Pair] -> Attribute
topRightMenu :: Monad m => [HtmlT m ()] -> HtmlT m ()
hideScript :: Text -> Text
showScript :: Text -> Text
websocketHtml :: Text -> SessionID -> Html ()
splashHtml :: Monad m => HtmlT m () -> HtmlT m ()
loginForm :: Text -> Text -> [Pair] -> Html ()
renderToggle :: Text -> [Attribute] -> Bool -> Text -> Text -> HtmlT STM ()
inputClass :: Text
btnGreenClass :: Text
btnRedClass :: Text
btnBlueClass :: Text
makeAttribute :: Text -> Text -> Attribute

Documentation

newtype WinID #

Constructors

WinID Int

Instances

Instances details

FromJSON WinID #
Instance details Defined in Butler.Display.GUI Methods parseJSON :: Value -> Parser WinID # parseJSONList :: Value -> Parser [WinID] #
ToJSON WinID #
Instance details Defined in Butler.Display.GUI Methods toJSON :: WinID -> Value # toEncoding :: WinID -> Encoding # toJSONList :: [WinID] -> Value # toEncodingList :: [WinID] -> Encoding #
Show WinID #
Instance details Defined in Butler.Display.GUI Methods showsPrec :: Int -> WinID -> ShowS # show :: WinID -> String # showList :: [WinID] -> ShowS #
Eq WinID #
Instance details Defined in Butler.Display.GUI Methods (==) :: WinID -> WinID -> Bool # (/=) :: WinID -> WinID -> Bool #
Ord WinID #
Instance details Defined in Butler.Display.GUI Methods compare :: WinID -> WinID -> Ordering # (<) :: WinID -> WinID -> Bool # (<=) :: WinID -> WinID -> Bool # (>) :: WinID -> WinID -> Bool # (>=) :: WinID -> WinID -> Bool # max :: WinID -> WinID -> WinID # min :: WinID -> WinID -> WinID #
Serialise WinID #
Instance details Defined in Butler.Display.GUI Methods encode :: WinID -> Encoding # decode :: Decoder s WinID # encodeList :: [WinID] -> Encoding # decodeList :: Decoder s [WinID] #
From WinID SoundChannelID #
Instance details Defined in Butler.Service.SoundBlaster Methods from :: WinID -> SoundChannelID #
From WinID Natural #
Instance details Defined in Butler.Display.GUI Methods from :: WinID -> Natural #
From SoundChannelID WinID #
Instance details Defined in Butler.Service.SoundBlaster Methods from :: SoundChannelID -> WinID #

data GuiEvent #

Constructors

GuiEvent
Fields client :: DisplayClient trigger :: TriggerName body :: Value

Instances

Instances details

ToJSON GuiEvent #
Instance details Defined in Butler.Display.GUI Methods toJSON :: GuiEvent -> Value # toEncoding :: GuiEvent -> Encoding # toJSONList :: [GuiEvent] -> Value # toEncodingList :: [GuiEvent] -> Encoding #

newtype TriggerName #

Constructors

TriggerName Text

Instances

Instances details

ToJSON TriggerName #
Instance details Defined in Butler.Display.GUI Methods toJSON :: TriggerName -> Value # toEncoding :: TriggerName -> Encoding # toJSONList :: [TriggerName] -> Value # toEncodingList :: [TriggerName] -> Encoding #
IsString TriggerName #
Instance details Defined in Butler.Display.GUI Methods fromString :: String -> TriggerName #
Semigroup TriggerName #
Instance details Defined in Butler.Display.GUI Methods (<>) :: TriggerName -> TriggerName -> TriggerName # sconcat :: NonEmpty TriggerName -> TriggerName # stimes :: Integral b => b -> TriggerName -> TriggerName #
Show TriggerName #
Instance details Defined in Butler.Display.GUI Methods showsPrec :: Int -> TriggerName -> ShowS # show :: TriggerName -> String # showList :: [TriggerName] -> ShowS #
Eq TriggerName #
Instance details Defined in Butler.Display.GUI Methods (==) :: TriggerName -> TriggerName -> Bool # (/=) :: TriggerName -> TriggerName -> Bool #
Ord TriggerName #
Instance details Defined in Butler.Display.GUI Methods compare :: TriggerName -> TriggerName -> Ordering # (<) :: TriggerName -> TriggerName -> Bool # (<=) :: TriggerName -> TriggerName -> Bool # (>) :: TriggerName -> TriggerName -> Bool # (>=) :: TriggerName -> TriggerName -> Bool # max :: TriggerName -> TriggerName -> TriggerName # min :: TriggerName -> TriggerName -> TriggerName #
From Natural TriggerName #
Instance details Defined in Butler.Display.GUI Methods from :: Natural -> TriggerName #

data HtmxEvent #

Constructors

HtmxEvent
Fields trigger :: Text body :: Value

Instances

Instances details

FromJSON HtmxEvent #
Instance details Defined in Butler.Display.GUI Methods parseJSON :: Value -> Parser HtmxEvent # parseJSONList :: Value -> Parser [HtmxEvent] #

decodeTriggerName :: Text -> Maybe (WinID, TriggerName) #

Remove winID from trigger name

>>> decodeTriggerName "toggle"
Nothing
>>> decodeTriggerName "toggle-1"
Just (1,"toggle")

renderOnChange :: MonadIO m => HtmlT STM () -> (HtmlT STM () -> m ()) -> m Void #

Callback when the html change, e.g. on TVar update.

triggers

wid_ :: WinID -> Text -> _ #

withTrigger :: With a => Text -> WinID -> TriggerName -> [Pair] -> a -> [Attribute] -> a #

withTrigger_ :: With a => Text -> WinID -> TriggerName -> a -> [Attribute] -> a #

withoutWID :: TriggerName -> TriggerName #

withWID :: WinID -> Text -> Text #

helpers

with' :: With a => a -> Text -> a #

hyper_ :: Text -> Attribute #

wsSend :: Attribute #

encodeVal :: [Pair] -> Attribute #

topRightMenu :: Monad m => [HtmlT m ()] -> HtmlT m () #

hideScript :: Text -> Text #

showScript :: Text -> Text #

websocketHtml :: Text -> SessionID -> Html () #

Create the htmx websocket root element

splashHtml :: Monad m => HtmlT m () -> HtmlT m () #

Display the content in a splash screen

loginForm :: Text -> Text -> [Pair] -> Html () #

Widget

renderToggle :: Text -> [Attribute] -> Bool -> Text -> Text -> HtmlT STM () #

CSS class

inputClass :: Text #

btnGreenClass :: Text #

btnRedClass :: Text #

btnBlueClass :: Text #

Re-exports

makeAttribute #

Arguments

:: Text	Attribute name.
-> Text	Attribute value.
-> Attribute

Make an attribute builder.