@iamproperty/components 2.7.9 → 3.0.0

package/src/components/Testimonial/README.md

@@ -1,26 +1,26 @@
-### Usage
-
-```
-<Testimonial :items="items">
-  <a href="/buying-stories" class="btn">Buying stories</a>
-  <a href="/selling-stories" class="btn">Selling stories</a>
-</Testimonial>
-```
-
-### Properties
-
-| Option | Type | Default Value | Description |
-| ------ | ---- | ------------- | ----------- |
-| title  | String | What our customers think… | Used for the heading of the component |
-| items  | Array | - | Testimonial data passed |
-| - item.class | String | - | Optional, this should be used to define the largest testimonial by setting it to 'largest' |
-| - item.cite | String | - | The person who made the quote |
-| - item.quote | HTML | - | The quote content |
-| - item.image | Image | - | The image that sits to the left of the quote. |
-
-
-### Slots
-
-| Option | Default Value | Description |
-| ------ | ------------- | ----------- |
+### Usage
+
+```
+<Testimonial :items="items">
+  <a href="/buying-stories" class="btn">Buying stories</a>
+  <a href="/selling-stories" class="btn">Selling stories</a>
+</Testimonial>
+```
+
+### Properties
+
+| Option | Type | Default Value | Description |
+| ------ | ---- | ------------- | ----------- |
+| title  | String | What our customers think… | Used for the heading of the component |
+| items  | Array | - | Testimonial data passed |
+| - item.class | String | - | Optional, this should be used to define the largest testimonial by setting it to 'largest' |
+| - item.cite | String | - | The person who made the quote |
+| - item.quote | HTML | - | The quote content |
+| - item.image | Image | - | The image that sits to the left of the quote. |
+
+
+### Slots
+
+| Option | Default Value | Description |
+| ------ | ------------- | ----------- |
 | default | - | Will display underneath the quotes |

package/src/components/Testimonial/Testimonial.spec.js

@@ -0,0 +1,57 @@
+import { shallowMount } from '@vue/test-utils'
+import Header from './Testimonial.vue'
+
+describe('Testimonial component', () => {
+
+  const test = shallowMount(Header, {
+    propsData: {
+      items: [
+        {
+          cite: 'Name goes here',
+          quote: `<p>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.</p>`,
+          image: '/img/src/img.png'
+        },
+        {
+          cite: 'Name goes here 2',
+          quote: `<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English.</p>`,
+          image: '/img/src/img.png'
+        },
+        {
+          cite: 'Name goes here 3',
+          quote: `<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout.</p><p>There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable.</p>`,
+          class: 'largest',
+          image: '/img/src/img.png'
+        }
+      ]
+    },
+    slots: {
+      default: '<p>Hello</p>'
+    }
+  })
+
+  it('renders the testimonials title', () => {
+    expect(test.html()).toContain('<h2>What our customers think…</h2>')
+  })
+
+  it('renders the content after the quotes', () => {
+    expect(test.html()).toContain('<p>Hello</p>')
+  })
+
+  it('renders the correct number of blockquotes', () => {
+
+    expect(test.findAll('blockquote').length).toBe(3)
+  })
+
+  it('adds the largest class on the defined blockquote', () => {
+
+    const quotes = test.findAll('blockquote');
+    const largestQuote = quotes.at(2)
+
+    expect(largestQuote.classes()).toContain('largest')
+  })
+
+  it('adds the testimonial--multi class on load', () => {
+
+    expect(test.classes()).toContain('testimonial--multi')
+  })
+})

package/src/components/Testimonial/Testimonial.vue

