Text.Colour.Chunk

Documentation

data Chunk

Constructors

Chunk

Fields

• chunkText :: !Text
• chunkItalic :: !(Maybe Bool)
• chunkConsoleIntensity :: !(Maybe ConsoleIntensity)
• chunkUnderlining :: !(Maybe Underlining)
• chunkForeground :: !(Maybe Colour)
• chunkBackground :: !(Maybe Colour)

Instances

Eq Chunk

Defined in Text.Colour.Chunk

Methods

(==) :: Chunk -> Chunk -> Bool

(/=) :: Chunk -> Chunk -> Bool

Show Chunk

Defined in Text.Colour.Chunk

Methods

showsPrec :: Int -> Chunk -> ShowS

show :: Chunk -> String

showList :: [Chunk] -> ShowS

IsString Chunk

Defined in Text.Colour.Chunk

Methods

fromString :: String -> Chunk

Generic Chunk

Defined in Text.Colour.Chunk

Associated Types

type Rep Chunk :: Type -> Type

Methods

from :: Chunk -> Rep Chunk x

to :: Rep Chunk x -> Chunk

Validity Chunk

Defined in Text.Colour.Chunk

Methods

validate :: Chunk -> Validation

type Rep Chunk

Defined in Text.Colour.Chunk

type Rep Chunk = D1 ('MetaData "Chunk" "Text.Colour.Chunk" "safe-coloured-text-0.1.0.0-2bbz8lmpB8e7kkmuVdVjy1" 'False) (C1 ('MetaCons "Chunk" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chunkText") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "chunkItalic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "chunkConsoleIntensity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ConsoleIntensity)))) :*: (S1 ('MetaSel ('Just "chunkUnderlining") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Underlining)) :*: (S1 ('MetaSel ('Just "chunkForeground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour)) :*: S1 ('MetaSel ('Just "chunkBackground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Colour))))))

plainChunk :: TerminalCapabilities -> Chunk -> Bool

plainColour :: TerminalCapabilities -> Colour -> Bool

renderChunksBS :: Foldable f => TerminalCapabilities -> f Chunk -> ByteString

Render a chunk directly to bytestring.

renderChunks :: Foldable f => TerminalCapabilities -> f Chunk -> Builder

Render chunks to a bytestring builder

renderChunkBS :: TerminalCapabilities -> Chunk -> ByteString

Render a chunk directly to bytestring.

renderChunk :: TerminalCapabilities -> Chunk -> Builder

Render a chunk to a bytestring builder

chunkSGR :: TerminalCapabilities -> Chunk -> [SGR]

chunk :: Text -> Chunk

Turn a text into a plain chunk, without any styling

fore :: Colour -> Chunk -> Chunk

back :: Colour -> Chunk -> Chunk

bold :: Chunk -> Chunk

faint :: Chunk -> Chunk

italic :: Chunk -> Chunk

underline :: Chunk -> Chunk

doubleUnderline :: Chunk -> Chunk

data Colour

Constructors

Colour8 !ColourIntensity !TerminalColour

Colour8Bit !Word8

Colour24Bit !Word8 !Word8 !Word8

Instances

Eq Colour

Defined in Text.Colour.Chunk

Methods

(==) :: Colour -> Colour -> Bool

(/=) :: Colour -> Colour -> Bool

Show Colour

Defined in Text.Colour.Chunk

Methods

showsPrec :: Int -> Colour -> ShowS

show :: Colour -> String

showList :: [Colour] -> ShowS

Generic Colour

Defined in Text.Colour.Chunk

Associated Types

type Rep Colour :: Type -> Type

Methods

from :: Colour -> Rep Colour x

to :: Rep Colour x -> Colour

Validity Colour

Defined in Text.Colour.Chunk

Methods

validate :: Colour -> Validation

type Rep Colour

Defined in Text.Colour.Chunk

type Rep Colour = D1 ('MetaData "Colour" "Text.Colour.Chunk" "safe-coloured-text-0.1.0.0-2bbz8lmpB8e7kkmuVdVjy1" 'False) (C1 ('MetaCons "Colour8" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ColourIntensity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TerminalColour)) :+: (C1 ('MetaCons "Colour8Bit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)) :+: C1 ('MetaCons "Colour24Bit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)))))

colourSGR :: TerminalCapabilities -> ConsoleLayer -> Colour -> Maybe SGR

black :: Colour

red :: Colour

green :: Colour

yellow :: Colour

blue :: Colour

magenta :: Colour

cyan :: Colour

white :: Colour

brightBlack :: Colour

brightRed :: Colour

brightGreen :: Colour

brightYellow :: Colour

brightBlue :: Colour

brightMagenta :: Colour

brightCyan :: Colour

brightWhite :: Colour

colour256 :: Word8 -> Colour

Bulid an 8-bit RGB Colour

This will not be rendered unless With8BitColours is used.

color256 :: Word8 -> Colour

Alias for colour256, bloody americans...

colourRGB :: Word8 -> Word8 -> Word8 -> Colour

Bulid a 24-bit RGB Colour

This will not be rendered unless With24BitColours is used.

colorRGB :: Word8 -> Word8 -> Word8 -> Colour

Alias for colourRGB, bloody americans...