Safe Haskell	Safe
Language	Haskell2010

System.Console.Byline.Stylized

Description

The stylized type and constructors.

Synopsis

data Stylized
data Modifier
text :: Text -> Stylized
mapStylized :: ((Text, Modifier) -> a) -> Stylized -> [a]
modStylized :: Modifier -> Stylized

Documentation

data Stylized Source #

Stylized text. Construct text with modifiers using string literals and the OverloadedStrings extension and/or the text function.

Instances

IsString Stylized Source #
Instance details Defined in System.Console.Byline.Stylized Methods fromString :: String -> Stylized #
Semigroup Stylized Source #
Instance details Defined in System.Console.Byline.Stylized Methods (<>) :: Stylized -> Stylized -> Stylized # sconcat :: NonEmpty Stylized -> Stylized # stimes :: Integral b => b -> Stylized -> Stylized #
Monoid Stylized Source #
Instance details Defined in System.Console.Byline.Stylized Methods mempty :: Stylized # mappend :: Stylized -> Stylized -> Stylized # mconcat :: [Stylized] -> Stylized #

data Modifier Source #

Information about modifications made to stylized text.

Instances

Semigroup Modifier Source #
Instance details Defined in System.Console.Byline.Internal.Types Methods (<>) :: Modifier -> Modifier -> Modifier # sconcat :: NonEmpty Modifier -> Modifier # stimes :: Integral b => b -> Modifier -> Modifier #
Monoid Modifier Source #
Instance details Defined in System.Console.Byline.Internal.Types Methods mempty :: Modifier # mappend :: Modifier -> Modifier -> Modifier # mconcat :: [Modifier] -> Modifier #

text :: Text -> Stylized Source #

Helper function to create stylized text. If you enable the OverloadedStrings extension then you can create stylized text directly without using this function.

This function is also helpful for producing stylized text from an existing Text value.

mapStylized :: ((Text, Modifier) -> a) -> Stylized -> [a] Source #

Map a function over stylized text. The Modifier type is opaque so this function might not be very useful outside of the Byline internals.

modStylized :: Modifier -> Stylized Source #

Constructor to modify stylized text. This function is only useful to internal Byline functions.