Merge pull request #446 from chakra-ui/fix/img-src-attr

fix: img src attr

Author: codebender828

.changeset/curvy-squids-doubt.md

@@ -0,0 +1,5 @@
+---
+'@chakra-ui/vue': patch
+---
+
+Fixes CImage src attribute bug

.codesandbox/ci.json

@@ -0,0 +1,10 @@
+{
+  "installCommand": "csb:install",
+  "buildCommand": "build",
+  "packages": [
+    "packages/chakra-ui-core",
+    "packages/chakra-ui-nuxt"
+  ],
+  "sandboxes": ["chakra-ui-vue-0x-starter-template-2sy0g", "chakra-ui-nuxt-demo-f8tq4"],
+  "node": "14"
+}

.gitignore

@@ -37,4 +37,5 @@ config/.env
 packages/chakra-ui-nuxt/.github
 packages/chakra-ui-docs/static/sw.js
 website/static/sw.js
-.npmrc
+.npmrc
+**/static/sw.js

.storybook/assets/chakra.png

@@ -15,6 +15,10 @@ module.exports = async ({ config, mode }) => {
       'sass-loader'
     ],
   });
+  config.resolve.alias = {
+    ...config.resolve.alias,
+    "@/": path.resolve(__dirname, "./"),
+  };
 
   // Return the altered config
   return config;

.storybook/webpack.config.js

@@ -21,6 +21,7 @@
   },
   "scripts": {
     "postinstall": "lerna link",
+    "csb:install": "yarn && yarn bootstrap",
     "bootstrap": "lerna bootstrap --use-workspaces",
     "build:dev": "yarn workspace @chakra-ui/vue run rollup --config rollup.dev.config.js",
     "build": "yarn workspace @chakra-ui/vue build",

package.json

@@ -55,8 +55,12 @@ const CImage = {
   methods: {
     loadImage (src, srcset) {
       const image = new window.Image()
-      image.srcset = srcset
-      image.src = src
+      if (srcset) {
+        image.srcset = srcset
+      }
+      if (src) {
+        image.src = src
+      }
 
       image.onload = (event) => {
         this.hasLoaded = true

packages/chakra-ui-core/src/CImage/CImage.js

@@ -8,7 +8,18 @@ storiesOf('UI | Image', module)
       <CImage
         shadow="sm"
         htmlWidth="100px"
-        src="https://bit.ly/chakra-jonathan-bakebwa"
+        src="https://bit.ly/chakra-jonathan-bakebw3a"
+        srcset="https://bit.ly/chakra-jonathan-bakebwa"
+      />
+    `
+  }))
+  .add('Webpack required image', () => ({
+    components: { CImage },
+    template: `
+      <CImage
+        shadow="sm"
+        htmlWidth="100px"
+        :src="require('@/assets/chakra.png')"
       />
     `
   }))

packages/chakra-ui-core/src/CImage/CImage.stories.js

@@ -46,9 +46,18 @@ it('fallback src works', async () => {
   })
 })
 
-it('srcset works', async () => {
-  renderComponent({ template: '<CImage alt="My Image Description" src="LOAD_SUCCESS_SRC" srcset="LOAD_SUCCESS_SRC 400w" />' })
+it('"srcset" should work and be prioritized over "src" if provided to CImage', async () => {
+  const { asFragment } = renderComponent({ template: '<CImage alt="My Image Description" src="LOAD_SUCCESS_SRC" srcset="LOAD_SUCCESS_SRC 400w" />' })
   await wait(() => {
     expect(screen.getByAltText(/My Image Description/i)).toHaveAttribute('srcset', 'LOAD_SUCCESS_SRC 400w')
+    expect(asFragment()).toMatchSnapshot()
+  })
+})
+
+it('should use src if srcset provided is undefined', async () => {
+  const { asFragment } = renderComponent({ template: '<CImage alt="My Image Description" src="LOAD_SUCCESS_SRC" srcset="LOAD_FAILURE_SRC" />' })
+  await wait(() => {
+    expect(screen.getByAltText(/My Image Description/i)).toHaveAttribute('src', 'LOAD_SUCCESS_SRC')
+    expect(asFragment()).toMatchSnapshot()
   })
 })

packages/chakra-ui-core/src/CImage/tests/CImage.test.js

@@ -1,5 +1,17 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`"srcset" should work and be prioritized over "src" if provided to CImage 1`] = `
+<DocumentFragment>
+  <img
+    alt="My Image Description"
+    class="css-0"
+    data-chakra-component="CImage"
+    src="LOAD_SUCCESS_SRC"
+    srcset="LOAD_SUCCESS_SRC 400w"
+  />
+</DocumentFragment>
+`;
+
 exports[`should render correctly 1`] = `
 <DocumentFragment>
   <img
@@ -11,3 +23,15 @@ exports[`should render correctly 1`] = `
   />
 </DocumentFragment>
 `;
+
+exports[`should use src if srcset provided is undefined 1`] = `
+<DocumentFragment>
+  <img
+    alt="My Image Description"
+    class="css-0"
+    data-chakra-component="CImage"
+    src="LOAD_SUCCESS_SRC"
+    srcset="LOAD_FAILURE_SRC"
+  />
+</DocumentFragment>
+`;