Vue dynamic background image inline component

Question

I'm building a banner with Vue that needs to have a dynamic background, however, it doesn't seem to be working. Not sure what I'm doing wrong. I've tried a few other ways and it works if I do an image tag something like

<img :src="require(`@/assets/images/${backgroundImage}`)" />

But obviously this needs to be an inline background image.

Code:

component

<template>
  <div
    class="w-full h-64 bg-auto bg-no-repeat bg-center lg:bg-cover relative"
    :style="{ backgroundImage: url(require('@/assets/images/' + backgroundImage))}"
  >
    <div class="w-full h-full flex flex-col justify-center items-center text-white px-6">
      <div class="hero-text rounded text-center py-8 px-12">
        <p class="text-base lg:text-md uppercase font-medium">{{ smallLeadingText }}</p>
        <h1 class="text-xl md:text-3xl lg:text-5xl uppercase font-bold">{{ mainText }}</h1>
        <p class="text-base lg:text-md">{{ subText }}</p>
      </div>
    </div>
  </div>
</template>

<script>
export default {
  name: "PageHero",
  props: {
    backgroundImage: String,
    smallLeadingText: {
      type: String,
      required: false
    },
    mainText: {
      type: String,
      required: true
    },
    subText: {
      type: String,
      required: false
    }
  }
};
</script>

View

<PageHero
  backgroundImage="mc-background.png "
  smallLeadingText="Powerful, secure &amp; affordable"
  mainText="Minecraft hosting"
  subText="Plans suitable for all budgets"
/>

Would you be able to give an example @Phil? If you don't mind — Ben Bagley
– Ben Bagley, Commented Mar 26, 2020 at 1:16
So I tried your code @Phil but it removes the code gyazo.com/09f006c0bdef02156051924a9f30037b if I remove the :style the code shows without the background — Ben Bagley
– Ben Bagley, Commented Mar 26, 2020 at 1:18
I may have messed something up in the comment so I've moved it to an answer below. I'd definitely preference using computed properties instead of doing everything inline — Phil
– Phil, Commented Mar 26, 2020 at 1:22
FYI, I've always found it works best to use kebab-cased attribute names when passing props, ie background-image="mc-background.png". See vuejs.org/v2/guide/… and vuejs.org/v2/style-guide/#Prop-name-casing-strongly-recommended — Phil
– Phil, Commented Mar 26, 2020 at 1:56

Phil · Accepted Answer · 2020-03-26 01:51:59Z

9

Looks like you've just got some syntax errors in your style attribute around string quoting. Try

<div :style="{ backgroundImage: `url(${require('@/assets/images/' + backgroundImage)})` }">

Might be easier to create some computed properties to resolve everything though

computed: {
  bgImage () {
    return require('@/assets/images/' + this.backgroundImage)
  },
  inlineStyle () {
    return {
      backgroundImage: `url(${this.bgImage})` 
    }
  }
}

and

<div :style="inlineStyle">

Demo ~ https://codesandbox.io/s/crimson-sky-ehn9r

edited Mar 26, 2020 at 1:51

answered Mar 26, 2020 at 1:16

Phil

166k25 gold badges265 silver badges269 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Ben Bagley Over a year ago

So I tried your code but it removes the code gyazo.com/09f006c0bdef02156051924a9f30037b if I remove the :style the code shows without the background even with the computed route.

Ben Bagley Over a year ago

Same issue for both examples just shows the component as commented <---> and doesn't actually show with the style bind.

Phil Over a year ago

@debugabug works fine for me. I've added a demo link

Ben Bagley Over a year ago

Hey, here is a small video of what is happening, not sure why as everything is correct given the example link. i.gyazo.com/91d584adb32ef0f148e1a13397b3c1d6.mp4

Phil Over a year ago

@debugabug There's three errors in your browser console. What are they?

|

user19858571 · Accepted Answer · 2023-05-06 06:33:42Z

0

Point 1: Syntax

While the other solution does not work for me, this does:

<div :style="{ backgroundImage: `url(${'src/assets/images/' + backgroundImage})`}"></div>

Of course, you need the height property to display the image.

This solution does not include "require", which will save you the error of "require" not defined.

Point 2: Path

You can go to the browser's console, Network tab, and check if the image actually gets loaded. The path may be incorrect, for example:

'../assets/images/'

and

'@/assets/images/'

did not work for me, but this:

'src/assets/images'

and this:

src/images

did, depending on the project. I have not looked into why 'assets' was skipped for some projects and not others, but for now you can try these options.

edited May 6, 2023 at 6:33

answered Apr 25, 2023 at 14:34

user19858571

711 silver badge6 bronze badges

Collectives™ on Stack Overflow

Vue dynamic background image inline component

2 Answers 2

6 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

6 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related