function ImageFormatter::settingsForm

Overrides FormatterBase::settingsForm

File

core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php, line 117

Class

ImageFormatter

Plugin implementation of the 'image' formatter.

Namespace

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $image_styles = image_style_options(FALSE);
    $description_link = Link::fromTextAndUrl($this->t('Configure Image Styles'), Url::fromRoute('entity.image_style.collection'));
    $element['image_style'] = [
        '#title' => $this->t('Image style'),
        '#type' => 'select',
        '#default_value' => $this->getSetting('image_style'),
        '#empty_option' => $this->t('None (original image)'),
        '#options' => $image_styles,
        '#description' => $description_link->toRenderable() + [
            '#access' => $this->currentUser
                ->hasPermission('administer image styles'),
        ],
    ];
    $link_types = [
        'content' => $this->t('Content'),
        'file' => $this->t('File'),
    ];
    $element['image_link'] = [
        '#title' => $this->t('Link image to'),
        '#type' => 'select',
        '#default_value' => $this->getSetting('image_link'),
        '#empty_option' => $this->t('Nothing'),
        '#options' => $link_types,
    ];
    $image_loading = $this->getSetting('image_loading');
    $element['image_loading'] = [
        '#type' => 'details',
        '#title' => $this->t('Image loading'),
        '#weight' => 10,
        '#description' => $this->t('Lazy render images with native image loading attribute (<em>loading="lazy"</em>). This improves performance by allowing browsers to lazily load images.'),
    ];
    $loading_attribute_options = [
        'lazy' => $this->t('Lazy (<em>loading="lazy"</em>)'),
        'eager' => $this->t('Eager (<em>loading="eager"</em>)'),
    ];
    $element['image_loading']['attribute'] = [
        '#title' => $this->t('Image loading attribute'),
        '#type' => 'radios',
        '#default_value' => $image_loading['attribute'],
        '#options' => $loading_attribute_options,
        '#description' => $this->t('Select the loading attribute for images. <a href=":link">Learn more about the loading attribute for images.</a>', [
            ':link' => 'https://html.spec.whatwg.org/multipage/urls-and-fetching.html#lazy-loading-attributes',
        ]),
    ];
    $element['image_loading']['attribute']['lazy']['#description'] = $this->t('Delays loading the image until that section of the page is visible in the browser. When in doubt, lazy loading is recommended.');
    $element['image_loading']['attribute']['eager']['#description'] = $this->t('Force browsers to download an image as soon as possible. This is the browser default for legacy reasons. Only use this option when the image is always expected to render.');
    return $element;
}