gohugoio--hugo/docs/content/en/methods/resource/Fit.md

title, description, categories, keywords, params

title	description	categories	keywords	params
Fit	Applicable to images, returns a new image resource downscaled to fit according to the given processing specification.			functions_and_methods returnType signatures images.ImageResource RESOURCE.Fit SPECIFICATION

{{% include "/_common/methods/resource/global-page-remote-resources.md" %}}

The Fit method returns a new resource from a processable image according to the given processing specification.

Note

Use the reflect.IsImageResourceProcessable function to verify that an image can be processed.

Usage

When fitting, you must provide both width and height (such as 300x175) within the specification. Fit maintains the original aspect ratio by downscaling the image until it fits within the specified dimensions. Unlike Fill or Resize, this method will never upscale an image; if the source image is smaller than the target dimensions, the dimensions of the resulting image are the same as the original.

{{ with resources.Get "images/original.jpg" }}
  {{ with .Fit "300x175" }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ end }}
{{ end }}

In the example above, "300x175" is the processing specification.

{{% include "/_common/methods/resource/processing-spec.md" %}}

Example

{{ with resources.Get "images/original.jpg" }}
  {{ with .Fit "300x175" }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ end }}
{{ end }}

{{< img src="images/examples/zion-national-park.jpg" alt="Zion National Park" filter="Process" filterArgs="fit 300x175" example=true

}}