mdgriffith/style-elements/3.1.0

NOTE: this package is not compatible with Elm 0.19.1

Element

Capture Layout in your View

Think of Elements as Html with layout!

By building your view with Elements, you have a single place to go to adjust or add to your layout, which is great because that's usually what you're doing in your view!

Rendering

StyleSheet style variation
-> Element style variation msg
-> Html msg

Embeds the stylesheet and renders the Element's into Html.

StyleSheet style variation
-> Element style variation msg
-> Html msg

Same as root, but the height and width of the site is set to the height and width of the screen.

Basic Elements

type alias Element style variation msg =
Element style variation msg

You can think of an Element as Html with built-in layout.

It has one style identifier, which you can think of as a CSS class.

It can also have style variations, which are covered in the Style module.

type alias Attribute variation msg =
Attribute variation msg
empty : Element style variation msg
text : String -> Element style variation msg
el :
style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg

The most basic element.

You need to specify a style, a list of attributes, and a single child.

-- an element with the style `MyStyle`, that is aligned left, and has one child.
el MyStyle [ alignLeft ] (text "Hello World!")

el can only have one child because in order to have multiple children, we need to specify how the layout would work.

html : Html msg -> Element style variation msg

For when you want to embed Html.

If you're using this library, I'd encourage you to try to solve your problem without using this escape hatch.

Usage of this function makes the most sense when you're dealing with Html from another module or package.

map :
(a -> msg)
-> Element style variation a
-> Element style variation msg

Change the msg that an Element is sending.

An analog of Html.map.

Layout

A layout element will explicitly define how it's children are layed out.

Make sure to check out the Style Element specific attributes in Element.Attributes as they will help out when doing layout!

Text Layout

style
-> List (Attribute variation msg)
-> List (Element style variation msg)
-> Element style variation msg

A text layout.

Children that are aligned left or right will be floated left or right. Everything else if arranged in the standard 'block' layout of css, meaning a column flowing down.

style
-> List (Attribute variation msg)
-> List (Element style variation msg)
-> Element style variation msg

Paragraph is actually a layout if you can believe it!

This is the same as a textLayout, except all of the children are set to display:inline.

Because all the children are inline, they will not respect and width or height set on them.

Linear Layouts

row :
style
-> List (Attribute variation msg)
-> List (Element style variation msg)
-> Element style variation msg
style
-> List (Attribute variation msg)
-> List (Element style variation msg)
-> Element style variation msg
style
-> List (Attribute variation msg)
-> List (Element style variation msg)
-> Element style variation msg
style
-> List (Attribute variation msg)
-> List (Element style variation msg)
-> Element style variation msg

Grid Layout

type alias Grid =
{ rows : List Length
, columns : List Length
}
type alias NamedGrid =
{ rows : List ( Length, List NamedGridPosition )
, columns : List Length
}
style
-> Grid
-> List (Attribute variation msg)
-> List (OnGrid (Element style variation msg))
-> Element style variation msg

An interface to css grid. Here's a basic example:

grid MyGridStyle
    { columns = [ px 100, px 100, px 100, px 100 ]
    , rows =
        [ px 100
        , px 100
        , px 100
        , px 100
        ]
    }
    []
    [ area
        { start = ( 0, 0 )
        , width = 1
        , height = 1
        }
        (el Box [] (text "box"))
    , area
        { start = ( 1, 1 )
        , width = 1
        , height = 2
        }
        (el Box [] (text "box"))
    ]
style
-> NamedGrid
-> List (Attribute variation msg)
-> List (NamedOnGrid (Element style variation msg))
-> Element style variation msg

With a named grid, you can name areas within the grid and use that name to place an element.

Here's an example:

namedGrid MyGridStyle
    { columns = [ px 200, px 200, px 200, fill 1 ]
    , rows =
        [ px 200 => [ spanAll "header" ]
        , px 200 => [ span 3 "content", span 1 "sidebar" ]
        , px 200 => [ span 3 "content", span 1 "sidebar" ]
        , px 200 => [ spanAll "footer" ]
        ]
    }
    []
    [ named "header"
        (el Box [] (text "box"))
    , named "sidebar"
        (el Box [] (text "box"))
    ]

note: this example uses rocket(=>) as a synonym for creating a tuple. For more, check out the rocket update package!

type alias OnGrid thing =
OnGrid thing
type alias NamedOnGrid thing =
NamedOnGrid thing
GridPosition
-> Element style variation msg
-> OnGrid (Element style variation msg)

Specify a specific position on a normal grid.

String
-> Element style variation msg
-> NamedOnGrid (Element style variation msg)

Specify a named postion on a namedGrid.

span : Int -> String -> NamedGridPosition

Used to define named areas in a namedGrid.

spanAll : String -> NamedGridPosition

Used to define named areas in a namedGrid.

Convenience Elements

style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg

A full element will ignore the spacing set for it by the parent, and also grow to cover the parent's padding.

This is mostly useful in text layouts.

spacer : Float -> Element style variation msg

An element for adding additional spacing. The Float is the multiple that should be used of the spacing that's being set by the parent.

So, if the parent element is a column that set spacing to 5, and this spacer was a 2. Then it would be a 10 pixel spacer.

hairline : style -> Element style variation msg

Creates a 1 px tall horizontal line.

If you want a horizontal rule that is something more specific, craft it with el!

String
-> style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg

A convenience node for images. Accepts an image src as the first argument.

Float
-> style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg

A simple circle. Provide the radius it should have.

Automatically sets the propery width, height, and corner rounded.

break : Element style variation msg

Make a line-break.

You probably want to use paragraph instead. This is only for adjusting where a sentance should break, not for formating paragraphs.

