hallelujahdrive / elm-croppie / Croppie.Options

Options to inirialize Croppie

See Croppie.croppie for usage.

Boundary

boundary : { width : Basics.Int, height : Basics.Int } -> Croppie.Internal.Option

The outer container of the cropper

Default: will default to the size of the container

Custom Class

customClass : String -> Croppie.Internal.Option

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

Exif

enableExif : Basics.Bool -> Croppie.Internal.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 : Basics.Bool -> Croppie.Internal.Option

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

Resize

enableResize : Basics.Bool -> Croppie.Internal.Option

Enable or disable support for resizing the viewport area.

Zoom

enableZoom : Basics.Bool -> Croppie.Internal.Option

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

Enforce Boundary

enforceBoundary : Basics.Bool -> Croppie.Internal.Option

Restricts zoom so image cannot be smaller than viewport

Mouse wheel zoom

mouseWheelZoom : MouseWheelZoom -> Croppie.Internal.Option

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


type MouseWheelZoom
    = Enabled
    | Disabled
    | Ctrl

Mouse wheel zoom type

Show Zoomer

showZoomer : Basics.Bool -> Croppie.Internal.Option

Hide or Show the zoom slider

Viewport

viewport : { width : Basics.Int, height : Basics.Int, type_ : CropType } -> Croppie.Internal.Option

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

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


type CropType
    = Circle
    | Square

Viewport shape