NoRedInk/noredink-ui/29.0.0

NOTE: the latest version is 35.9.3

Nri.Ui.Container.V2

Common NoRedInk Containers

TODO in next version:

  • remove invalid

Changelog

Patch changes

  • use Shadows
  • add notMobileCss, mobileCss, quizEngineMobileCss
  • use internal Content module
  • adds paragraph

Changes from V1

  • removes fullHeight
  • changes the API from providing many themed functions that create HTML (alternate, general, etc.) to having a single view helper that takes a list of attributes (including themed attributes and content attributes)
  • adds custom, testId, id
  • adds plaintext helper and markdown helper
  • renames themes from:
    • alternate -> gray
    • general -> default
    • interactable -> pillow
  • removes interactableWithLabel theme
  • adds buttony theme

Documentation

View

view : List (Attribute msg) -> Html msg
type Attribute msg
custom : List (Attribute msg) -> Attribute msg

Use this helper to add custom attributes.

Do NOT use this helper to add css styles, as they may not be applied the way you want/expect if underlying styles change. Instead, please use the css helper.

testId : String -> Attribute msg
id : String -> Attribute msg
css : List Style -> Attribute msg
notMobileCss : List Style -> Attribute msg

Set styles that will only apply if the viewport is wider than NRI's mobile breakpoint.

Equivalent to:

Container.css
    [ Css.Media.withMedia [ Nri.Ui.MediaQuery.V1.notMobile ] styles ]
mobileCss : List Style -> Attribute msg

Set styles that will only apply if the viewport is narrower than NRI's mobile breakpoint.

Equivalent to:

Container.css
    [ Css.Media.withMedia [ Nri.Ui.MediaQuery.V1.mobile ] styles ]
quizEngineMobileCss : List Style -> Attribute msg

Set styles that will only apply if the viewport is narrower than NRI's quiz-engine-specific mobile breakpoint.

Equivalent to:

Container.css
    [ Css.Media.withMedia [ Nri.Ui.MediaQuery.V1.quizEngineMobile ] styles ]
paddingPx : Float -> Attribute msg

Changes the padding inside the container border around the content.

Content

paragraph : String -> Attribute msg

Provide a plain-text string that will be put into a paragraph tag, with the default margin removed.

plaintext : String -> Attribute msg

Provide a plain-text string.

markdown : String -> Attribute msg

Provide a string that will be rendered as markdown.

Note that you may need to remove extra margin added by default to p tags by user agents.

html : List (Html msg) -> Attribute msg

Provide a list of custom HTML.

Themes

Used when there are a lot of containers.

Used for the default container case.

DEPRECATED -- this will be removed in the next version of this component.

Used for containers of interactive elements.

Used for clickable cards

Modules