when : Bool -> Element style variation msg -> Element style variation msg

A helper function. This:

when (x == 5) (text "yay, it's 5")

is sugar for

if (x == 5) then
    text "yay, it's 5"
else
    empty

Positioning

It can be useful to position something near another element.

In CSS terms, this positions children using 'position:absolute'. So, to position three boxes below a container, we could do the following:

 el MyStyle [ width (px 200), height (px 200) ] empty
    |> below
        [ el Box [ width (px 40), height (px 40) ] empty
        -- below on the right
        , el Box [ alignRight, width (px 40), height (px 40) ] empty
        -- below and centered
        , el Box [ center, width (px 40), height (px 40) ] empty
        ]
List (Element style variation msg)
-> Element style variation msg
-> Element style variation msg
List (Element style variation msg)
-> Element style variation msg
-> Element style variation msg
List (Element style variation msg)
-> Element style variation msg
-> Element style variation msg
List (Element style variation msg)
-> Element style variation msg
-> Element style variation msg
List (Element style variation msg)
-> Element style variation msg
-> Element style variation msg
screen : Element style variation msg -> Element style variation msg

Position an element relative to the window.

Essentially the same as display: fixed

Responsive

Since this library moves all layout and positioning logic to the view instead of the stylesheet, it doesn't make a ton of sense to support media queries in the stylesheet.

Instead, responsiveness is controlled directly in the view.

Here's how it's done:

  1. Set up a subscription to Window.resizes from the Window package.
  2. Use the Element.classifyDevice function which will convert Window.width and Window.height into a Device record, which you should store in your model.
  3. Use the Device record in your view to specify how your page changes with window size.
  4. If things get crazy, use the responsive function to map one range to another.

Check out the elm.style website source for a real example.

type alias Device =
{ width : Int
, height : Int
, phone : Bool
, tablet : Bool
, desktop : Bool
, bigDesktop : Bool
, portrait : Bool
}
classifyDevice : Size -> Device

Takes in a Window.Size and returns a device profile which can be used for responsiveness.

responsive : Float -> ( Float, Float ) -> ( Float, Float ) -> Float

Define two ranges that should linearly match up with each other.

Provide a value for the first and receive the calculated value for the second.

fontsize =
    responsive device.width ( 600, 1200 ) ( 16, 20 )

When the device width is between 600 and 1200, set the font-size between 16 and 20 using a linear scale.

Text Markup

These elements are useful for quick text markup.

bold : String -> Element style variation msg
italic : String -> Element style variation msg
strike : String -> Element style variation msg
underline : String -> Element style variation msg
sub : String -> Element style variation msg
super : String -> Element style variation msg

Semantic Markup

This library made the opinionated choice to make layout a first class concern of your view function.

However it's still very useful to have semantic markup in places. The following nodes can be used to annotate your layouts.

So, if we wanted to make a standard element be rendered as a section node, we could do the following

-- Regular element
el MyStyle [] (text "Hello World!")


-- Same element annotated as a `section`
section <| el MyStyle [] (text "Hello World!")
String
-> Element style variation msg
-> Element style variation msg
button : Element style variation msg -> Element style variation msg
section : Element style variation msg -> Element style variation msg
article : Element style variation msg -> Element style variation msg
aside : Element style variation msg -> Element style variation msg
canvas : Element style variation msg -> Element style variation msg
iframe : Element style variation msg -> Element style variation msg
audio : Element style variation msg -> Element style variation msg
video : Element style variation msg -> Element style variation msg

Form Elements

Some convient elements for working with forms.

form : Element style variation msg -> Element style variation msg
Bool
-> style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg

An automatically labeled checkbox.

style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg
-> Element style variation msg

For input elements that are not automatically labeled (checkbox, radio), this will attach a label above the element.

label Label [] (text "check this out") <|
    inputText Style [] "The Value!"
style
-> List (Attribute variation msg)
-> Element style variation msg
-> Element style variation msg
-> Element style variation msg

Same as label, but places the label below the input field.

style
-> List (Attribute variation msg)
-> String
-> Element style variation msg

Text input

label LabelStyle [] (text "check this out") <|
    inputText Style [] "The Value!"
style
-> List (Attribute variation msg)
-> String
-> Element style variation msg
String
-> style
-> List (Attribute variation msg)
-> List (Option style variation msg)
-> Element style variation msg

Create a list of labeled radio button.

This implies a column layout.

radio "lunch" None []
    [ option "burrito" True (text "A Burrito!")
    , option "taco" False (text "A Taco!")
    ]
String
-> style
-> List (Attribute variation msg)
-> List (Option style variation msg)
-> Element style variation msg

A standard html dropdown set of options.

select "favorite-animal" MySelectionStyle []
    [ option "manatee" False (text "Manatees are pretty cool")
    , option "pangolin" False (text "But so are pangolins")
    , option "bee" True (text "Bees")
    ]
String
-> Bool
-> Element style variation msg
-> Option style variation msg

Create an Option. Can only be used with radio and select.

type Option style variation msg

Advanced Rendering

StyleSheet style variation
-> Element style variation msg
-> Html msg

Renders Element's into Html, but does not embed a stylesheet.

embedStylesheet : StyleSheet style variation -> Html msg

Embed a stylesheet.

Deprecated

StyleSheet style variation
-> Element style variation msg
-> Html msg

DEPRECATED, will be removed in the next major version

embed : StyleSheet style variation -> Html msg

DEPRECATED, will be removed in the next major version

StyleSheet style variation
-> Element style variation msg
-> Html msg

DEPRECATED, will be removed in the next major version