feat: add ixlib url parameter to help Imgix support and analytics #145
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jayeb
approved these changes
Jun 26, 2018
README.md
Outdated
| @@ -108,6 +108,10 @@ Fallback width for images, useful for SSR or static site generation | |||
|
|
|||
| Generate `2x` and `3x` src sets when using an `<img>` tag. Defaults to `true` | |||
|
|
|||
| #### disableLibraryParam :: bool | |||
|
|
|||
| By default this component adds a parameter to the generated url to help Imgix with analytics and support for this library. This can be disabled by setting this prop to `true`. | |||
| @@ -6,6 +6,8 @@ import PropTypes from "prop-types"; | |||
|
|
|||
| import processImage from "./support.js"; | |||
|
|
|||
| const PACKAGE_VERSION = require("../package.json").version; | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds an
ixlibparameter to urls generated by this component. The url parameter is in the formixlib=react-7.1.1. There are two reasons to add this parameter: a) it helps Imgix support see what versions of libraries that customers are using, and b) it help Imgix to see how many people overall are using the react library, and the specific versions.This functionality is enabled by default but can be turned off by passing the prop
disableLibraryParam.This closes #142.
New Feature
feat(<area>): added new way to do this cool thing #issue-numberSteps to Test
Either review the unit tests in
test/unit/react-imgix.test.jsor set-up a new app and inspect the generated URLs.