hallelujahdrive/elm-croppie/1.0.2

NOTE: the latest version is 1.0.3

Croppie

Datas

To execute the instance method of Croppie, send Data via port as shown below.

port croppie : Croppie.Data -> Cmd msg


view =
    Croppie.croppie [] [ id "example" ]


get =
    croppie <|
        Croppie.get "example"


bind =
    croppie <|
        Croppie.bind "example" bindOptions


result =
    croppie <|
        Croppie.result "example" resultOptions


rotate =
    croppie <|
        Croppie.rotate "example" degrees


setZoom =
    croppie <|
        Croppie.setZoom "example" value
get : String -> Data

Get the crop points, and the zoom of the image.

The return value can be received with Croppie.Events.onGet

  • id id of the target Croppie element
bind : String -> List BindOption -> Data

Bind an image to the croppie.

result : String -> List ResultOption -> Data

Get the resulting crop of the image.

The return value can be received with Croppie.Events.onResult.

  • id id of the target Croppie element
  • resultOptions List of result options. See Croppie.ResultOptions for list of options
rotate : String -> Int -> Data

Rotate the image by a specified degree amount. Only works with enableOrientation option enabled (see Croppie.Options.enableOrientation).

  • id id of the target Croppie element

  • degrees rotation angle

    Valid Values: 90, 180, 270, -90, -180, -270

setZoom : String -> Float -> Data

Set the zoom of a Croppie instance. The value passed in is still restricted to the min/max set by Croppie.

  • id id of the target Croppie element
  • value a floating point to scale the image within the croppie. Must be between a min and max value set by croppie.
type alias Data =
Data

Data to communicate via port

Croppie

croppie : List Option -> List (Attribute msg) -> Html msg

Croppie view function.

Options

type alias Option =
Option

Option of Croppie

Learn more in the Croppie.Options module.

type alias BindOption =
BindOption

Option of bind an image

Learn more in the Croppie.BindOptions module.

type alias ResultOption =
ResultOption

Option of to get the resulting crop of image

Learn more in the Croppie.ResultOptions module.

CropData

type alias CropData =
{ orientation : Int
, points : List Int
, zoom : Float
}

The crop points and the zoom of the image.

Result of Cropped image

type Result msg
= Base64 String
| Canvas String
| Html (Html msg)

The result of cropping the image.