EdutainmentLIVE / elm-bootstrap / Bootstrap.Form.Checkbox

This module allows you to create Bootstrap styled checkboxes.

Creating

checkbox : List (Option msg) -> String -> Html msg

Create a checkbox element

Checkbox.checkbox
    [ Checkbox.id "myChk"
    , Checkbox.checked True
    , Checkbox.onCheck MyCheckMsg
    ]

custom : List (Option msg) -> String -> Html msg

Create a composable Bootstrap custom styled checkbox

Checkbox.custom
    [ Checkbox.id "myCustomChk"
    , Checkbox.checked True
    , Checkbox.onCheck MyCheckMsg
    ]

Options

id : String -> Option msg

Set the id for the checkbox. Will automatically set the for attribute for the label

NOTE: You have to use this for custom checkboxes.

checked : Basics.Bool -> Option msg

Option to toggle the checkbox checked property on off.

inline : Option msg

Use this option to display checkboxes inline.

indeterminate : Option msg

Option to set the indeterminate property of a checkbox

Note: A checkbox can't be both indeterminate and checked, so if you set both the last one provided in the list of options to the checkbox function "wins".

disabled : Basics.Bool -> Option msg

Option to disable the checkbox

onCheck : (Basics.Bool -> msg) -> Option msg

Shorthand for assigning an onCheck handler for a checkbox.

attrs : List (Html.Attribute msg) -> Option msg

Use this function to handle any Html.Attribute option you wish for your select

success : Option msg

Option to color a checkbox with success.

danger : Option msg

Option to color a checkbox with danger.


type Option msg

Opaque type representing valid customization options for a checkbox