CODEWITHSUNDEEP
javascripthtmlcssvue.js
CosX
CosX

Reputation: 2030

Vue.js data-bind style backgroundImage not working

I'm trying to bind the src of an image in an element, but it doesn't seem to work. I'm getting an "Invalid expression. Generated function body: { backgroundImage:{ url(image) }".

The documentation says to use either 'Kebab-case' or 'camel-case'.

<div class="circular" v-bind:style="{ backgroundImage: { url(image) }"></div>

Heres a fiddle: https://jsfiddle.net/0dw9923f/2/

Upvotes: 147

Views: 318538

Answers (20)

catomatic
catomatic

Reputation: 891

i'd like to add a note:

if using vite.config.js, you may see an alias for resolve, pointing to an assets directory

if so, the following syntax could work:

`background-image: url($public/images/${imageVarString})`

Upvotes: 0

thaciohelmer
thaciohelmer

Reputation: 61

It worked for me

<div class="project" v-for="(project, index) in projects" :key="index">
      <div class="project-img">
        <div class="img-wrapper" :style="{ backgroundImage: `url(${project.imgUrl})` }">
        </div>
      </div>
    </div>


imgUrl: 'http://localhost:8080/img/lp-nike-1280x800.19e4d289.png'

Upvotes: 3

Michael Sinclair
Michael Sinclair

Reputation: 306

This also works:


    let path = require(`@/assets/images/${this.linkToImage}`);
    variableName = `background-image: url('${path}'); `

Upvotes: 2

STREET MONEY
STREET MONEY

Reputation: 604

<template>
  <section :style="banner"></section>
</template>

<script>
import banner from "@/assets/images/banners/rectangle1.png";
export default {
  data() {
    return { banner: { backgroundImage: `url('${banner}')` } };
  },
};
</script>

Upvotes: 2

David_
David_

Reputation: 41

A solution I'd recommend, without modifying too much of your fiddle code, only requires a simple tweak:

To quote a snippet of the Vue.js v2 documentation;

In-template expressions are very convenient, but they are meant for simple operations. Putting too much logic in your templates can make them bloated and hard to maintain.

