Cloudinary SDK for Svelte
Go to file
cupcakearmy 21c7e2593b
docs
2020-11-11 21:26:59 +01:00
src docs 2020-11-11 21:26:59 +01:00
.gitignore docs 2020-11-11 21:26:59 +01:00
README.md Update README.md 2020-11-08 11:47:45 +01:00
package.json docs 2020-11-11 21:26:59 +01:00
tsconfig.json initial commit 2020-11-08 11:22:02 +01:00
yarn.lock docs 2020-11-11 21:26:59 +01:00

README.md

svelte-cloudinary

This is a little library that aims at integrating and making it easier to use the svelte with Cloudinary. There is an official integration comming, but it's not ready and for not does not work great.

🚀 Quickstart

yarn add svelte-cloudinary
<script>

  import { image, initialize } from 'svelte-cloudinary'
  
  initialize({ cloud_name: 'myCloudinaryCloud' })

  const src = 'my/cloudinary/asset'
</script>

<style>
  img {
    width: 50vw;
    height: 50vh;
    object-fit: cover;
  }
</style>

<img
  use:image={{ src, bind: true, options: { crop: 'fill' } }}
  class="home-img"
  alt="background" />

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.

🗂 Docs

The image action takes 3 parameters.

src

The publicId of your asset.

bind

This is a utility for setting width and/or height automatically based on the size of a rendered element in the DOM.

  • true: Uses the size of the img node itself
  • '.someClass': Searches for the element closest to the image that matches the css query and takes that as size
  • { height: document.querySelector('#some'), height: '#some' }: Set height and/or width independently from another. Can be an element or css selector.
Examples
<!-- Simple -->
<img
  use:image={{ src, bind: true, }}
/>
<!-- Bind size to parent with selectors -->
<div class="wrapper"
  <img
    use:image={{ src, bind: '.wrapper', }}
  />
</div>
<!-- Bind width to parent with element -->
<div class="wrapper"
  <img
    use:image={{ src, bind: { width: '.wrapper' }, }}
  />
</div>

options

Native cloudinary options. See here for official docs For a quick glance