Class: Yattho::Alpha::ImageCrop

Inherits:
Component
  • Object
show all
Defined in:
app/components/yattho/alpha/image_crop.rb

Overview

A client-side mechanism to crop images.

Constant Summary

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods inherited from Component

deprecated?, generate_id

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(src:, rounded: true, **system_arguments) ⇒ ImageCrop

Returns a new instance of ImageCrop.

Examples:

Simple cropper

<%= render(Yattho::Alpha::ImageCrop.new(src: Yattho::ExampleImage::BASE64_SRC)) %>

Square cropper

<%= render(Yattho::Alpha::ImageCrop.new(src: Yattho::ExampleImage::BASE64_SRC, rounded: false)) %>

Cropper with a custom loader

<%= render(Yattho::Alpha::ImageCrop.new(src: Yattho::ExampleImage::BASE64_SRC, rounded: false)) do |cropper| %>
  <% cropper.with_loading(style: "width: 120px").with_content("Loading...") %>
<% end %>

Parameters:

  • src (String) —

    The path of the image to crop.

  • rounded (Boolean) (defaults to: true) —

    If the crop mask should be a circle. Defaults to true.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



31
32
33
34
35
36
 
# File 'app/components/yattho/alpha/image_crop.rb', line 31

def initialize(src:, rounded: true, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = "image-crop"
  @system_arguments[:src] = src
  @system_arguments[:rounded] = true if rounded
end