hallelujahdrive / elm-croppie / 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

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.

rotate : String -> Basics.Int -> Data

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

setZoom : String -> Basics.Float -> Data

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


type alias Data =
Internal.Data

Data to communicate via port

Croppie

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

Croppie view function.

Options


type alias Option =
Internal.Option

Option of Croppie

Learn more in the Croppie.Options module.


type alias BindOption =
Internal.BindOption

Option of bind an image

Learn more in the Croppie.BindOptions module.


type alias ResultOption =
Internal.ResultOption

Option of to get the resulting crop of image

Learn more in the Croppie.ResultOptions module.

CropData


type alias CropData =
{ orientation : Basics.Int
, points : List Basics.Int
, zoom : Basics.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.