Nri.Ui.Checkbox.V1

type alias Model msg =

{ identifier : String

, label : String

, setterMsg : Bool -> msg

, isChecked : Maybe Bool

, disabled : Bool

, theme : Theme

, noOpMsg : msg

}

isChecked : Maybe Bool
- Just True == Checked (rendered checkmark)
- Just False == Not Checked (rendered blank)
- Nothing == Indeterminate (rendered dash)

type Theme

= Square ColorTheme

| Round Bool

| Locked

| LockOnInside

| Unlockable

| Disabled

| Premium

type ColorTheme

= Default

| Gray

| Orange

view : Model msg -> Html msg

Shows a checkbox (the label is only used for accessibility hints)

viewWithLabel : Model msg -> Html msg

Shows a checkbox and its label text

viewAttention : Model msg -> Html msg

disabled : String -> String -> Html msg

Show a disabled checkbox.

type IsSelected

= Selected

| NotSelected

| PartiallySelected

keyframeCss : Keyframe

styles : StylesWithAssets Never CssClasses msg (Assets r)

Premium

type alias PremiumConfig msg =

{ label : String

, id : String

, selected : IsSelected

, disabled : Bool

, teacherPremiumLevel : PremiumLevel

, contentPremiumLevel : PremiumLevel

, showFlagWhenLocked : Bool

, onChange : Bool -> msg

, onLockedClick : msg

, noOpMsg : msg

}

onChange: A message for when the user toggles the checkbox
onLockedClick: A message for when the user clicks a checkbox they don't have PremiumLevel for. If you get this message, you should show an Nri.Ui.Premium.Model.view

premium : PremiumConfig msg -> Html msg

A checkbox that should be used for premium content

This checkbox is locked when the premium level of the content is greater than the premium level of the teacher

NoRedInk/noredink-ui/4.9.1

Nri.Ui.Checkbox.V1

Premium

Modules