- Secure and Sign URLs
- Srcset Generation
To begin creating imgix URLs, import the imgix library and create a URL builder. The URL builder can be reused to create URLs for any images on the domain it is provided.
HTTPS support is enabled by default. HTTP can be toggled on by setting
false. This can be done in one of two ways:
To produce a secure URL, you must enable Secure URLs on your source and then provide your token to the URL builder. The builder will use this token to sign your URL––thus securing the URL against tampering or alterations made by anyone without access to your token.
Note that due to the way signing secures URLs by "locking" them in their generated state, it's required that a URL be re-signed and secured after any modifications (e.g. updating parameters, path, etc.). Fortunately, our SDK will handle re-signing automatically.
First, be sure to keep your token a secret.
The imgix-go package allows for generation of custom srcset attributes, which can be invoked through the
CreateSrcset method. By default, the generated srcset will allow for responsive size switching by building a list of image-width mappings.
The above will produce the following srcset attribute value, which can then be served to the client:
In cases where enough information is provided about an image's dimensions,
CreateSrcset will build a srcset that will allow for an image to be served at different resolutions. The parameters taken into consideration when determining if an image is fixed-width are
CreateSrcset with either a width or height in the parameters, a fixed-width srcset will be generated. Wherein, the image width is fixed, but the pixel density varies.
Will produce the following attribute value:
For more information to better understand srcset, we highly recommend Eric Portis' "Srcset and sizes" article which goes into depth about the subject.
This library will automatically append a variable
q parameter mapped to each
dpr parameter when generating a fixed-width image srcset. This technique is commonly used to compensate for the increased file size of high-DPR images.
Since high-DPR images are displayed at a higher pixel density on devices, image quality can be lowered to reduce overall file size without sacrificing perceived visual quality. For more information and examples of this technique in action, see this blog post.
This behavior will respect any overriding
q value passed in as a parameter. Additionally, it can be disabled by passing the
In situations where specific widths are desired when generating
srcset pairs, a user can specify them by passing an array of positive integers to
In certain circumstances, you may want to limit the minimum or maximum value of the non-fixed
srcset generated by the
CreateSrcset method. To do this, you can specify the minWidth and maxWidth by including each as a
srcset width tolerance (
tol) dictates the maximum tolerated difference between an image's downloaded size and its rendered size.
For example, setting this value to
0.10 means that an image will not render more than 10% larger or smaller than its native size. In practice, the image URLs generated for a width-based srcset attribute will grow by twice this rate.
A lower tolerance means images will render closer to their native size (thereby increasing perceived image quality), but a large srcset list will be generated and consequently users may experience lower rates of cache-hit for pre-rendered images on your site.
By default, srcset width tolerance is set to 0.08 (8 percent), which we consider to be the ideal rate for maximizing cache hits without sacrificing visual quality. Users can specify their own width tolerance by providing a positive scalar value as width tolerance.
In this case, the width tolerance is set to 20 percent:
TargetWidths function is used internally to generate lists of target widths to be used in calls to
It is a way to generate, play with, and explore different target widths separately from srcset attributes. We've already seen how to generate srcset attributes when the minWidth, maxWidth, and tolerance values are known.
Another approach is to use
TargetWidths to determine which combination of values for
tolerance works best.
For security and diagnostic purposes, we sign all requests with the language and version of library used to generate the URL.
ixlib parameter can be toggled off by setting
Or by passing the
WithLibParam(false) option at time of construction:
You can go test this code with:
More Core Libraries
- imgix-csharpbuildA C# client library for generating image URLs with imgixC# 13 a year ago
- imgix-javabuildA Java client library for generating URLs with imgixJava 17 a year ago
- imgix-phpbuildA PHP client library for generating URLs with imgixPHP 110 10 months ago
- imgix-pythonbuildA Python client library for generating URLs with imgixPython 36 a year ago
- imgix-rbbuildA Ruby gem for generating image URLs with imgixRuby 76 a year ago
- imgix-swiftbuildA Swift client library for generating URLs with imgixSwift 24 4 months ago