You are invited to influence our new SDK [Click here to view github discussion](https://github.com/cloudinary/js-url-gen/discussions/602) =========================
You are invited to influence our new SDK
Click here to view github discussion
=========================
Cloudinary URL-Gen SDK
=========================
This SDK can also be used with popular frontend frameworks.
NOTE: When using the url-gen library, an additional transformation-builder-sdk library is installed as a dependency.
This library handles the transformation generation part of the URL and as such, all transformation actions are imported from this library.
Therefore, you can import all transformations either from @cloudinary/url-gen (as demonstrated in the documentation), or directly from the transformation-builder-sdk library, for example:
``javascript`
import {scale} from '@cloudinary/transformation-builder-sdk/actions/resize';
You can find all available transformations in the Transformation Builder reference.
| SDK Version | Node.js 14 | Node.js 16 |
|-------------|------------|------------|
| 1.x | V | V |
bash
npm install @cloudinary/url-gen
`
bash
yarn add @cloudinary/url-gen
`Usage
$3
javascript
// Import the Cloudinary class
import {Cloudinary} from '@cloudinary/url-gen';// Create your instance
const cld = new Cloudinary({
cloud: {
cloudName: 'demo'
},
url: {
secure: true // force https, set to false to force http
}
});
`
$3
- See full documentation
javascript
// Create a new instance if you haven't (see above for the details)
const cld = new Cloudinary({/.../})// Let's create a new image
const myImage = cld.image('sample');
// Import the resize transformation and apply it to myImage
import {Resize} from '@cloudinary/url-gen/actions/resize';
// Resize the image to 100x100
myImage.resize(Resize.scale().width(100).height(100));
// When we're done, we can apply all our changes and create a URL.
const myURL = myImage.toURL();
// https://res.cloudinary.com/demo/image/upload/c_scale,w_100,h_100/sample
console.log(myURL);
`$3
The library supports transformations on both images and videos. Please use the appropriate method, as per below: - Use
to generate image URLs and transformations
- Use cld.video() to generate video URLs and transformationsBoth the
image() and video() methods allow you to use toURL() to generate the final, transformed asset URL.$3
This SDK does not provide file upload functionality, however there are several methods of uploading from the client side.$3
@cloudinary/url-gen is shipped as untranspiled ES6 code.
@cloudinary/url-gen is optimized around bundle size, as such we do not transpile our distributed modules,
we leave the decision of what browsers to support, and what transpilations to apply, to you, the user.$3
As mentioned above, we're shipping @cloudinary/url-gen with ES6 code, as this provides great tree-shaking potential.
it also requires a few adjustments when testing.In jest.config, you'll need to add these lines to allow babel to transpile our code.
`json
{
"transform": {
"node_modules/@cloudinary/url-gen": "babel-jest",
"node_modules/@cloudinary/transformation-builder-sdk": "babel-jest"
},
"transformIgnorePatterns": ["/node_modules/(?!(@cloudinary/url-gen|@cloudinary/transformation-builder-sdk))"]
}
`
Make sure to install babel-jest:
You'll also need to ensure you have a
file (and not a .babelrc), and that
it's configured properly to transpile code,As an example:
`js
module.exports = {
"presets": [
"@babel/preset-env"
]
};
`Contributions
- Clone this repository
- Create a fork
- Make your changes
- Run tests locally
- Build project locally npm run build`Additional resources can be found here:
- Getting started
- Annotated Code Examples
- Setup & Configuration