noredink-ui/styleguide-app/Examples/Modal.elm
2022-02-10 10:12:40 -05:00

381 lines
12 KiB
Elm

module Examples.Modal exposing (Msg, State, example)
{-|
@docs Msg, State, example
-}
import Accessibility.Styled as Html exposing (Html, div, h3, h4, p, span, text)
import Accessibility.Styled.Key as Key
import Browser.Dom as Dom
import Category exposing (Category(..))
import Css exposing (..)
import Debug.Control as Control exposing (Control)
import Debug.Control.Extra as ControlExtra
import Example exposing (Example)
import Html.Styled.Attributes as Attributes exposing (css)
import KeyboardSupport exposing (Direction(..), Key(..))
import Nri.Ui.Button.V10 as Button
import Nri.Ui.Checkbox.V5 as Checkbox
import Nri.Ui.ClickableSvg.V2 as ClickableSvg
import Nri.Ui.ClickableText.V3 as ClickableText
import Nri.Ui.Colors.Extra
import Nri.Ui.Colors.V1 as Colors
import Nri.Ui.FocusTrap.V1 as FocusTrap
import Nri.Ui.Fonts.V1 as Fonts
import Nri.Ui.Modal.V11 as Modal
import Nri.Ui.Text.V6 as Text
import Nri.Ui.UiIcon.V1 as UiIcon
import Task
{-| -}
type alias State =
{ state : Modal.Model
, attributes : Control (List Modal.Attribute)
, settings : Control ViewSettings
}
{-| -}
init : State
init =
{ state = Modal.init
, attributes = controlAttributes
, settings = initViewSettings
}
controlAttributes : Control (List Modal.Attribute)
controlAttributes =
ControlExtra.list
|> ControlExtra.listItem "Theme" controlTheme
|> ControlExtra.listItem "Title visibility" controlTitleVisibility
|> ControlExtra.listItem "Custom css" controlCss
type alias ViewSettings =
{ title : String
, showX : Bool
, showContinue : Bool
, showSecondary : Bool
, dismissOnEscAndOverlayClick : Bool
, content : String
}
initViewSettings : Control ViewSettings
initViewSettings =
Control.record ViewSettings
|> Control.field "Modal title" (Control.string "Modal Title")
|> Control.field "X button" (Control.bool True)
|> Control.field "Continue button" (Control.bool True)
|> Control.field "Close button" (Control.bool True)
|> Control.field "dismissOnEscAndOverlayClick" (Control.bool True)
|> Control.field "Content"
(Control.stringTextarea <|
String.join "\n\n"
[ "Generally, you'll want to pair the Modal.warning theme with the Button.danger theme and the Modal.info theme with the Button.primary theme."
, "Muffin liquorice powder liquorice jujubes biscuit cookie candy canes lemon drops. Liquorice powder carrot cake dragée icing tootsie roll apple pie lemon drops lemon drops. Jujubes danish bear claw cotton candy. Dragée apple pie tiramisu. Sugar plum dessert pastry marzipan chocolate cake dragée sesame snaps. Marshmallow gingerbread lemon drops. Brownie chocolate fruitcake pastry. Powder jelly beans jujubes. Croissant macaroon dessert cookie candy canes jelly jujubes. Muffin liquorice ice cream wafer donut danish soufflé dragée chocolate bar. Candy croissant candy wafer toffee lemon drops croissant danish sugar plum. Cookie cake candy canes. Pastry powder muffin soufflé tootsie roll sweet cookie tiramisu."
, "Candy cake danish gingerbread. Caramels toffee cupcake toffee sweet. Gummi bears candy cheesecake sweet. Pie gingerbread sugar plum halvah muffin icing marzipan wafer icing. Candy fruitcake gummies icing marzipan. Halvah jelly beans candy candy canes biscuit bonbon sesame snaps. Biscuit carrot cake croissant cake chocolate lollipop candy biscuit croissant. Topping jujubes apple pie croissant chocolate cake. Liquorice cookie dragée gummies cotton candy fruitcake lemon drops candy canes. Apple pie lemon drops gummies cake chocolate bar cake jelly-o tiramisu. Chocolate bar icing pudding marshmallow cake soufflé soufflé muffin. Powder lemon drops biscuit sugar plum cupcake carrot cake powder cake dragée. Bear claw gummi bears liquorice sweet roll."
]
)
controlTitleVisibility : Control Modal.Attribute
controlTitleVisibility =
Control.choice
[ ( "showTitle", Control.value Modal.showTitle )
, ( "hideTitle", Control.value Modal.hideTitle )
]
controlTheme : Control Modal.Attribute
controlTheme =
Control.choice
[ ( "info", Control.value Modal.info )
, ( "warning", Control.value Modal.warning )
]
controlCss : Control Modal.Attribute
controlCss =
Control.map Modal.css <|
Control.choice
[ ( "[]", Control.value [] )
, ( "[ Css.borderRadius Css.zero ]", Control.value [ Css.borderRadius Css.zero ] )
, ( "[ Css.width (Css.px 900) ]", Control.value [ Css.width (Css.px 900) ] )
]
{-| -}
example : Example State Msg
example =
{ name = "Modal"
, version = 11
, categories = [ Layout, Messaging ]
, keyboardSupport =
[ { keys = [ KeyboardSupport.Tab ]
, result = "Moves focus to the next button within the modal or wraps back to the first element within the modal."
}
, { keys = [ KeyboardSupport.Tab, KeyboardSupport.Shift ]
, result = "Moves focus to the previous button within the modal or wraps back to the last element within the modal."
}
, { keys = [ KeyboardSupport.Esc ]
, result = "If 'dismissOnEscAndOverlayClick' is set to true, closes the modal. Else, does nothing."
}
]
, state = init
, update = update
, subscriptions = subscriptions
, preview =
[ -- faking a mini version of the Modal component to give styleguide users a sense of what the
-- component might look like
div
[ css
[ Css.backgroundColor (Nri.Ui.Colors.Extra.withAlpha 0.9 Colors.navy)
, Css.borderRadius (Css.px 4)
, Css.padding2 (Css.px 25) Css.zero
, Css.displayFlex
, Css.alignItems Css.center
, Css.justifyContent Css.center
]
]
[ div
[ css
[ Css.backgroundColor Colors.white
, Css.padding (Css.px 10)
, Css.borderRadius (Css.px 10)
, Css.boxShadow5 Css.zero (Css.px 1) (Css.px 10) Css.zero (Css.rgba 0 0 0 0.35)
, Css.textAlign Css.center
, Css.color Colors.navy
, Fonts.baseFont
, Css.margin Css.auto
, Css.width (Css.px 100)
, Css.height (Css.px 60)
, Css.fontSize (Css.px 10)
, Css.fontWeight Css.bold
, Css.position Css.relative
]
]
[ text "Modal"
, ClickableSvg.link "Close"
UiIcon.x
[ ClickableSvg.exactWidth 10
, ClickableSvg.exactHeight 10
, ClickableSvg.css
[ Css.position absolute
, Css.top (Css.px 10)
, Css.right (Css.px 10)
]
, ClickableSvg.custom [ Key.tabbable False ]
]
]
]
]
, view =
\state ->
let
settings =
Control.currentValue state.settings
in
[ div [ css [ Css.displayFlex, Css.justifyContent Css.spaceAround ] ]
[ Control.view UpdateAttributes state.attributes
|> Html.fromUnstyled
, Control.view UpdateSettings state.settings
|> Html.fromUnstyled
]
, launchModalButton settings
, Modal.view
{ title = settings.title
, wrapMsg = ModalMsg
, content = [ viewModalContent settings.content ]
, footer =
List.filterMap identity
[ if settings.showContinue then
Just continueButton
else
Nothing
, if settings.showSecondary then
Just closeClickableText
else
Nothing
]
, focusTrap =
{ focus = Focus
, firstId =
if settings.showX then
Modal.closeButtonId
else if settings.showContinue then
continueButtonId
else
closeClickableTextId
, lastId =
if settings.showSecondary then
closeClickableTextId
else if settings.showContinue then
continueButtonId
else
Modal.closeButtonId
}
}
(List.concat
[ if settings.showX then
[ Modal.closeButton ]
else
[]
, Control.currentValue state.attributes
]
)
state.state
]
}
launchModalButton : ViewSettings -> Html Msg
launchModalButton settings =
let
launchId =
"launch-modal"
startFocusId =
if settings.showContinue then
Just continueButtonId
else if settings.showX then
Just Modal.closeButtonId
else if settings.showSecondary then
Just closeClickableTextId
else
Nothing
in
Button.button "Launch Modal"
[ case startFocusId of
Just autofocusElementId ->
Button.onClick
(OpenModal
{ startFocusOn = autofocusElementId
, returnFocusTo = launchId
}
)
Nothing ->
Button.disabled
, Button.custom [ Attributes.id launchId ]
, Button.secondary
]
viewModalContent : String -> Html msg
viewModalContent content =
Text.mediumBody
[ Text.css [ whiteSpace preLine ]
, Text.plaintext content
]
continueButtonId : String
continueButtonId =
"continue-button-id"
continueButton : Html Msg
continueButton =
Button.button "Continue"
[ Button.onClick CloseModal
, Button.id continueButtonId
, Button.modal
]
closeClickableTextId : String
closeClickableTextId =
"close-clickable-text-id"
closeClickableText : Html Msg
closeClickableText =
ClickableText.button "Close"
[ ClickableText.onClick CloseModal
, ClickableText.modal
, ClickableText.id closeClickableTextId
]
{-| -}
type Msg
= OpenModal { startFocusOn : String, returnFocusTo : String }
| ModalMsg Modal.Msg
| CloseModal
| UpdateAttributes (Control (List Modal.Attribute))
| UpdateSettings (Control ViewSettings)
| Focus String
| Focused (Result Dom.Error ())
{-| -}
update : Msg -> State -> ( State, Cmd Msg )
update msg state =
let
settings =
state.settings
updateConfig =
{ dismissOnEscAndOverlayClick =
(Control.currentValue settings).dismissOnEscAndOverlayClick
}
in
case msg of
OpenModal config ->
let
( newState, cmd ) =
Modal.open config
in
( { state | state = newState }
, Cmd.map ModalMsg cmd
)
ModalMsg modalMsg ->
case Modal.update updateConfig modalMsg state.state of
( newState, cmd ) ->
( { state | state = newState }
, Cmd.map ModalMsg cmd
)
CloseModal ->
let
( newState, cmd ) =
Modal.close state.state
in
( { state | state = newState }
, Cmd.map ModalMsg cmd
)
UpdateAttributes value ->
( { state | attributes = value }, Cmd.none )
UpdateSettings value ->
( { state | settings = value }, Cmd.none )
Focus id ->
( state, Task.attempt Focused (Dom.focus id) )
Focused _ ->
( state, Cmd.none )
{-| -}
subscriptions : State -> Sub Msg
subscriptions model =
Sub.map ModalMsg (Modal.subscriptions model.state)