@@ -1,60 +1,60 @@
-<template>
-  <div class="container testimonial mb-5" data-show="1" ref="wrapper">
-    <div :class="'bg-'+background">
-      <div class="row">
-        <div class="col-md-5 position-relative">
-          <div class="testimonial__images">
-            <img v-for="(value,index) in items" :key="index" :src="value.image ? value.image : 'data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw=='" alt="" :class="'h-100 w-100 object-cover' + (value.image ? '' : ' opacity-0')" />
-          </div>
-          <div class="testimonial__controls">
-            <button data-go="0" disabled class="btn-prev">Previous</button>
-            <button data-go="2" class="btn-next">Next</button>
-          </div>
-        </div>
-        <div class="col-md-7">
-          <h2>What our customers think…</h2>
-          <div class="testimonial__content">
-
-            <blockquote v-for="(value,index) in items" :key="index" :class="value.class">
-              <div v-html="value.quote"></div>
-              <cite v-html="value.cite"></cite>
-            </blockquote>
-          </div>
-          <div class="testimonial__after">
-            <slot></slot>
-          </div>
-        </div>
-      </div>
-      <span class="circle circle--dots d-none d-md-block"></span>
-    </div>
-  </div>
-</template>
-
-<style lang="scss">
-@import "../../../assets/sass/components/testimonial.scss";
-</style>
-
-<script>
-import testimonial from '../../../assets/js/modules/testimonial.js'
-
-
-export default {
-  name: 'Testimonial',
-  props: {
-    items: {
-      type: Array,
-      required: true
-    },
-    background: {
-      type: String,
-      default: 'light',
-      required: false
-    }
-  },
-  mounted(){
-
-    testimonial(this.$refs.wrapper);
-
-  }
-}
-</script>
+<template>
+  <div class="container testimonial mb-5" data-show="1" ref="wrapper">
+    <div :class="'bg-'+background">
+      <div class="row">
+        <div class="col-md-5 position-relative">
+          <div class="testimonial__images">
+            <img v-for="(value,index) in items" :key="index" :src="value.image ? value.image : 'data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw=='" alt="" :class="'h-100 w-100 object-cover' + (value.image ? '' : ' opacity-0')" />
+          </div>
+          <div class="testimonial__controls">
+            <button data-go="0" disabled class="btn-prev">Previous</button>
+            <button data-go="2" class="btn-next">Next</button>
+          </div>
+        </div>
+        <div class="col-md-7">
+          <h2>What our customers think…</h2>
+          <div class="testimonial__content">
+
+            <blockquote v-for="(value,index) in items" :key="index" :class="value.class">
+              <div v-html="value.quote"></div>
+              <cite v-html="value.cite"></cite>
+            </blockquote>
+          </div>
+          <div class="testimonial__after">
+            <slot></slot>
+          </div>
+        </div>
+      </div>
+      <span class="circle circle--dots d-none d-md-block"></span>
+    </div>
+  </div>
+</template>
+
+<style lang="scss">
+@import "../../../assets/sass/components/testimonial.scss";
+</style>
+
+<script>
+import testimonial from '../../../assets/js/modules/testimonial.js'
+
+
+export default {
+  name: 'Testimonial',
+  props: {
+    items: {
+      type: Array,
+      required: true
+    },
+    background: {
+      type: String,
+      default: 'light',
+      required: false
+    }
+  },
+  mounted(){
+
+    testimonial(this.$refs.wrapper);
+
+  }
+}
+</script>

package/src/components/Timeline/README.md

@@ -1,18 +1,18 @@
-<p class="note">The Timeline component represents an individual item within the timeline and not the full timeline itself. These Vue components need to be inside of a div with the class of 'timeline__container'.</p>
-
-### Usage
-
-```
-<div class="timeline__container container">
-  <Timeline :image="require('../../assets/shutterstock_1229155495.webp')">
-    <h2>01 Search</h2>
-    <p>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.</p>
-  </Timeline>
-</div>
-```
-
-### Properties
-
-| Option | Type | Default Value | Description |
-| ------ | ---- | ------------- | ----------- |
-| image | String | - | Optional image url to display in the background |
+<p class="note">The Timeline component represents an individual item within the timeline and not the full timeline itself. These Vue components need to be inside of a div with the class of 'timeline__container'.</p>
+
+### Usage
+
+```
+<div class="timeline__container container">
+  <Timeline :image="require('../../assets/shutterstock_1229155495.webp')">
+    <h2>01 Search</h2>
+    <p>Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.</p>
+  </Timeline>
+</div>
+```
+
+### Properties
+
+| Option | Type | Default Value | Description |
+| ------ | ---- | ------------- | ----------- |
+| image | String | - | Optional image url to display in the background |

package/src/components/Timeline/Timeline.spec.js

@@ -0,0 +1,17 @@
+import { shallowMount } from '@vue/test-utils'
+import Header from './Timeline.vue'
+
+describe('Timeline component', () => {
+
+  const test = shallowMount(Header, {
+    propsData: {
+    },
+    slots: {
+      default: '<p>Hello</p>'
+    }
+  })
+
+  it('renders the content after', () => {
+    expect(test.html()).toContain('<p>Hello</p>')
+  })
+})