As it applies to this very case, (assuming the value/state of the image data property isn't likely to change), using a computed property will keep your template cleaner and more maintainable. See refactor --

<!-- HTML -->
<div id="app"></div>

// JS
var template = "<div class=\"circular\" v-bind:style=\"imageUrl\"></div>";

var el = document.querySelector("#app");
var data = {
    image: "http://1.bp.blogspot.com/-8PfnHfgrH4I/TylX2v8pTMI/AAAAAAAAJJ4/TICBoSEI57o/s1600/search_by_image_image.png"
};
new Vue({
    el: el,
    replace: false,
    template: template,
    data: data,
    computed: {
        imageUrl: function() {
            return {'background-image': `url(${this.image})`}
        }
    }
})

Upvotes: 2

devzakir
devzakir

Reputation: 407

I tried @david answer, and it didn't fix my issue. after a lot of hassle, I made a method and return the image with style string.

HTML Code

<div v-for="slide in loadSliderImages" :key="slide.id">
    <div v-else :style="bannerBgImage(slide.banner)"></div>
</div>

Method

bannerBgImage(image){
    return `background-image: url(${image})`;
},

Upvotes: 8

Sagar Davara
Sagar Davara

Reputation: 454

the easiest wat to add background image by style tag in vuejs is

<style>
.somediv {
 background-image: url('~@/image-path')
}
</style>

you need to add `~` before source alias

Upvotes: 1

Ronald Coarite
Ronald Coarite

Reputation: 4746

I use the VUE options (~@/)

I defined a class

<template>
   <v-container class="bgExampleClass" fuild>
      <!-- Content-->
   </v-container>
</template>
<script></script>
<style>
  .bgExampleClass{
    background-image: url('~@/assets/imgs/backgroundExample.jpg');
  }
</style>

Upvotes: 4

AJB
AJB

Reputation: 7590

Try encodeURI()

The issue I had was due to special chars and/or whitespace in the URL I was attempting to use.

So I had to change this:

:style="{ backgroundImage : 'url(' + item.media.url + ')' }"

To this:

:style="{ backgroundImage : 'url(' + encodeURI(item.media.url) + ')' }"

Upvotes: 4

Nisharg Shah
Nisharg Shah

Reputation: 19662

I searched in this post but no one posted require with dynamic filename that's why I am posting it.

:style="{ backgroundImage: `url(${require('@/assets/' + banner.image)})` }"

Upvotes: 12

Hafez Divandari
Hafez Divandari

Reputation: 9069

I had to add .default after require for this to work:

:style="{ backgroundImage: `url(${require('@/media/bg-1.jpg').default})` }"

Upvotes: 0

Liang
Liang

Reputation: 155

Based on my knowledge, if you put your image folder in your public folder, you can just do the following:

   <div :style="{backgroundImage: `url(${project.imagePath})`}"></div>

If you put your images in the src/assets/, you need to use require. Like this:

   <div :style="{backgroundImage: 'url('+require('@/assets/'+project.image)+')'}">. 
   </div>

One important thing is that you cannot use an expression that contains the full URL like this project.image = '@/assets/image.png'. You need to hardcode the '@assets/' part. That was what I've found. I think the reason is that in Webpack, a context is created if your require contains expressions, so the exact module is not known on compile time. Instead, it will search for everything in the @/assets folder. More info could be found here. Here is another doc explains how the Vue loader treats the link in single file components.

Upvotes: 3

Mooncake
Mooncake

Reputation: 1552

Another solution:

<template>
  <div :style="cssProps"></div>
</template>

<script>
  export default {
    data() {
      return {
        cssProps: {
          backgroundImage: `url(${require('@/assets/path/to/your/img.jpg')})`
        }
      }
    }
  }
</script>

What makes this solution more convenient? Firstly, it's cleaner. And then, if you're using Vue CLI (I assume you do), you can load it with webpack.

Note: don't forget that require() is always relative to the current file's path.

Upvotes: 35

bmatovu
bmatovu

Reputation: 4074

The accepted answer didn't seem to solve the problem for me, but this did

Ensure your backgroundImage declarations are wrapped in url( and quotes so the style works correctly, no matter the file name.

ES2015 Style:

<div :style="{ backgroundImage: `url('${image}')` }"></div>

Or without ES2015:

<div :style="{ backgroundImage: 'url(\'' + image + '\')' }"></div>

Source: vuejs/vue-loader issue #646

Upvotes: 4

chougle saud
chougle saud

Reputation: 297

<div :style="{ backgroundImage: `url(${post.image})` }">

there are multiple ways but i found template string easy and simple

Upvotes: 22

mohammad nazari
mohammad nazari

Reputation: 969

<div :style="{'background-image': 'url(' + require('./assets/media/img.jpg') + ')'}"></div>

Upvotes: 53

coder618
coder618

Reputation: 1014

For single repeated component this technic work for me

<div class="img-section" :style=img_section_style >

computed: {
            img_section_style: function(){
                var bgImg= this.post_data.fet_img
                return {
                    "color": "red",
                    "border" : "5px solid ",
                    "background": 'url('+bgImg+')'
                }
            },
}

Upvotes: 4

William
William

Reputation: 8067

I experienced an issue where background images with spaces in the filename where causing the style to not be applied. To correct this I had to ensure the string path was encapsulated in single quotes.

Note the escaped \' in my example below.

<div :style="{
    height: '100px',
    backgroundColor: '#323232',
    backgroundImage: 'url(\'' + event.image + '\')',
    backgroundPosition: 'center center',
    backgroundSize: 'cover'
    }">
</div>

Upvotes: 3

Abdelsalam Shahlol
Abdelsalam Shahlol

Reputation: 1769

Binding background image style using a dynamic value from v-for loop could be done like this. 

<div v-for="i in items" :key="n" 
  :style="{backgroundImage: 'url('+require('./assets/cars/'+i.src+'.jpg')+')'}">
</div>

Upvotes: 3

David K. Hess
David K. Hess

Reputation: 17246

The issue is that the value for backgroundImage needs to be a string like this:

<div class="circular" v-bind:style="{ backgroundImage: 'url(' + image + ')' }"></div>

Here's a simplified fiddle that's working: https://jsfiddle.net/89af0se9/1/

Re: the comment below about kebab-case, this is how you can do that:

<div class="circular" v-bind:style="{ 'background-image': 'url(' + image + ')' }"></div>

In other words, the value for v-bind:style is just a plain Javascript object and follows the same rules.

UPDATE: One other note about why you may have trouble getting this to work.

You should make sure your image value is quoted so that the end resulting string is:

url('some/url/path/to/image.jpeg')

Otherwise, if your image URL has special characters in it (such as whitespace or parentheses) the browser may not apply it properly. In Javascript, the assignment would look like:

this.image = "'some/url/path/to/image.jpeg'"

or

this.image = "'" + myUrl + "'"

Technically, this could be done in the template, but the escaping required to keep it valid HTML isn't worth it.

More info here: Is quoting the value of url() really necessary?

Upvotes: 325

Related Questions