Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PictureOptions

Index

Properties

Optional alt

alt: undefined | string

Alt name for image element.

Optional cname

cname: undefined | string

Use custom cname for generated filelinks.

Optional formats

formats: string[]

Array of image types, e.g. ['jpg', 'webp'].

Optional keys

keys: undefined | false | true

Toggle setting key attribute on sources. Useful for React. Defaults to true.

Optional resolutions

resolutions: (string | number)[]

Resolution descriptors. Defaults to a sensible range between 180w and 3024w. Can also be numbers representing widths or strings representing pixel densities, e.g. ['1x', '2x'].

Optional security

security: Security

Object containing Filestack security policy and signature.

Optional sizes

sizes: Size

Object of sizes and their media query hints. Note: A fallback for img sizes is highly recommended. For example:

sizes: {
  '(min-width: 1280px)': '50vw',
  '(min-width: 640px)': '60vw',
  fallback: '100vw',
}

Optional transforms

transforms: TransformOptions

Image transformations options

see

https://www.filestack.com/docs/image-transformations

Optional useValidator

useValidator: undefined | false | true

Set if should use validator for params task

Optional width

width: undefined | string

Static width to use for img with optional pixel density support.