This is an alternative site for discovering Elm packages. You may be looking for the official Elm package site instead.
Reusable date and time picker view
version 5.0.4
license Apache-2.0
native-modules False
elm-version 0.18.0 <= v < 0.19.0
Tag 5.0.4
Committed At 2018-11-13 00:12:14 UTC
rtfeldman/elm-css 16.0.0 <= v < 17.0.0 16.0.1
elm-tools/parser 2.0.1 <= v < 3.0.0 2.0.1
elm-lang/svg 2.0.0 <= v < 3.0.0 2.0.0
elm-lang/html 2.0.0 <= v < 3.0.0 2.0.0
elm-lang/core 5.0.0 <= v < 6.0.0 5.1.1

README

Date and Time Picker

THIS IS A FORK OF https://github.com/abadi199/datetimepicker

Demo

Live Demo

Date Time Picker

The date and time picker can be used in two modes:

  • Analog Time Picker
  • Digital Time Picker

Analog time picker

alt text

Code:

view model =
    DateTimePicker.dateTimePickerWithConfig
        { defaultDateTimeConfig | timePickerType = DateTimePicker.Config.Analog }
        [ class "my-datetimepicker" ]
        model.state
        model.value

Digital time picker

alt text

Code:

view model =
    DateTimePicker.dateTimePickerWithConfig
        { defaultDateTimeConfig | timePickerType = DateTimePicker.Config.Digital }
        [ class "my-datetimepicker" ]
        model.state
        model.value

Date Picker

Just the date picker without the time.

alt text

Code:

type Msg = DateChange DateTimePicker.State (Maybe DateTimePicker.DateTime)

type alias Model = { value : Maybe DateTimePicker.DateTime, state : DateTimePicker.State }

view model =
    DateTimePicker.datePicker
        DateChange
        [ class "my-datepicker" ]
        model.state
        model.value

Time Picker

Just the time picker without the date.

alt text

Code:

type Msg = TimeChange DateTimePicker.State (Maybe DateTimePicker.DateTime)

type alias Model = { value : Maybe DateTimePicker.DateTime, state : DateTimePicker.State }

view model =
    DateTimePicker.timePicker
        TimeChange
        [ class "my-timepicker" ]
        model.state
        model.value

Documentation

This package follows the evancz\sortable-table package approach where it's not a nested elm architecture 'component'. It's just view functions where you feed the data and the message constructor to the function. It does use an opaque State to maintain its internal state.

The picker requires the initial value of the date (usually today) to set the initial position of the calendar. To feed this date to the picker's internal state, you can use 2 approaches

  • By passing a Date value to the DateTimePicker.initialStateWithToday function when initialing the picker's State.
  • By calling the DateTimePicker.initialCmd as part of your init commands.

Views

The date time picker package provides multiple view functions, depending on how you want to use the picker.

  • datePicker is a simple date picker view, with no time picker, and comes with all default configuration.
  • timePicker is a simple time picker view, with no date picker, and comes with all default configuration.
  • dateTimePicker is a simple date and time picker view, comes with all default configuration.
  • datePickerWithConfig is a configurable date picker view.
  • timePickerWithConfig is a configurable time picker view.
  • dateTimePickerWithConfig is a configurable date and time picker view.

Config

You customize the date picker configuration by passing a DateTimePicker.Config.Config value to the picker's view function. The DateTimePicker.Config module provides some default configurations for both date picker and date time picker.

Example

Here's a snippet of typical Elm application:

main = 
    Html.program 
        { init = init 
        , view = view
        , update = update
        , subscriptions = subscriptions 
        }

type Msg 
    = DateChange DateTimePicker.State (Maybe DateTimePicker.DateTime)

type alias Model = 
    { selectedDate : Maybe DateTimePicker.DateTime
    , datePickerState : DateTimePicker.State 
    }

init = 
    ( { selectedDate = Nothing, datePickerState.initialState }
    , DateTimePicker.initialCmd DateChange DateTimePicker.initialState
    )

view model = 
    DateTimePicker.dateTimePickerWithConfig 
        DateChange 
        [ class "my-datetimepicker" ] 
        model.datePickerState 
        model.selectedDate

update msg model =
    case msg of
        DateChange datePickerState selectedDate ->
            ( { model | selectedDate = selectedDate, datePickerState = datePickerState }, Cmd.none ) 

subscriptions =
    ...


For a complete sample code, please see the demo folder of the source code.

Contributing

  • Submit a pull request! If you're missing a feature you want to have, or just found a bug, or found an error in the docs, please submit a pull request.
  • Create an issue! If you found a bug or want a new feature that you think will make the library better, but don't have time to do it yourself, please submit an issue.
  • Message me on slack or twitter if you just want to give me a feedback or thank me. I'm abadi199 on elm-lang slack channel.