aforemny/material-components-web-elm/6.0.0

NOTE: the latest version is 9.1.0

Rerouted (regenerated, verified). Same repository and tag, but GitHub now builds the zip with different bytes, so it no longer matches the SHA-1 package.elm-lang.org recorded. The Lamdera package server serves a copy recovered from https://github.com/aforemny/material-components-web-elm.

What we checked: Tag 6.0.0 is still on github.com/aforemny/material-components-web-elm; its commit fa5f16f0eddc is from 2020-10-08 13:01 UTC, before the version was published (2020-10-08 13:03 UTC); every file Elm uses matches a copy in a Lamdera package cache from 2021-02-13, from before the change; elm.json is byte-identical to package.elm-lang.org's; the exposed modules match docs.json; the zip's SHA-1 is not the published one (GitHub's zip no longer comes out byte for byte the same), so the contents were checked instead.

The Lamdera compiler uses this copy and prints a one-line notice saying so. elm itself fails to download this version.

Details · package.elm-lang.org's zip: https://github.com/aforemny/material-components-web-elm/zipball/6.0.0/

Material.Switch

Switches toggle the state of a single setting on or off. They are the preferred way to adjust settings on mobile.

Table of Contents

Resources

Basic Usage

Note that switches are usually used in conjunction with form fields.

import Material.Switch as Switch


type Msg
    = Changed


main =
    Switch.switch
        (Switch.config
            |> Switch.setChecked True
            |> Switch.setOnChange Changed
        )

Switch

switch : Config msg -> Html msg

Switch view function

Configuration

type Config msg

Configuration of a switch

Default configuration of a switch

Configuration Options

setOnChange : msg -> Config msg -> Config msg

Specify a message when the user changes a switch

setChecked : Bool -> Config msg -> Config msg

Specify whether a switch is checked

setDisabled : Bool -> Config msg -> Config msg

Specify whether a switch is disabled

Disabled switches cannot be interacted with and have no visual interaction effect.

setAttributes : List (Attribute msg) -> Config msg -> Config msg

Specify additional attributes

On Switch

To set the state of a switch to on, set its setChecked configuration option to True.

Switch.switch (Switch.config |> Switch.setChecked True)

Disabled Switch

To disable a switch, set its setDisabled configuration option to True.

Disabled switches cannot be interacted with and have no visual interaction effect.

Switch.switch (Switch.config |> Switch.setDisabled True)

Focus a Switch

You may programatically focus a switch by assigning an id attribute to it and use Browser.Dom.focus.

Switch.switch
    (Switch.config
        |> Switch.setAttributes
            [ Html.Attributes.id "my-switch" ]
    )