NoRedInk/noredink-ui/22.12.2

NOTE: the latest version is 35.9.3

Nri.Ui.ClickableSvg.V2

Patch changes:

- adds `nriDescription`, `testId`, and `id` helpers
- adds `iconForMobile`, `iconForQuizEngineMobile`, `iconForNarrowMobile`
- adds `submit` and `opensModal`

Create a button or link

button : String -> Svg -> List (Attribute msg) -> Html msg
type Attribute msg

Behavior

onClick : msg -> Attribute msg

By default, buttons have type "button". Use this attribute to change the button type to "submit".

Note: this attribute is not supported by links.

Use this attribute when interacting with the button will launch a modal.

href : String -> Attribute msg
linkSpa : String -> Attribute msg

Use this link for routing within a single page app.

This will make a normal <a> tag, but change the Events.onClick behavior to avoid reloading the page.

See https://github.com/elm-lang/html/issues/110 for details on this implementation.

linkExternal : String -> Attribute msg
{ method : String
, url : String
}
-> Attribute msg
{ track : msg
, url : String
}
-> Attribute msg
{ track : msg
, url : String
}
-> Attribute msg

Sizing

exactSize : Int -> Attribute msg

Set the size in px for the element's width and height.

Equivalent to:

[ exactWidth inPx
, exactHeight inPx
]
exactWidth : Int -> Attribute msg

Define a size in px for the element's total width.

exactHeight : Int -> Attribute msg

Define a size in px for the element's total height.

State

disabled : Bool -> Attribute msg

Icons

Customization

Display a border around the icon.

white/transparent icon on an azure background.

This is the default: a blue icon on a transparent background, or a blue icon on a white/glacier icon with a blue border.

Used to de-emphasize elements when not hovered.

Used to de-emphasize elements when not hovered.

White/transparent icon on a red background.

Red icon on a white/transparent background.

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 Button styles change. Instead, please use the css helper.

nriDescription : String -> Attribute msg
testId : String -> Attribute msg
id : String -> Attribute msg

CSS

css : List Style -> Attribute msg
notMobileCss : List Style -> Attribute msg

Equivalent to:

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

Equivalent to:

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

Equivalent to:

ClickableSvg.css
    [ Css.Media.withMedia [ Nri.Ui.MediaQuery.V1.quizEngineMobile ] styles ]

DEPRECATED

In practice, we don't use these sizes. Remove them!

This is the default. This attribute will be removed in the next version of ClickableSvg!

This attribute will be removed in the next version of ClickableSvg!

This attribute will be removed in the next version of ClickableSvg!

Modules