NoRedInk/noredink-ui/15.5.0

NOTE: the latest version is 35.9.3

Nri.Ui.Container.V2

Common NoRedInk Containers

Changelog

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
paddingPx : Float -> Attribute msg

Changes the padding inside the container border around the content.

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.

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

Content

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.

Used for containers of interactive elements.

Used for clickable cards