orus-io/elm-orus-ui/1.0.1

Formerly cdevienne/elm-orus-ui. Search finds this package by either name.

OUI.Icon

Constructor

type Icon

An Icon

The default size / color is decided by the final rendering (with OUI.Material.renderIcon for instance).

When used inside other components, like buttons, the color & size will most probably be ignored.

A future version may separated icons with size/color from raw icons

withSize : Int -> Icon -> Icon

set the icon size

set the icon color

Stock icons

A blank icon, used as a placeholder

The 'check' icon, taken from icidasset/elm-material-icons

A simple 'clear' icon, taken from icidasset/elm-material-icons

'Light Mode' icon, taken from icidasset/elm-material-icons

'Dark Mode' icon, taken from icidasset/elm-material-icons

'arrow drop down' icon, taken from icidasset/elm-material-icons

'arrow drop up' icon, taken from icidasset/elm-material-icons

Adapters

elmMaterialIcons : (Color -> coloring) -> (Int -> coloring -> Html Never) -> Icon

For using icidasset/elm-material-icons

import Material.Icons exposing (offline_bolt)
import Material.Icons.Types exposing (Coloring(..))
import OUI.Icon exposing (Icon)


check : Icon
check =
    Material.Icons.done
        |> OUI.Icon.elmMaterialIcons Color
materialIcons : (Color -> Int -> Svg Never) -> Icon

For using danmarcab/material-icons

import Material.Icons.Action
import OUI.Icon exposing (Icon)


check : Icon
check =
    Material.Icons.Action.done
        |> OUI.Icon.materialIcons

Internals

= Svg (Int -> Color -> Svg Never)
| Html (Int -> Color -> Html Never)

renderer type of the Icon. Html or Svg

getSize : Icon -> Maybe Int

get the size

getColor : Icon -> Maybe Color

get the color

get the renderer