hallelujahdrive/elm-croppie/1.0.1

NOTE: the latest version is 1.0.3

Croppie.Options

Options to inirialize Croppie

See Croppie.croppie for usage.

Boundary

{ width : Int
, height : Int
}
-> Option

The outer container of the cropper

Default: will default to the size of the container

Custom Class

customClass : String -> Option

A class of your choosing to add to the container to add custom styles to your croppie

Exif

enableExif : Bool -> Option

Enable exif orientation reading. Tells Croppie to read exif orientation from the image data and orient the image correctly before rendering to the page. Requires exif.js

Orientation

enableOrientation : Bool -> Option

Enable or disable support for specifying a custom orientation when binding images (See Croppie.bind)

Resize

enableResize : Bool -> Option

Enable or disable support for resizing the viewport area.

Zoom

enableZoom : Bool -> Option

Enable zooming functionality. If set to false - scrolling and pinching would not zoom.

Enforce Boundary

enforceBoundary : Bool -> Option

Restricts zoom so image cannot be smaller than viewport

Mouse wheel zoom

Enable or disable the ability to use the mouse wheel to zoom in and out on a croppie instance. If Ctrl is passed mouse wheel will only work while control keyboard is pressed

= Enabled
| Disabled
| Ctrl

Mouse wheel zoom type

Show Zoomer

showZoomer : Bool -> Option

Hide or Show the zoom slider

Viewport

{ width : Int
, height : Int
, type_ : CropType
}
-> Option

The inner container of the croppie, The visible part of the image

Default: { width = 100, height = 100, type_ = Square }

= Circle
| Square

Viewport shape