From the Material Design Lite documentation:
The Material Design Lite (MDL) layout component is a comprehensive approach to page layout that uses MDL development tenets, allows for efficient use of MDL components, and automatically adapts to different browsers, screen sizes, and devices.
Appropriate and accessible layout is a critical feature of all user interfaces, regardless of a site's content or function. Page design and presentation is therefore an important factor in the overall user experience. See the layout component's Material Design specifications page for details.
Use of MDL layout principles simplifies the creation of scalable pages by providing reusable components and encourages consistency across environments by establishing recognizable visual elements, adhering to logical structural grids, and maintaining appropriate spacing across multiple platforms and screen sizes. MDL layout is extremely powerful and dynamic, allowing for great consistency in outward appearance and behavior while maintaining development flexibility and ease of use.
Refer to this site for a live demo and example code.
The layout needs to be initialised with and subscribe to changes in viewport sizes. Example initialisation of containing app:
import Material.Layout as Layout
import Material
type alias Model =
{ ...
, mdl : Material.Model -- Boilerplate
}
type Msg =
...
| Mdl Material.Msg -- Boilerplate
...
App.program
{ init = ( model, Layout.sub0 Mdl )
, view = view
, subscriptions = Layout.subs Mdl model
, update = update
}
Tabs display chevrons when the viewport is too small to show all tabs
simultaneously. Unfortunately, Elm currently does not give us a way to
automatically detect the width of the tabs at app launch. If you have tabs,
to make the chevron display correctly at app lauch, you must set
model.tabScrollState.width manually in init. If you're using shorthands,
use setTabScrollState to accomplish this. Initialisation would in this case
be (assuming a tab width of 1384 pixels):
App.program
{ init =
( { model | mdl = Layout.setTabsWidth 1384 model.mdl }
, Layout.sub0 Mdl
)
, view = view
, subscriptions = .mdl >> Layout.subs Mdl
, update = update
}
Component subscription initialiser. Either this or
init must be connected for the Layout to be responsive under
viewport size changes. Example use:
Component subscriptions (type compatible with render). Either this or
subscriptions must be connected for the Layout to be responsive under
viewport size changes.
Content of the layout only (contents of main pane is set elsewhere). Every part is optional; if you supply an empty list for either, the sub-component is omitted.
The header and drawer contains the contents of the header rows and drawer,
respectively. Use row, spacer, title, nav, and link, as well as
regular Html to construct these. The tabs contains
the title of each tab.
Component render. Refer to demo/Demo.elm on github for an example use.
Excerpt:
Layout.render Mdl model.mdl
[ Layout.selectedTab model.selectedTab
, Layout.onSelectTab SelectTab
, Layout.fixedHeader
]
{ header = myHeader
, drawer = myDrawer
, tabs = (tabTitles, [])
, main = [ MyComponent.view model ]
}
Toggle drawer.
This function is for use with component typing. For plain TEA, simply issue
an update for the exposed Msg ToggleDrawer.
Layout options.
Tabs are spread out to consume available space and do not scroll horisontally.
Make tabs ripple when clicked.
Set the selected tab.
Set tabsWidth
This function is for use with shorthands. For plain TEA, simply set the
tabsWidth field in Model.
HTML id of main contents container. Useful for, e.g., scroll-to-top.
Header is "fixed": It appears even on small screens.
Drawer is "fixed": It is always open on large screens.
Header behaves as "Waterfall" header: On scroll, the top (argument True) or
the bottom (argument False) of the header disappears.
Header behaves as "Seamed" header: it does not cast shadow, is permanently affixed to the top of the screen.
Header scrolls with contents.
Header is transparent: It draws on top of the layout's background
Receieve notification when tab k is selected.
Header row.
Push subsequent elements in header row or drawer column to the right/bottom.
Title in header row or drawer.
Container for links.
Link.
href attribute for links
Main layout view.
Component messages.
Component model.
Default component model.
Component update.
Layout needs initial viewport size
Layout subscribes to changes in viewport size.
Component react function
module Material.Layout
exposing
( init
, subscriptions
, Model
, defaultModel
, Msg(ToggleDrawer)
, update
, Property
, fixedDrawer
, fixedTabs
, fixedHeader
, rippleTabs
, waterfall
, seamed
, scrolling
, selectedTab
, onSelectTab
, row
, spacer
, title
, navigation
, link
, href
, setTabsWidth
, Contents
, view
, sub0
, subs
, render
, react
, toggleDrawer
, transparentHeader
, mainId
)
{-| From the
[Material Design Lite documentation](https://www.getmdl.io/components/index.html#layout-section):
> The Material Design Lite (MDL) layout component is a comprehensive approach to
> page layout that uses MDL development tenets, allows for efficient use of MDL
> components, and automatically adapts to different browsers, screen sizes, and
> devices.
>
> Appropriate and accessible layout is a critical feature of all user interfaces,
> regardless of a site's content or function. Page design and presentation is
> therefore an important factor in the overall user experience. See the layout
> component's
> [Material Design specifications page](https://www.google.com/design/spec/layout/structure.html#structure-system-bars)
> for details.
>
> Use of MDL layout principles simplifies the creation of scalable pages by
> providing reusable components and encourages consistency across environments by
> establishing recognizable visual elements, adhering to logical structural
> grids, and maintaining appropriate spacing across multiple platforms and screen
> sizes. MDL layout is extremely powerful and dynamic, allowing for great
> consistency in outward appearance and behavior while maintaining development
> flexibility and ease of use.
Refer to [this site](https://debois.github.io/elm-mdl/#layout)
for a live demo and example code.
# Subscriptions
The layout needs to be initialised with and subscribe to changes in viewport
sizes. Example initialisation of containing app:
import Material.Layout as Layout
import Material
type alias Model =
{ ...
, mdl : Material.Model -- Boilerplate
}
type Msg =
...
| Mdl Material.Msg -- Boilerplate
...
App.program
{ init = ( model, Layout.sub0 Mdl )
, view = view
, subscriptions = Layout.subs Mdl model
, update = update
}
## Tabs width
Tabs display chevrons when the viewport is too small to show all tabs
simultaneously. Unfortunately, Elm currently does not give us a way to
automatically detect the width of the tabs at app launch. If you have tabs,
to make the chevron display correctly at app lauch, you must set
`model.tabScrollState.width` manually in `init`. If you're using shorthands,
use `setTabScrollState` to accomplish this. Initialisation would in this case
be (assuming a tab width of 1384 pixels):
App.program
{ init =
( { model | mdl = Layout.setTabsWidth 1384 model.mdl }
, Layout.sub0 Mdl
)
, view = view
, subscriptions = .mdl >> Layout.subs Mdl
, update = update
}
@docs sub0, subs
# Render
@docs Contents, render, toggleDrawer
# Options
@docs Property
## Tabs
@docs fixedTabs, rippleTabs
@docs selectedTab, setTabsWidth
@docs mainId
## Header
@docs fixedHeader, fixedDrawer
@docs waterfall, seamed, scrolling
@docs transparentHeader
## Events
@docs onSelectTab
# Sub-views
@docs row, spacer, title, navigation, link, href
# Elm architecture
@docs view, Msg, Model, defaultModel, update, init, subscriptions
# Internal use
@docs react
-}
import Dict exposing (Dict)
import Maybe exposing (andThen, map)
import Html exposing (..)
import Html.Attributes exposing (class, classList, tabindex)
import Html.Events as Events exposing (on)
import Html.Keyed as Keyed
import Platform.Cmd exposing (Cmd)
import Window
import Json.Decode as Decoder exposing (field)
import Task
import Material.Component as Component exposing (Indexed, indexed, render1, subs)
import Material.Helpers as Helpers exposing (filter, delay, pure, map1st, map2nd)
import Material.Ripple as Ripple
import Material.Icon as Icon
import Material.Options as Options exposing (Style, cs, nop, css, when, styled, id)
import Material.Options.Internal as Internal
import DOM
-- SETUP
{-| Layout needs initial viewport size
-}
init : ( Model, Cmd Msg )
init =
let
measureScreenSize =
Task.perform Resize Window.width
in
( defaultModel, measureScreenSize )
{-| Layout subscribes to changes in viewport size.
-}
subscriptions : Model -> Sub Msg
subscriptions model =
Window.resizes (.width >> Resize)
-- MODEL
type alias TabScrollState =
{ canScrollLeft : Bool
, canScrollRight : Bool
, width : Maybe Int
}
{- Elm don't give us a good way to measure the width of the tabs, so we
arbitrarily decide that they probably can't scroll. The user can adjust this
decision by supplying his own estimate of what the width of the tabsWidth might
be.
-}
defaultTabScrollState : TabScrollState
defaultTabScrollState =
{ canScrollRight = True
, canScrollLeft = False
, width = Nothing
}
setTabsWidth_ : Int -> Model -> Model
setTabsWidth_ width model =
let
x =
model.tabScrollState
in
{ model
| tabScrollState =
{ x | width = Just width }
}
{-| HTML id of main contents container. Useful for, e.g., scroll-to-top.
-}
mainId : String
mainId =
"elm-mdl-layout-main"
{-| Component model.
-}
type alias Model =
{ ripples : Dict Int Ripple.Model
, isSmallScreen : Bool
, isCompact : Bool
, isAnimating : Bool
, isScrolled : Bool
, isDrawerOpen : Bool
, tabScrollState : TabScrollState
}
{-| Default component model.
-}
defaultModel : Model
defaultModel =
{ ripples = Dict.empty
, isSmallScreen = False
, isCompact = False
, isAnimating = False
, isScrolled = False
, isDrawerOpen = False
, tabScrollState = defaultTabScrollState
}
-- ACTIONS, UPDATE
{-| Component messages.
-}
type Msg
= ToggleDrawer
| Resize Int
| ScrollTab TabScrollState
| ScrollPane Bool Float
-- True means fixedHeader
| TransitionHeader { toCompact : Bool, fixedHeader : Bool }
| TransitionEnd
| NOP
-- Subcomponents
| Ripple Int Ripple.Msg
{-| Component update.
-}
update : Msg -> Model -> ( Model, Cmd Msg )
update msg model =
update_ identity msg model
|> Maybe.withDefault ( model, Cmd.none )
{-| Component update for shorthand.
-}
update_ : (Msg -> msg) -> Msg -> Model -> Maybe ( Model, Cmd msg )
update_ f action model =
case action of
NOP ->
Nothing
Resize width ->
{- High-frequency message. To avoid stuttering during resizes, we must
return referentially the same model if we're not making any updates. (And
the user must be using Html.Lazy.)
-}
let
isSmall =
1024 >= width
tabScrollState =
model.tabScrollState.width
|> Maybe.map
(\tabsWidth ->
let
tabScrollState =
model.tabScrollState
in
{ tabScrollState
| canScrollRight = tabsWidth + (2 * 56) {- chevrons -} > width
}
)
|> Maybe.withDefault model.tabScrollState
{- We have no idea how much horisontal space tabs consume, so we have no
idea whether they scroll or not.
-}
in
if
isSmall
== model.isSmallScreen
&& tabScrollState.canScrollRight
== model.tabScrollState.canScrollRight
then
Nothing
else
Just <|
pure
{ model
| isSmallScreen = isSmall
, isDrawerOpen = not isSmall && model.isDrawerOpen
, tabScrollState = tabScrollState
}
ToggleDrawer ->
Just <| pure { model | isDrawerOpen = not model.isDrawerOpen }
Ripple tabIndex action_ ->
Dict.get tabIndex model.ripples
|> Maybe.withDefault Ripple.model
|> Ripple.update action_
|> map1st
(\ripple_ ->
{ model | ripples = Dict.insert tabIndex ripple_ model.ripples }
)
|> map2nd (Cmd.map (f << Ripple tabIndex))
|> Just
ScrollTab state ->
{- High-frequency message. To avoid stuttering during scrolling, we must
return a referentially identical model if we're making no changes.
-}
if model.tabScrollState /= state then
Just <| pure { model | tabScrollState = state }
else
Nothing
ScrollPane fixedHeader offset ->
{- High-frequency message. To avoid stuttering during scrolling, we must
return a referentially identical model if we're making no changes.
-}
let
isScrolled =
0.0 < offset
in
if isScrolled /= model.isScrolled then
update_ f
(TransitionHeader { toCompact = isScrolled, fixedHeader = fixedHeader })
{ model | isScrolled = isScrolled }
else
Nothing
TransitionHeader { toCompact, fixedHeader } ->
if not model.isAnimating then
Just
( { model
| isCompact = toCompact
, isAnimating = (not model.isSmallScreen) || fixedHeader
}
, Cmd.none
)
else
Nothing
TransitionEnd ->
pure { model | isAnimating = False } |> Just
-- PROPERTIES
type alias Config m =
{ fixedHeader : Bool
, fixedDrawer : Bool
, fixedTabs : Bool
, rippleTabs : Bool
, mode : Mode
, selectedTab : Int
, onSelectTab : Maybe (Int -> Attribute m)
, transparentHeader : Bool
, moreTabs : Bool
}
defaultConfig : Config m
defaultConfig =
{ fixedHeader = False
, fixedDrawer = False
, fixedTabs = False
, rippleTabs = True
, mode = Standard
, onSelectTab = Nothing
, selectedTab = -1
, moreTabs = False
, transparentHeader = False
}
{-| Layout options.
-}
type alias Property m =
Options.Property (Config m) m
{-| Header is "fixed": It appears even on small screens.
-}
fixedHeader : Property m
fixedHeader =
Internal.option (\config -> { config | fixedHeader = True })
{-| Drawer is "fixed": It is always open on large screens.
-}
fixedDrawer : Property m
fixedDrawer =
Internal.option (\config -> { config | fixedDrawer = True })
{-| Tabs are spread out to consume available space and do not scroll horisontally.
-}
fixedTabs : Property m
fixedTabs =
Internal.option (\config -> { config | fixedTabs = True })
{-| Make tabs ripple when clicked.
-}
rippleTabs : Property m
rippleTabs =
Internal.option (\config -> { config | rippleTabs = True })
{-| Header behaves as "Waterfall" header: On scroll, the top (argument `True`) or
the bottom (argument `False`) of the header disappears.
-}
waterfall : Bool -> Property m
waterfall =
Internal.option
<< (\b config -> { config | mode = Waterfall b })
{-| Header behaves as "Seamed" header: it does not cast shadow, is permanently
affixed to the top of the screen.
-}
seamed : Property m
seamed =
Internal.option (\config -> { config | mode = Seamed })
{-| Header is transparent: It draws on top of the layout's background
-}
transparentHeader : Property m
transparentHeader =
Internal.option (\config -> { config | transparentHeader = True })
{-| Header scrolls with contents.
-}
scrolling : Property m
scrolling =
Internal.option (\config -> { config | mode = Scrolling })
{-| Set the selected tab.
-}
selectedTab : Int -> Property m
selectedTab =
Internal.option
<< (\k config -> { config | selectedTab = k })
{-| Set this property if tabs are missing the "more tabs on the right" indicator
chevron on app launch.
(Elm core libraries currently don't give us a good way to determine this situation
automatically.)
-}
moreTabs : Property m
moreTabs =
Internal.option (\config -> { config | moreTabs = True })
{-| Receieve notification when tab `k` is selected.
-}
onSelectTab : (Int -> m) -> Property m
onSelectTab =
Internal.option << (\f config -> { config | onSelectTab = Just (f >> Events.onClick) })
-- AUXILIARY VIEWS
{-| Push subsequent elements in header row or drawer column to the right/bottom.
-}
spacer : Html m
spacer =
div [ class "mdl-layout-spacer" ] []
{-| Title in header row or drawer.
-}
title : List (Options.Style m) -> List (Html m) -> Html m
title styles =
Options.span (cs "mdl-layout__title" :: styles)
{-| Container for links.
-}
navigation : List (Options.Style m) -> List (Html m) -> Html m
navigation styles contents =
Options.styled Html.nav (cs "mdl-navigation" :: styles) contents
{-| href attribute for links
-}
href : String -> Options.Style m
href url =
Options.attribute <| Html.Attributes.href url
{-| Link.
-}
link : List (Options.Style m) -> List (Html m) -> Html m
link styles contents =
Options.styled a
(cs "mdl-navigation__link"
:: Internal.attribute (Html.Attributes.attribute "tabindex" "1")
:: styles
)
contents
{-| Header row.
-}
row : List (Options.Style m) -> List (Html m) -> Html m
row styles =
Options.div (cs "mdl-layout__header-row" :: styles)
-- MAIN VIEWS
{-| Mode for the header.
- A `Standard` header casts shadow, is permanently affixed to the top of the screen.
- A `Seamed` header does not cast shadow, is permanently affixed to the top of the
screen.
- A `Scroll`'ing header scrolls with contents.
- A `Waterfall` header drops either the top (argument True) or bottom (argument False)
header-row when content scrolls.
-}
type Mode
= Standard
| Seamed
| Scrolling
| Waterfall Bool
isWaterfall : Mode -> Bool
isWaterfall mode =
case mode of
Waterfall _ ->
True
_ ->
False
toList : Maybe a -> List a
toList x =
case x of
Nothing ->
[]
Just y ->
[ y ]
type Direction
= Left
| Right
tabsView : (Msg -> m) -> Config m -> Model -> ( List (Html m), List (Style m) ) -> Html m
tabsView lift config model ( tabs, tabStyles ) =
let
chevron direction offset =
let
dir =
case direction of
Left ->
"left"
Right ->
"right"
in
styled div
[ cs "mdl-layout__tab-bar-button"
, cs ("mdl-layout__tab-bar-" ++ dir ++ "-button")
, (cs "is-active")
|> when
((direction == Left && model.tabScrollState.canScrollLeft)
|| (direction == Right && model.tabScrollState.canScrollRight)
)
, Options.many tabStyles
]
[ Icon.view ("chevron_" ++ dir)
[ Icon.size24
, Html.Attributes.attribute
"onclick"
("document.getElementsByClassName('mdl-layout__tab-bar')[0].scrollLeft += " ++ toString offset)
|> Internal.attribute
]
]
in
Options.div
[ cs "mdl-layout__tab-bar-container" ]
[ chevron Left -100
, Options.div
[ cs "mdl-layout__tab-bar"
, css "position" "relative"
-- Workaround for debois/elm-dom#4.
, css "scroll-behavior" "smooth"
, if config.rippleTabs then
Options.many
[ cs "mdl-js-ripple-effect"
, cs "mds-js-ripple-effect--ignore-events"
]
else
nop
, if config.mode == Standard then
cs "is-casting-shadow"
else
nop
, Options.many tabStyles
, Internal.attribute <|
on "scroll"
(DOM.target
(Decoder.map3
(\scrollWidth clientWidth scrollLeft ->
{ canScrollLeft = scrollLeft > 0
, canScrollRight = scrollWidth - clientWidth > scrollLeft + 1
, width = Just scrollWidth
}
|> ScrollTab
|> lift
)
(field "scrollWidth" Decoder.float)
(field "clientWidth" Decoder.float)
(field "scrollLeft" Decoder.float)
)
)
]
(tabs
|> List.indexedMap
(\tabIndex tab ->
filter a
[ classList
[ ( "mdl-layout__tab", True )
, ( "is-active", tabIndex == config.selectedTab )
]
, config.onSelectTab
|> Maybe.map ((|>) tabIndex)
|> Maybe.withDefault Helpers.noAttr
]
[ Just tab
, if config.rippleTabs then
Dict.get tabIndex model.ripples
|> Maybe.withDefault Ripple.model
|> Ripple.view [ class "mdl-layout__tab-ripple-container" ]
|> Html.map (Ripple tabIndex >> lift)
|> Just
else
Nothing
]
)
)
, chevron Right 100
]
headerView :
(Msg -> m)
-> Config m
-> Model
-> ( Maybe (Html m), List (Html m), Maybe (Html m) )
-> Html m
headerView lift config model ( drawerButton, rows, tabs ) =
let
mode =
case config.mode of
Standard ->
nop
Scrolling ->
cs "mdl-layout__header--scroll"
Seamed ->
cs "mdl-layout__header--seamed"
Waterfall True ->
cs "mdl-layout__header--waterfall mdl-layout__header--waterfall-hide-top"
Waterfall False ->
cs "mdl-layout__header--waterfall"
in
Options.styled Html.header
[ cs "mdl-layout__header"
, when
(config.mode
== Standard
|| (isWaterfall config.mode && model.isCompact)
)
(cs "is-casting-shadow")
, when model.isAnimating (cs "is-animating")
, when model.isCompact (cs "is-compact")
, mode
, when config.transparentHeader (cs "mdl-layout__header--transparent")
, Options.onClick
(TransitionHeader { toCompact = False, fixedHeader = config.fixedHeader }
|> lift
)
, Options.on "transitionend" (Decoder.succeed <| lift TransitionEnd)
]
(List.concatMap (\x -> x)
[ toList drawerButton
, rows
, toList tabs
]
)
onKeypressFilterSpaceAndEnter : Html.Attribute x
onKeypressFilterSpaceAndEnter =
"""
(function (evt) {
if (evt && evt.type === "keydown" && (evt.keyCode === 32 || evt.keyCode === 13)) {
evt.preventDefault();
}
})(window.event);
"""
|> Html.Attributes.attribute "onkeypress"
drawerButton : (Msg -> m) -> Bool -> Html m
drawerButton lift isVisible =
div
[--onKeypressFilterSpaceAndEnter
]
[ div
[ classList
[ ( "mdl-layout__drawer-button", True )
]
, Html.Attributes.attribute
"aria-expanded"
(if isVisible then
"true"
else
"false"
)
, tabindex 1
{- No-one else is putting events on the drawerbutton, so we don't
need to go through dispatch here.
-}
, Events.onClick (lift ToggleDrawer)
, Events.onWithOptions
"keydown"
{ stopPropagation = False
, preventDefault =
False
-- True
{- Should stop propagation exclusively on ENTER, but elm
currently require me to decide on options before the keycode
value is available.
-}
}
(Decoder.map
(lift
<< \key ->
case key of
32
{- SPACE -}
->
ToggleDrawer
13
{- ENTER -}
->
ToggleDrawer
_ ->
NOP
)
Events.keyCode
)
]
[ Icon.i "menu" ]
]
obfuscator : (Msg -> m) -> Bool -> Html m
obfuscator lift isVisible =
div
[ classList
[ ( "mdl-layout__obfuscator", True )
, ( "is-visible", isVisible )
]
, Events.onClick (lift ToggleDrawer)
]
[]
drawerView : (Msg -> m) -> Bool -> List (Html m) -> Html m
drawerView lift isVisible elems =
div
[ classList
[ ( "mdl-layout__drawer", True )
, ( "is-visible", isVisible )
]
, Html.Attributes.attribute
"aria-hidden"
(if isVisible then
"false"
else
"true"
)
]
elems
{-| Content of the layout only (contents of main pane is set elsewhere). Every
part is optional; if you supply an empty list for either, the sub-component is
omitted.
The `header` and `drawer` contains the contents of the header rows and drawer,
respectively. Use `row`, `spacer`, `title`, `nav`, and `link`, as well as
regular Html to construct these. The `tabs` contains
the title of each tab.
-}
type alias Contents m =
{ header : List (Html m)
, drawer : List (Html m)
, tabs : ( List (Html m), List (Style m) )
, main : List (Html m)
}
{-| Main layout view.
-}
view : (Msg -> m) -> Model -> List (Property m) -> Contents m -> Html m
view lift model options { drawer, header, tabs, main } =
let
summary =
Internal.collect defaultConfig options
config =
summary.config
( contentDrawerButton, headerDrawerButton ) =
case ( drawer, header, config.fixedHeader ) of
( _ :: _, _ :: _, True ) ->
-- Drawer with fixedHeader: Add the button to the header
( Nothing, Just <| drawerButton lift drawerIsVisible )
( _ :: _, _, _ ) ->
-- Drawer, no or non-fixed header: Add the button before contents.
( Just <| drawerButton lift drawerIsVisible, Nothing )
_ ->
-- No drawer: no button.
( Nothing, Nothing )
hasTabs =
not (List.isEmpty (Tuple.first tabs))
hasHeader =
hasTabs || (not (List.isEmpty header))
hasDrawer =
drawer /= []
drawerIsFixed =
config.fixedDrawer && not model.isSmallScreen
drawerIsVisible =
model.isDrawerOpen && not drawerIsFixed
tabsElems =
if not hasTabs then
Nothing
else
Just (tabsView lift config model tabs)
in
div
[ classList
[ ( "mdl-layout__container", True )
, ( "has-scrolling-header", config.mode == Scrolling )
]
]
[ filter (Keyed.node "div")
([ Just <|
classList
[ ( "mdl-layout ", True )
, ( "is-upgraded", True )
, ( "is-small-screen", model.isSmallScreen )
, ( "has-drawer", hasDrawer )
, ( "has-tabs", hasTabs )
, ( "mdl-js-layout", True )
, ( "mdl-layout--fixed-drawer", config.fixedDrawer && hasDrawer )
, ( "mdl-layout--fixed-header", config.fixedHeader && hasHeader )
, ( "mdl-layout--fixed-tabs", config.fixedTabs && hasTabs )
]
{- MDL has code to close drawer on ESC, but it seems to be
non-operational. We fix it here. Elm 0.17 doesn't give us a way to
catch global keyboard events, but we can reasonably assume something inside
mdl-layout__container is focused.
-}
, if drawerIsVisible then
on "keydown"
(Decoder.map
(lift
<< \key ->
if key == 27 then
ToggleDrawer
else
NOP
)
Events.keyCode
)
|> Just
else
Nothing
]
|> List.filterMap identity
)
[ if hasHeader then
headerView lift config model ( headerDrawerButton, header, tabsElems )
|> (,) "elm-mdl-header"
|> Just
else
Nothing
, if not hasDrawer then
Nothing
else
Just ( "elm-mdl-drawer", drawerView lift drawerIsVisible drawer )
, if not hasDrawer then
Nothing
else
Just ( "elm-mdl-obfuscator", obfuscator lift drawerIsVisible )
, contentDrawerButton |> Maybe.map ((,) "elm-drawer-button")
, Options.styled main_
[ id mainId
, cs "mdl-layout__content"
, css "overflow-y" "visible" |> when (config.mode == Scrolling && config.fixedHeader)
, css "overflow-x" "visible" |> when (config.mode == Scrolling && config.fixedHeader)
, css "overflow" "visible" |> when (config.mode == Scrolling && config.fixedHeader) {- Above three lines fixes upstream bug #4180. -}
, when
(isWaterfall config.mode)
((on "scroll" >> Internal.attribute)
(Decoder.map
(ScrollPane config.fixedHeader >> lift)
(DOM.target DOM.scrollTop)
)
)
]
main
|> (,) (toString config.selectedTab)
|> Just
]
]
-- COMPONENT
type alias Store s =
{ s | layout : Model }
( get, set ) =
( .layout
, \x s -> { s | layout = x }
)
{-| Component react function
-}
react :
(Msg -> m)
-> Msg
-> Store s
-> ( Maybe (Store s), Cmd m )
react lift msg store =
case update_ lift msg (get store) of
Just ( model, cmd ) ->
( Just (set model store), cmd )
_ ->
( Nothing, Cmd.none )
{-| Component render. Refer to `demo/Demo.elm` on github for an example use.
Excerpt:
Layout.render Mdl model.mdl
[ Layout.selectedTab model.selectedTab
, Layout.onSelectTab SelectTab
, Layout.fixedHeader
]
{ header = myHeader
, drawer = myDrawer
, tabs = (tabTitles, [])
, main = [ MyComponent.view model ]
}
-}
render :
(Component.Msg button textfield menu Msg toggles tooltip tabs dispatch -> m)
-> { a | layout : Model }
-> List (Property m)
-> Contents m
-> Html m
render =
Component.render1 get view Component.LayoutMsg
{-| Component subscriptions (type compatible with render). Either this or
`subscriptions` must be connected for the Layout to be responsive under
viewport size changes.
-}
subs :
(Component.Msg button textfield menu Msg toggles tooltip tabs dispatch -> m)
-> Store s
-> Sub m
subs lift =
get >> subscriptions >> Sub.map (Component.LayoutMsg >> lift)
{-| Component subscription initialiser. Either this or
`init` must be connected for the Layout to be responsive under
viewport size changes. Example use:
-}
sub0 :
(Component.Msg button textfield menu Msg toggles tooltip tabs dispatch -> m)
-> Cmd m
sub0 lift =
Tuple.second init |> Cmd.map (Component.LayoutMsg >> lift)
{-| Toggle drawer.
This function is for use with component typing. For plain TEA, simply issue
an update for the exposed Msg `ToggleDrawer`.
-}
toggleDrawer :
(Component.Msg button textfield menu Msg toggles tooltip tabs dispatch -> m)
-> m
toggleDrawer lift =
(Component.LayoutMsg >> lift) ToggleDrawer
{-| Set tabsWidth
This function is for use with shorthands. For plain TEA, simply set the
`tabsWidth` field in Model.
-}
setTabsWidth : Int -> Store s -> Store s
setTabsWidth w container =
{ container
| layout = setTabsWidth_ w container.layout
}