Slab.Syntax

Documentation

data Block

Constructors

BlockDoctype

Only doctype html for now.

BlockElem Elem TrailingSym [Attr] [Block]

BlockText TextSyntax [Inline]

BlockInclude (Maybe Text) FilePath (Maybe [Block])

Nothing when the template is parsed, then Just nodes after preprocessing (i.e. actually running the include statement). The filter name follows the same behavior as BlockFilter.

BlockFragmentDef Text [Text] [Block]

This doesn't exist in Pug. This is like a mixin than receive block arguments. Or like a parent template that can be extended by a child template.

BlockFragmentCall Text [Expr] [Block]

BlockFor Text (Maybe Text) Expr [Block]

BlockComment CommentType Text

BlockFilter Text Text

BlockRawElem Text [Block]

BlockDefault Text [Block]

default defines an optional formal parameter with a default content. Its content is used when the argument is not given.

BlockImport FilePath (Maybe [Block]) [Block]

Similar to an anonymous fragment call, where the fragment body is the content of the referenced file.

BlockRun Text (Maybe [Block])

BlockReadJson Text FilePath (Maybe Value)

Allow to assign the content of a JSON file to a variable. The syntax is specific to how Struct has a require function in scope.

BlockAssignVar Text Expr

BlockIf Expr [Block] [Block]

BlockList [Block]

BlockCode Expr

Instances

Show Block

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

Eq Block

Defined in Slab.Syntax

Methods

(==) :: Block -> Block -> Bool

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

isDoctype :: Block -> Bool

data CommentType

A "passthrough" comment will be included in the generated HTML.

Constructors

NormalComment

PassthroughComment

Instances

Show CommentType

Defined in Slab.Syntax

Methods

showsPrec :: Int -> CommentType -> ShowS

show :: CommentType -> String

showList :: [CommentType] -> ShowS

Eq CommentType

Defined in Slab.Syntax

Methods

(==) :: CommentType -> CommentType -> Bool

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

data Elem

Constructors

Html

Body

Div

Span

Br

Hr

H1

H2

H3

H4

H5

H6

Header

Head

Meta

Main

Link

A

P

Ul

Li

Title

Table

Thead

Tbody

Tr

Td

Dl

Dt

Dd

Footer

Figure

Form

Label

Blockquote

Button

Figcaption

Audio

Script

Style

Small

Source

Pre

Code

Img

IFrame

Input

I

Svg

Textarea

Canvas

Instances

Show Elem

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Elem -> ShowS

show :: Elem -> String

showList :: [Elem] -> ShowS

Eq Elem

Defined in Slab.Syntax

Methods

(==) :: Elem -> Elem -> Bool

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

data TrailingSym

Constructors

HasDot

HasEqual

NoSym

Instances

Show TrailingSym

Defined in Slab.Syntax

Methods

showsPrec :: Int -> TrailingSym -> ShowS

show :: TrailingSym -> String

showList :: [TrailingSym] -> ShowS

Eq TrailingSym

Defined in Slab.Syntax

Methods

(==) :: TrailingSym -> TrailingSym -> Bool

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

data Attr

Constructors

Id Text

Class Text

Attr Text (Maybe Expr)

Instances

Show Attr

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Attr -> ShowS

show :: Attr -> String

showList :: [Attr] -> ShowS

Eq Attr

Defined in Slab.Syntax

Methods

(==) :: Attr -> Attr -> Bool

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

data TextSyntax

Constructors

Normal

The text follows an element on the same line.

Pipe

The text follows a pipe character. Multiple lines each introduced by a pipe symbol are grouped as a single BlockText node.

Dot

The text is part of a text block following a trailing dot.

Include

The text is the content of an include statement without a .slab extension.

RunOutput

The text is the output of command.

Instances

Show TextSyntax

Defined in Slab.Syntax

Methods

showsPrec :: Int -> TextSyntax -> ShowS

show :: TextSyntax -> String

showList :: [TextSyntax] -> ShowS

Eq TextSyntax

Defined in Slab.Syntax

Methods

(==) :: TextSyntax -> TextSyntax -> Bool

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

data Expr

Simple expression language.

Constructors

Variable Text

Int Int

SingleQuoteString Text

List [Expr]

Object [(Expr, Expr)]

Lookup Text Expr

Add Expr Expr

Sub Expr Expr

Times Expr Expr

Divide Expr Expr

Frag [Text] Env [Block]

Thunk Env Expr

Instances

Show Expr

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Expr -> ShowS

show :: Expr -> String

showList :: [Expr] -> ShowS

Eq Expr

Defined in Slab.Syntax

Methods

(==) :: Expr -> Expr -> Bool

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

data Inline

A representation of a Text template is a list of Inline, supporting efficient rendering. Use parse to create a template from a text containing placeholders. Lit is a literal Text value. Place is a placeholder created with #{...}.

Constructors

Lit !Text

Place !Expr

Instances

Show Inline

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Inline -> ShowS

show :: Inline -> String

showList :: [Inline] -> ShowS

Eq Inline

Defined in Slab.Syntax

Methods

(==) :: Inline -> Inline -> Bool

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

data Env

Constructors

Env

Fields

• envVariables :: [(Text, Expr)]

Instances

Show Env

Defined in Slab.Syntax

Methods

showsPrec :: Int -> Env -> ShowS

show :: Env -> String

showList :: [Env] -> ShowS

Eq Env

Defined in Slab.Syntax

Methods

(==) :: Env -> Env -> Bool

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

emptyEnv :: Env

trailingSym :: Block -> TrailingSym

freeVariables :: Expr -> [Text]

thunk :: Env -> Expr -> Expr

extractClasses :: [Block] -> [Text]

extractFragments :: [Block] -> [BlockFragment]

findFragment :: Text -> [BlockFragment] -> Maybe [Block]

idNamesFromAttrs :: [Attr] -> [Text]

classNamesFromAttrs :: [Attr] -> [Text]

namesFromAttrs :: [Attr] -> [(Text, Text)]

groupAttrs :: [Attr] -> [Attr]

Group multiple classes or IDs in a single class or ID, and transform the other attributes in SingleQuoteStrings.