Update README.md

This commit is contained in:
Nicco 2020-11-11 21:52:25 +01:00 committed by GitHub
parent c94a6a1f4c
commit 602e8f949a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -46,8 +46,56 @@ yarn add svelte-cloudinary
This will formulate the Cloudinary url and insert it into the `img.src` property. This will formulate the Cloudinary url and insert it into the `img.src` property.
Also it will resize to the `img` object itself because we set `bind: true`. Also it will resize to the `img` object itself because we set `bind: true`.
## Key Concepts
### `step`
The `step` property (defaults to `200`) helps reducing the amounts of transformations cloudinary need to perform and less credits being billed to you.
How? Basically whenever we calculate the dynamic size of the image rendered on the DOM we will get very specific numbers depending on the device.
With `step` we approximate the size needed to a multiple of `step`.
###### Example
Immagine the same `<img />` has the width of `420`,`470` and `1080` on an iPhone, Android and Laptop respectively.
With a `step` size of e.g. `100` (`<img use:image={{ ..., step: 100 }} />`) they will become `500`, `500`, and `1100`. This will limit the ammount of transformations needed.
### `bind`
With bind we can dynamically set the width and/or height of the transformet image depending of the rendered size.
- `bind: this` The size of the `<img />` element
- `bind: el` The computed size of another element in the dom (usefull for a carousell e.g.)
- `bind: { width: this }` Only bind the width, leaving the height free. Also works with height of course
- `bind: { width: '.wrapper' }` Finds the closest element that matches the selector and uses it for width.
##### Note
If you provide a `bind` options (`<img use:image={{..., bind: true }} />`) but no crop option, we will automcatically add `crop: 'fill'` otherwise the image will not be resized by cloudinary.
###### TLDR;
```svelte
<img use:image={{ src, bind: true }} />
<!-- Is internally equivalent to the following -->
<img use:image={{ src, bind: true, options: { crop: 'fill' } }} />
```
## ⌨️ Examples ## ⌨️ Examples
### Fixed size
```svelte
<img
use:image={{ src, options: { width: 200, height: 100, crop: 'fill' } }}
/>
```
### `bind`
```svelte ```svelte
<!-- Simple --> <!-- Simple -->
<img <img