cdevienne/elm-orus-ui/1.0.0

Renamed to orus-io/elm-orus-ui. It is published under that name, and new versions come out there.

Versions published as cdevienne/elm-orus-ui still install under that name. 1 version of 1 come from the new location (see their notes).

Rerouted (renamed, needs approval). The GitHub user or repository was renamed. The tag is still there, at the new name. The Lamdera package server serves a copy recovered from https://github.com/orus-io/elm-orus-ui.

What we checked: The repo moved to github.com/orus-io/elm-orus-ui and tag 1.0.0 is there; its commit ad645724a38d is from 2024-11-15 10:17 UTC, after the version was published (2024-11-15 09:57 UTC); elm.json differs from package.elm-lang.org's; the exposed modules match docs.json; the zip's SHA-1 is not the published one and nothing else confirms its contents.

We could not verify this copy against what was published, so the Lamdera compiler asks before using it (y/n). Without a terminal, as in CI, it stops with an error unless approved:

  • lamdera make --auto-approve-package-rerouting approves rerouted versions for that run,
  • LAMDERA_AUTO_APPROVE_PACKAGE_REROUTING=1 does the same for every run in that environment,
  • LAMDERA_CACHE=off skips the Lamdera package server altogether: packages come from package.elm-lang.org and GitHub only, as with elm, and a rerouted version then fails to download.

Details · package.elm-lang.org's zip: https://github.com/cdevienne/elm-orus-ui/zipball/1.0.0/

OUI.Navigation

A Navigation drawer(+rail) component

new : (key -> msg) -> Navigation btnC key msg

create a new empty Navigation drawer

withSelected : key -> Navigation btnC key msg -> Navigation btnC key msg

Set the currently selected entry

rail : Navigation btnC key msg -> Navigation btnC key msg

Change the drawer into a rail

Button { btnC | hasAction : (), hasIcon : () } msg
-> Navigation btnC key msg
-> Navigation btnC key msg

Add a FAB button before the entries

withHeader : String -> Navigation btnC key msg -> Navigation btnC key msg

Add a text header on top of the trail/drawer

withImageHeader : Image -> Navigation btnC key msg -> Navigation btnC key msg

Add a image header on top of the trail/drawer

Adding content

key
-> String
-> Icon
-> Navigation btnC key msg
-> Navigation btnC key msg

Add a regular entry

key
-> String
-> Icon
-> Badge
-> Navigation btnC key msg
-> Navigation btnC key msg

Add an entry with a badge

addSectionHeader : String -> Navigation btnC key msg -> Navigation btnC key msg

Add a section header

addDivider : Navigation btnC key msg -> Navigation btnC key msg

Add a divider

Internals

type Mode
= Rail
| Drawer
| ModalDrawer

Mode of the Navigation component

type Entry key
= Entry key EntryProperties
| SectionHeader String
| Divider

Type of Entry inside the Navigation component. Settings -> this is a SectionHeader Video -> this is an Entry Audio ----- -> this is a Divider Gameplay Misc

type alias EntryProperties =
{ label : String
, icon : Icon
, badge : Maybe Badge
}

Properties of the Entry type

Navigation btnC key msg
-> Maybe (Button { btnC | hasAction : (), hasIcon : () } msg)

get the FAB button

getHeader : Navigation btnC key msg -> Maybe String

get the text header

getImageHeader : Navigation btnC key msg -> Maybe Image

get the image header

getSelected : Navigation btnC key msg -> Maybe key

get the selected key

getEntries : Navigation btnC key msg -> List (Entry key)

get the entries

getMode : Navigation btnC key msg -> Mode

get the mode

getOnSelect : Navigation btnC key msg -> key -> msg

get the select message

getOnDismiss : Navigation btnC key msg -> Maybe msg

get the dismiss message

getActiveColor : Navigation btnC key msg -> Color

get the active color