package/src/components/Timeline/Timeline.vue

@@ -1,24 +1,24 @@
-<template>
-  <div class="timeline">
-    <div class="timeline__content">
-      <slot></slot>
-    </div>
-    <img v-if="image" :src="image" alt="" />
-  </div>
-</template>
-
-<style lang="scss">
-@import "../../../assets/sass/components/timeline.scss";
-</style>
-
-<script>
-export default {
-  name: 'Timeline',
-  props: {
-    image: {
-      type: String,
-      required: false
-    }
-  }
-}
-</script>
+<template>
+  <div class="timeline">
+    <div class="timeline__content">
+      <slot></slot>
+    </div>
+    <img v-if="image" :src="image" alt="" />
+  </div>
+</template>
+
+<style lang="scss">
+@import "../../../assets/sass/components/timeline.scss";
+</style>
+
+<script>
+export default {
+  name: 'Timeline',
+  props: {
+    image: {
+      type: String,
+      required: false
+    }
+  }
+}
+</script>

package/src/elements/Card/Card.vue

@@ -1,113 +1,113 @@
-<template>
-  <a :href="link" :class="'card'+(type?' card--'+type:'')" :title="'Find out more: '+title+(subtitle ? ' - '+subtitle:'')">
-    <div class="card-header__wrapper" v-if="image">
-      <img :src="image" alt="" loading="lazy" class="card-image" />
-      <div class="card-header">
-        <span class="badge bg-primary p-2 me-2" v-if="this.details && this.details.status" v-html="cardStatus()"></span>
-        <span class="badge bg-black bg-opacity-50 p-2 align-self-end" v-if="this.details && (this.details.images || this.details.videos)" v-html="cardMedia()"></span>
-      </div>
-      <img v-if="details && details.logo" :src="details.logo" alt="" loading="lazy" class="card-logo" />
-    </div>
-    <div class="card-body" v-html="cardContent()"></div>
-    <div class="card-footer" v-if="hidectatext == false">
-      <span :class="`${btntype == 'link' ? `link` : `btn btn-${btntype}`} mb-0`">{{ctatext}}<span class="visually-hidden"> about {{title}}</span></span>
-    </div>
-  </a>
-</template>
-
-<style lang="scss">
-@import "../../../assets/sass/elements/card.scss";
-</style>
-
-<script>
-export default {
-  name: 'Card',
-  props: {
-    link: {
-      type: String,
-      required: false
-    },
-    titleclass: {
-      type: String,
-      required: false,
-      default: 'h4'
-    },
-    title: {
-      type: String,
-      required: false
-    },
-    subtitle: {
-      type: String,
-      required: false
-    },
-    content: {
-      type: String,
-      required: false
-    },
-    type: {
-      type: String,
-      required: false
-    },
-    btntype: {
-      type: String,
-      required: false,
-      default: 'secondary'
-    },
-    ctatext: {
-      type: String,
-      required: false,
-      default: 'Find out more'
-    },
-    hidectatext: {
-      type: Boolean,
-      required: false,
-      default: false
-    },
-    image: {
-      type: String,
-      required: false
-    },
-    details: {
-      type: Object,
-      required: false
-    }
-  },
-  computed: {
-    cardStatus (){
-      return () => {
-        return this.details && this.details.status ? `${this.details.status == 'Live now' ? '<span class="text-danger lh-0 fs-1 align-middle">&#8226;</span>&nbsp;&nbsp;': ''}${this.details.status}`: '';
-      }
-    },
-    cardMedia (){
-      return () => {
-        return `<svg xmlns='http://www.w3.org/2000/svg' width='30' height='28' viewBox='0 0 30 28' class="icon text-white"><title>Images </title><path d='M15 10.5c2.484 0 4.5 2.016 4.5 4.5s-2.016 4.5-4.5 4.5-4.5-2.016-4.5-4.5 2.016-4.5 4.5-4.5zM26 4c2.203 0 4 1.797 4 4v14c0 2.203-1.797 4-4 4h-22c-2.203 0-4-1.797-4-4v-14c0-2.203 1.797-4 4-4h3.5l0.797-2.125c0.391-1.031 1.609-1.875 2.703-1.875h8c1.094 0 2.312 0.844 2.703 1.875l0.797 2.125h3.5zM15 22c3.859 0 7-3.141 7-7s-3.141-7-7-7-7 3.141-7 7 3.141 7 7 7z'></path></svg> ${this.details && this.details.images ? `${this.details.images}`: `0`}&nbsp;&nbsp;|&nbsp;&nbsp;<svg xmlns='http://www.w3.org/2000/svg' width='30' height='28' viewBox='0 0 28 28' class="icon text-white ms-0"><title>Videos </title><path d="M11.109 17.625l7.562-3.906-7.562-3.953v7.859zM14 4.156c5.891 0 9.797 0.281 9.797 0.281 0.547 0.063 1.75 0.063 2.812 1.188 0 0 0.859 0.844 1.109 2.781 0.297 2.266 0.281 4.531 0.281 4.531v2.125s0.016 2.266-0.281 4.531c-0.25 1.922-1.109 2.781-1.109 2.781-1.062 1.109-2.266 1.109-2.812 1.172 0 0-3.906 0.297-9.797 0.297v0c-7.281-0.063-9.516-0.281-9.516-0.281-0.625-0.109-2.031-0.078-3.094-1.188 0 0-0.859-0.859-1.109-2.781-0.297-2.266-0.281-4.531-0.281-4.531v-2.125s-0.016-2.266 0.281-4.531c0.25-1.937 1.109-2.781 1.109-2.781 1.062-1.125 2.266-1.125 2.812-1.188 0 0 3.906-0.281 9.797-0.281v0z"></path></svg> ${this.details && this.details.videos ? `${this.details.videos}`: `0`}`;
-      }
-    },
-    cardContent () {
-      return () => {
-        const tagClass = function(tag){
-          switch(tag) {
-            case 'Modern method':
-              return 'bg-secondary text-primary'
-            case 'Freehold':
-              return 'bg-light text-dark'
-            default:
-              return 'bg-body text-white'
-          }
-        }
-
-        const tags = this.details && this.details.tags ? this.details.tags.map(tag =>  `<span class="badge rounded-pill py-2 px-3 mb-3 me-2 ${tagClass(tag)}">${tag}</span>` ).join(""): '';
-        const title = this.title ? `<span class="card-title d-block ${this.titleclass}">${this.title}${this.subtitle ? ` <span class="d-block fw-normal font-body text-body small">${this.subtitle}</span>` : ''}</span>` : ``;
-
-        const details = `
-        ${this.details && this.details.guideprice ? `<span class="d-block h6 text-dark mb-1">Price guide: ${this.details.guideprice}</span>` : ``}
-        ${this.details && this.details.auctiontime ? `<span class="d-block h6 text-primary mb-4">Auction time left: ${this.details.auctiontime}</span>` : ``}
-        ${this.details && this.details.readtime ? `<span class="d-block h6 text-primary mb-4"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="22" height="23" viewBox="0 0 22 23" class="icon ms-0 me-2"><path d="M11 1.63c-5.176 0-9.37 4.194-9.37 9.37 0 5.176 4.194 9.37 9.37 9.37 5.176 0 9.37-4.194 9.37-9.37 0-5.176-4.194-9.37-9.37-9.37M11 0c6.075 0 11 4.925 11 11s-4.925 11-11 11S0 17.075 0 11 4.925 0 11 0" fill="var(--colour-secondary)" /><path d="M9.62 5.39c0-.473.368-.856.82-.856.454 0 .822.383.822.855v6.27l3.25 1.898c.395.23.536.75.314 1.16-.22.412-.72.558-1.115.328l-4.09-2.39V5.39z" fill="var(--colour-primary)"/></svg>${this.details.readtime}</span>` : ``}
-        `;
-
-        return `${tags}${title}${details}${this.content}`;
-      }
-    }
-  }
-}
-</script>
+<template>
+  <a :href="link" :class="'card'+(type?' card--'+type:'')" :title="'Find out more: '+title+(subtitle ? ' - '+subtitle:'')">
+    <div class="card-header__wrapper" v-if="image">
+      <img :src="image" alt="" loading="lazy" class="card-image" />
+      <div class="card-header">
+        <span class="badge bg-primary p-2 me-2" v-if="this.details && this.details.status" v-html="cardStatus()"></span>
+        <span class="badge bg-black bg-opacity-50 p-2 align-self-end" v-if="this.details && (this.details.images || this.details.videos)" v-html="cardMedia()"></span>
+      </div>
+      <img v-if="details && details.logo" :src="details.logo" alt="" loading="lazy" class="card-logo" />
+    </div>
+    <div class="card-body" v-html="cardContent()"></div>
+    <div class="card-footer" v-if="hidectatext == false">
+      <span :class="`${btntype == 'link' ? `link` : `btn btn-${btntype}`} mb-0`">{{ctatext}}<span class="visually-hidden"> about {{title}}</span></span>
+    </div>
+  </a>
+</template>
+
+<style lang="scss">
+@import "../../../assets/sass/elements/card.scss";
+</style>
+
+<script>
+export default {
+  name: 'Card',
+  props: {
+    link: {
+      type: String,
+      required: false
+    },
+    titleclass: {
+      type: String,
+      required: false,
+      default: 'h4'
+    },
+    title: {
+      type: String,
+      required: false
+    },
+    subtitle: {
+      type: String,
+      required: false
+    },
+    content: {
+      type: String,
+      required: false
+    },
+    type: {
+      type: String,
+      required: false
+    },
+    btntype: {
+      type: String,
+      required: false,
+      default: 'secondary'
+    },
+    ctatext: {
+      type: String,
+      required: false,
+      default: 'Find out more'
+    },
+    hidectatext: {
+      type: Boolean,
+      required: false,
+      default: false
+    },
+    image: {
+      type: String,
+      required: false
+    },
+    details: {
+      type: Object,
+      required: false
+    }
+  },
+  computed: {
+    cardStatus (){
+      return () => {
+        return this.details && this.details.status ? `${this.details.status == 'Live now' ? '<span class="text-danger lh-0 fs-1 align-middle">&#8226;</span>&nbsp;&nbsp;': ''}${this.details.status}`: '';
+      }
+    },
+    cardMedia (){
+      return () => {
+        return `<svg xmlns='http://www.w3.org/2000/svg' width='30' height='28' viewBox='0 0 30 28' class="icon text-white"><title>Images </title><path d='M15 10.5c2.484 0 4.5 2.016 4.5 4.5s-2.016 4.5-4.5 4.5-4.5-2.016-4.5-4.5 2.016-4.5 4.5-4.5zM26 4c2.203 0 4 1.797 4 4v14c0 2.203-1.797 4-4 4h-22c-2.203 0-4-1.797-4-4v-14c0-2.203 1.797-4 4-4h3.5l0.797-2.125c0.391-1.031 1.609-1.875 2.703-1.875h8c1.094 0 2.312 0.844 2.703 1.875l0.797 2.125h3.5zM15 22c3.859 0 7-3.141 7-7s-3.141-7-7-7-7 3.141-7 7 3.141 7 7 7z'></path></svg> ${this.details && this.details.images ? `${this.details.images}`: `0`}&nbsp;&nbsp;|&nbsp;&nbsp;<svg xmlns='http://www.w3.org/2000/svg' width='30' height='28' viewBox='0 0 28 28' class="icon text-white ms-0"><title>Videos </title><path d="M11.109 17.625l7.562-3.906-7.562-3.953v7.859zM14 4.156c5.891 0 9.797 0.281 9.797 0.281 0.547 0.063 1.75 0.063 2.812 1.188 0 0 0.859 0.844 1.109 2.781 0.297 2.266 0.281 4.531 0.281 4.531v2.125s0.016 2.266-0.281 4.531c-0.25 1.922-1.109 2.781-1.109 2.781-1.062 1.109-2.266 1.109-2.812 1.172 0 0-3.906 0.297-9.797 0.297v0c-7.281-0.063-9.516-0.281-9.516-0.281-0.625-0.109-2.031-0.078-3.094-1.188 0 0-0.859-0.859-1.109-2.781-0.297-2.266-0.281-4.531-0.281-4.531v-2.125s-0.016-2.266 0.281-4.531c0.25-1.937 1.109-2.781 1.109-2.781 1.062-1.125 2.266-1.125 2.812-1.188 0 0 3.906-0.281 9.797-0.281v0z"></path></svg> ${this.details && this.details.videos ? `${this.details.videos}`: `0`}`;
+      }
+    },
+    cardContent () {
+      return () => {
+        const tagClass = function(tag){
+          switch(tag) {
+            case 'Modern method':
+              return 'bg-secondary text-primary'
+            case 'Freehold':
+              return 'bg-light text-dark'
+            default:
+              return 'bg-body text-white'
+          }
+        }
+
+        const tags = this.details && this.details.tags ? this.details.tags.map(tag =>  `<span class="badge rounded-pill py-2 px-3 mb-3 me-2 ${tagClass(tag)}">${tag}</span>` ).join(""): '';
+        const title = this.title ? `<span class="card-title d-block ${this.titleclass}">${this.title}${this.subtitle ? ` <span class="d-block fw-normal font-body text-body small">${this.subtitle}</span>` : ''}</span>` : ``;
+
+        const details = `
+        ${this.details && this.details.guideprice ? `<span class="d-block h6 text-dark mb-1">Price guide: ${this.details.guideprice}</span>` : ``}
+        ${this.details && this.details.auctiontime ? `<span class="d-block h6 text-primary mb-4">Auction time left: ${this.details.auctiontime}</span>` : ``}
+        ${this.details && this.details.readtime ? `<span class="d-block h6 text-primary mb-4"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="22" height="23" viewBox="0 0 22 23" class="icon ms-0 me-2"><path d="M11 1.63c-5.176 0-9.37 4.194-9.37 9.37 0 5.176 4.194 9.37 9.37 9.37 5.176 0 9.37-4.194 9.37-9.37 0-5.176-4.194-9.37-9.37-9.37M11 0c6.075 0 11 4.925 11 11s-4.925 11-11 11S0 17.075 0 11 4.925 0 11 0" fill="var(--colour-secondary)" /><path d="M9.62 5.39c0-.473.368-.856.82-.856.454 0 .822.383.822.855v6.27l3.25 1.898c.395.23.536.75.314 1.16-.22.412-.72.558-1.115.328l-4.09-2.39V5.39z" fill="var(--colour-primary)"/></svg>${this.details.readtime}</span>` : ``}
+        `;
+
+        return `${tags}${title}${details}${this.content}`;
+      }
+    }
+  }
+}
+</script>

