imgix / imgix-url-params

Organized, machine-friendly documentation of imgix's URL parameters

imgix URL Parameters

This repo is intended to act as a single source of truth about the current state of all imgix URL API parameters, exposed as JSON.

This may be used to validate parameter inputs, build UI components, or programmatically assemble imgix URLs.

Note: While releases for this repository are intended to follow semantic versioning, its release pattern is tied to an internal imgix library that also includes experimental parameters not intended for public use. As such, version numbers will occasionally be skipped in this public repository in an effort to keep it synchronized with version numbers on the internal library.

Usage

This package is exposed as both a Bower package and an NPM package. We recommend using those to manage this as a dependency.

The artifacts of this repo (any files in dist/) follow Semantic Versioning.

Please see a dist/ file to get an idea of the structure of the document.

imgix-url-params's Issues

"border-left", "border-right", "border-top", "grid-colors", "grid-size", "pad-bottom", "pad-left", "pad-right", "pad-top", "transparency" are missing "available_in" key

Every other parameter defines "available_in". Is this an error?

feat: add types declaration file

Description

related issues: imgix/js-core#308
react-imgix types example: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/8e8454d6da5594f313f3c9e1a80b4ce59b20465b/types/react-imgix/index.d.ts

It would be useful to add a .d.ts file in the dist folder so that TypeScript users can do type checking/leverage IDE auto-completion for imgix params.

The declaration file should match react-style params and include a declaration for every param available in dist/parameters.json

AVIF lossless inconsistency with docs

Describe the bug

The lossless parameter is only specified for "fm=webp", "fm=jxr" but the docs says The AVIF file format supports lossy and lossless image formats. It does support transparency. at https://docs.imgix.com/apis/rendering/format/fm#avif

Which is it?

short_description is missing ?

short_description field is missing on "gif-q" feature (maybe some other) which makes @imgix/gatsby throws here:
https://github.com/imgix/gatsby/blob/main/src/modules/gatsby-plugin/graphqlTypes.ts#L59

Either this is a required field and should be fix here, or @imgix/gatsby should handle it optionally.

txt64 is missing

Any reason why txt64 is not exposed?

Format list of q parameter seems outdated

Describe the bug
https://docs.imgix.com/apis/rendering/format/q says Controls the output quality of lossy file formats (jpg, pjpg, webp, or jxr).

yet https://docs.imgix.com/apis/rendering/format/fm#avif says The AVIF file format supports lossy and lossless image formats.

Is it outdated or does q simply not support controlling quality for avif format?