package/src/elements/Card/README.md

@@ -1,24 +1,24 @@
-### Usage
-
-```
-<Card :title="value.title" :content="value.content" :link="value.link"></Card>
-```
-
-### Properties
-
-| Option | Type | Default Value | Description |
-| ------ | ---- | ------------- | ----------- |
-| title | String | - | Used for the card heading |
-| titleclass | String | h2 | Update the class of the title from being a h2 |
-| subtitle | String | - | Optional sub heading |
-| content | HTML | - | Card content |
-| link | String | - | Card link |
-| type | String | - | Change the type of card (simple,quick)|
-| btntype | String | secondary | Change the type of button at the bottom of the card (primary,secondary,tertairy, link) |
-| ctatext | String | Find out more | Update the cta text within the button at the bottom of the card |
-| details | Object | - | Build up the card content with pre-defined bits of data |
-| - detail.tags | Array of strings | - | Add tags above the card header |
-| - detail.guideprice | String | - | Property guide price |
-| - detail.auctiontime | String | - | Auction time left |
-| - detail.readtime | String | - | How long it will take to read |
-| - detail.status | String | - | Display a status badge at the top of the card |
+### Usage
+
+```
+<Card :title="value.title" :content="value.content" :link="value.link"></Card>
+```
+
+### Properties
+
+| Option | Type | Default Value | Description |
+| ------ | ---- | ------------- | ----------- |
+| title | String | - | Used for the card heading |
+| titleclass | String | h2 | Update the class of the title from being a h2 |
+| subtitle | String | - | Optional sub heading |
+| content | HTML | - | Card content |
+| link | String | - | Card link |
+| type | String | - | Change the type of card (simple,quick)|
+| btntype | String | secondary | Change the type of button at the bottom of the card (primary,secondary,tertairy, link) |
+| ctatext | String | Find out more | Update the cta text within the button at the bottom of the card |
+| details | Object | - | Build up the card content with pre-defined bits of data |
+| - detail.tags | Array of strings | - | Add tags above the card header |
+| - detail.guideprice | String | - | Property guide price |
+| - detail.auctiontime | String | - | Auction time left |
+| - detail.readtime | String | - | How long it will take to read |
+| - detail.status | String | - | Display a status badge at the top of the card |