@iamproperty/components 3.1.0 → 3.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. package/README.md +141 -16
  2. package/assets/css/core.min.css +1 -1
  3. package/assets/css/core.min.css.map +1 -1
  4. package/assets/css/style.min.css +1 -1
  5. package/assets/css/style.min.css.map +1 -1
  6. package/assets/favicons/manifest.json +31 -31
  7. package/assets/js/main.js +57 -57
  8. package/assets/js/modules/accordion.js +33 -32
  9. package/assets/js/modules/alert.js +41 -57
  10. package/assets/js/modules/carousel.js +76 -102
  11. package/assets/js/modules/chart.js +151 -218
  12. package/assets/js/modules/drawer.js +10 -16
  13. package/assets/js/modules/file-upload.js +33 -48
  14. package/assets/js/modules/form.js +122 -168
  15. package/assets/js/modules/helpers.js +90 -119
  16. package/assets/js/modules/modal.js +69 -90
  17. package/assets/js/modules/nav.js +18 -28
  18. package/assets/js/modules/orderablelist.js +91 -122
  19. package/assets/js/modules/table.js +451 -585
  20. package/assets/js/modules/testimonial.js +64 -83
  21. package/assets/js/modules/youtubevideo.js +114 -145
  22. package/assets/js/scripts.bundle.js +895 -955
  23. package/assets/js/scripts.bundle.js.map +1 -1
  24. package/assets/js/scripts.bundle.min.js +3 -3
  25. package/assets/js/scripts.bundle.min.js.map +1 -1
  26. package/assets/sass/_components.scss +14 -14
  27. package/assets/sass/_corefiles.scss +40 -40
  28. package/assets/sass/_fonts.scss +16 -16
  29. package/assets/sass/_forms.scss +10 -10
  30. package/assets/sass/_func.scss +12 -12
  31. package/assets/sass/_functions/functions.scss +141 -141
  32. package/assets/sass/_functions/mixins.scss +170 -170
  33. package/assets/sass/_functions/utilities.scss +143 -143
  34. package/assets/sass/_functions/variables.scss +467 -467
  35. package/assets/sass/_print.scss +61 -61
  36. package/assets/sass/_tests/{sass.spec.js → colours.spec.js} +9 -9
  37. package/assets/sass/_tests/colours.spec.scss +44 -44
  38. package/assets/sass/_tests/func.spec.js +9 -0
  39. package/assets/sass/_tests/func.spec.scss +232 -232
  40. package/assets/sass/_tests/mixins.spec.js +9 -0
  41. package/assets/sass/_tests/mixins.spec.scss +194 -194
  42. package/assets/sass/_tests/typography.spec.js +9 -0
  43. package/assets/sass/_tests/typography.spec.scss +35 -35
  44. package/assets/sass/components/accordion.scss +197 -197
  45. package/assets/sass/components/alert.scss +98 -98
  46. package/assets/sass/{elements → components}/buttons.scss +251 -251
  47. package/assets/sass/{elements → components}/card.scss +288 -288
  48. package/assets/sass/components/cardDeck.scss +107 -107
  49. package/assets/sass/components/carousel.scss +234 -234
  50. package/assets/sass/components/charts.scss +569 -569
  51. package/assets/sass/{elements → components}/container.scss +236 -236
  52. package/assets/sass/components/drawer.scss +46 -46
  53. package/assets/sass/{elements → components}/forms.scss +261 -261
  54. package/assets/sass/components/header.scss +63 -63
  55. package/assets/sass/{elements → components}/links.scss +97 -97
  56. package/assets/sass/{elements → components}/lists.scss +159 -159
  57. package/assets/sass/components/modal.scss +136 -136
  58. package/assets/sass/components/nav.scss +960 -960
  59. package/assets/sass/{elements → components}/panel.scss +161 -161
  60. package/assets/sass/components/property-searchbar.scss +143 -143
  61. package/assets/sass/components/snapshot.scss +70 -70
  62. package/assets/sass/components/stepper.scss +164 -164
  63. package/assets/sass/{elements → components}/tables.scss +290 -290
  64. package/assets/sass/components/tabs.scss +87 -87
  65. package/assets/sass/components/testimonial.scss +132 -132
  66. package/assets/sass/components/timeline.scss +95 -95
  67. package/assets/sass/{elements → components}/tooltips.scss +84 -84
  68. package/assets/sass/core.scss +6 -6
  69. package/assets/sass/email.scss +65 -65
  70. package/assets/sass/error.scss +4 -4
  71. package/assets/sass/foundations/brand.scss +76 -72
  72. package/assets/sass/foundations/circles.scss +74 -74
  73. package/assets/sass/foundations/icons.scss +80 -80
  74. package/assets/sass/foundations/media.scss +50 -50
  75. package/assets/sass/foundations/reboot.scss +130 -130
  76. package/assets/sass/foundations/root.scss +125 -125
  77. package/assets/sass/{elements → foundations}/type.scss +136 -136
  78. package/assets/sass/main.scss +7 -7
  79. package/assets/svg/icons.svg +598 -598
  80. package/assets/svg/logo.svg +49 -43
  81. package/assets/ts/main.ts +68 -68
  82. package/assets/ts/modules/accordion.ts +44 -43
  83. package/assets/ts/modules/alert.ts +58 -0
  84. package/assets/ts/modules/carousel.ts +103 -0
  85. package/assets/ts/modules/chart.ts +219 -0
  86. package/assets/ts/modules/drawer.ts +17 -0
  87. package/assets/ts/modules/file-upload.ts +49 -0
  88. package/assets/ts/modules/form.ts +169 -0
  89. package/assets/ts/modules/helpers.ts +120 -0
  90. package/assets/ts/modules/modal.ts +91 -0
  91. package/assets/ts/modules/nav.ts +29 -0
  92. package/assets/ts/modules/orderablelist.ts +123 -0
  93. package/assets/ts/modules/table.ts +586 -0
  94. package/assets/ts/modules/testimonial.ts +84 -0
  95. package/assets/ts/modules/youtubevideo.ts +146 -0
  96. package/dist/components.es.js +493 -509
  97. package/dist/components.umd.js +15 -15
  98. package/package.json +109 -108
  99. package/src/components/Accordion/Accordion.spec.js +63 -63
  100. package/src/components/Accordion/Accordion.vue +22 -22
  101. package/src/components/Accordion/AccordionItem.vue +52 -52
  102. package/src/components/Accordion/README.md +34 -34
  103. package/src/components/Alert/Alert.spec.js +49 -49
  104. package/src/components/Alert/Alert.vue +39 -39
  105. package/src/components/Alert/README.md +28 -28
  106. package/src/components/Banner/Banner.spec.js +28 -28
  107. package/src/components/Banner/Banner.vue +38 -38
  108. package/src/components/Banner/README.md +23 -23
  109. package/src/{elements → components}/Card/Card.vue +122 -122
  110. package/src/{elements/FileUploads → components/Card}/README.md +24 -24
  111. package/src/components/CardDeck/CardDeck.spec.js +99 -99
  112. package/src/components/CardDeck/CardDeck.vue +77 -77
  113. package/src/components/CardDeck/README.md +24 -24
  114. package/src/components/Carousel/Carousel.spec.js +45 -45
  115. package/src/components/Carousel/Carousel.vue +85 -85
  116. package/src/components/Carousel/README.md +19 -19
  117. package/src/components/Chart/Chart.spec.js +201 -201
  118. package/src/components/Chart/Chart.vue +88 -88
  119. package/src/components/Chart/README.md +17 -17
  120. package/src/components/Drawer/Drawer.vue +53 -53
  121. package/src/components/Drawer/README.md +22 -22
  122. package/src/{elements → components}/FileUploads/FileUploads.vue +48 -48
  123. package/src/{elements/Card → components/FileUploads}/README.md +24 -24
  124. package/src/components/Header/Header.spec.js +33 -33
  125. package/src/components/Header/Header.vue +38 -38
  126. package/src/components/Header/README.md +27 -27
  127. package/src/{elements → components}/Input/Input.vue +272 -272
  128. package/src/{elements → components}/Input/README.md +19 -19
  129. package/src/components/Modal/Modal.spec.js +22 -22
  130. package/src/components/Modal/Modal.vue +43 -43
  131. package/src/components/Modal/README.md +19 -19
  132. package/src/components/Nav/Nav.spec.js +35 -35
  133. package/src/components/Nav/Nav.vue +215 -215
  134. package/src/components/Nav/README.md +22 -22
  135. package/src/components/NoteFeed/NoteFeed.vue +79 -79
  136. package/src/components/NoteFeed/README.md +16 -16
  137. package/src/components/PropertySearchbar/PropertySearchbar.vue +204 -204
  138. package/src/components/PropertySearchbar/README.md +25 -25
  139. package/src/components/Snapshot/README.md +20 -20
  140. package/src/components/Snapshot/Snapshot.vue +32 -32
  141. package/src/components/Stepper/README.md +32 -32
  142. package/src/components/Stepper/Step.vue +28 -28
  143. package/src/components/Stepper/Stepper.spec.js +99 -99
  144. package/src/components/Stepper/Stepper.vue +33 -33
  145. package/src/{elements → components}/Table/README.md +62 -62
  146. package/src/{elements → components}/Table/Table.spec.js +90 -90
  147. package/src/{elements → components}/Table/Table.vue +129 -129
  148. package/src/components/Tabs/README.md +27 -27
  149. package/src/components/Tabs/Tab.vue +32 -32
  150. package/src/components/Tabs/Tabs.vue +77 -77
  151. package/src/components/Testimonial/README.md +25 -25
  152. package/src/components/Testimonial/Testimonial.spec.js +57 -57
  153. package/src/components/Testimonial/Testimonial.vue +60 -60
  154. package/src/components/Timeline/README.md +18 -18
  155. package/src/components/Timeline/Timeline.spec.js +17 -17
  156. package/src/components/Timeline/Timeline.vue +24 -24
  157. package/src/foundations/Icon/Icon.spec.js +24 -24
  158. package/src/foundations/Icon/Icon.vue +24 -24
  159. package/src/foundations/Icon/README.md +11 -11
  160. package/src/foundations/Logo/Logo.spec.js +56 -56
  161. package/src/foundations/Logo/Logo.vue +39 -39
  162. package/src/foundations/Logo/README.md +20 -20
  163. package/src/foundations/YoutubeVideo/README.md +11 -11
  164. package/src/foundations/YoutubeVideo/YoutubeVideo.vue +24 -24
  165. package/src/helpers/strings.js +12 -12
  166. package/src/index.js +27 -27
  167. package/src/vue-shim.d.ts +6 -6
  168. package/assets/css/email.min.css +0 -1
  169. package/assets/css/email.min.css.map +0 -1
  170. package/assets/css/error.min.css +0 -1
  171. package/assets/css/error.min.css.map +0 -1
  172. package/assets/ts/main.js +0 -57
  173. package/assets/ts/main.js.map +0 -1
  174. package/assets/ts/modules/accordion.js +0 -33
  175. package/assets/ts/modules/accordion.js.map +0 -1
  176. package/src/components/Accordion/Accordion.screenshot.vue +0 -57
  177. package/src/components/Accordion/__screenshots__/win32/laptop/Accordion.png +0 -0
  178. package/src/components/Accordion/__screenshots__/win32/mobile/Accordion.png +0 -0
  179. package/src/components/Accordion/__screenshots__/win32/tablet/Accordion.png +0 -0
@@ -1,25 +1,25 @@
1
- ### Usage
2
-
3
- ```
4
- <CardDeck :items="items"></CardDeck>
5
- ```
6
-
7
- ### Properties
8
-
9
- | Option | Type | Default Value | Description |
10
- | ------ | ---- | ------------- | ----------- |
11
- | cols | Number | 1 | Number of columns on mobile |
12
- | smcols | Number | 1 | Number of columns on tablet |
13
- | mdcols | Number | 3 | Number of columns on desktop |
14
- | items | Array | - | Card data passed (See card component) |
15
- | cardtype | String | - | Change the type of card (simple,quick) |
16
- | btntype | String | (See card) | Change the type of button at the bottom of the card (primary,secondary,tertairy, link) |
17
- | ctatext | String | (See card) | Update the cta text within the button at the bottom of the card |
18
- | titleclass | String | (See card) | Update the class of the title from being a h2 |
19
-
20
- ### Slots
21
-
22
- | Option | Default Value | Description |
23
- | ------ | ------------- | ----------- |
24
- | default | - | Will display before the cards |
1
+ ### Usage
2
+
3
+ ```
4
+ <CardDeck :items="items"></CardDeck>
5
+ ```
6
+
7
+ ### Properties
8
+
9
+ | Option | Type | Default Value | Description |
10
+ | ------ | ---- | ------------- | ----------- |
11
+ | cols | Number | 1 | Number of columns on mobile |
12
+ | smcols | Number | 1 | Number of columns on tablet |
13
+ | mdcols | Number | 3 | Number of columns on desktop |
14
+ | items | Array | - | Card data passed (See card component) |
15
+ | cardtype | String | - | Change the type of card (simple,quick) |
16
+ | btntype | String | (See card) | Change the type of button at the bottom of the card (primary,secondary,tertairy, link) |
17
+ | ctatext | String | (See card) | Update the cta text within the button at the bottom of the card |
18
+ | titleclass | String | (See card) | Update the class of the title from being a h2 |
19
+
20
+ ### Slots
21
+
22
+ | Option | Default Value | Description |
23
+ | ------ | ------------- | ----------- |
24
+ | default | - | Will display before the cards |
25
25
  | after | - | Will display underneath the cards |
@@ -1,45 +1,45 @@
1
- import { mount } from '@vue/test-utils'
2
- import Carousel from './Carousel.vue'
3
-
4
- describe('Carousel component', () => {
5
-
6
- const test = mount(Carousel, {
7
- propsData: {
8
- items: [
9
- {
10
- link: '/components/card-deck',
11
- title: 'Card 1',
12
- content: `<p>It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages..</p>`
13
- },
14
- {
15
- link: '/components/card-deck',
16
- title: 'Card 2',
17
- content: `<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec efficitur, tortor eu faucibus facilisis, felis libero blandit dolor.</p>`
18
- },
19
- {
20
- link: '/components/card-deck',
21
- title: 'Card 3',
22
- content: `<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec efficitur, tortor eu faucibus facilisis, felis libero blandit dolor.</p><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec efficitur.</p>`
23
- }
24
- ]
25
- },
26
- slots: {
27
- default: '<p>Hello</p>'
28
- }
29
- })
30
-
31
- it('renders the content before the carousel', () => {
32
- expect(test.html()).toContain('<p>Hello</p>')
33
- })
34
-
35
-
36
- it('renders the correct number of columns', () => {
37
-
38
- expect(test.findAll('.col').length).toBe(3)
39
- })
40
-
41
- it('renders the correct number of pips', () => {
42
-
43
- expect(test.findAll('.carousel__controls a').length).toBe(3)
44
- })
45
- })
1
+ import { mount } from '@vue/test-utils'
2
+ import Carousel from './Carousel.vue'
3
+
4
+ describe('Carousel component', () => {
5
+
6
+ const test = mount(Carousel, {
7
+ propsData: {
8
+ items: [
9
+ {
10
+ link: '/components/card-deck',
11
+ title: 'Card 1',
12
+ content: `<p>It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages..</p>`
13
+ },
14
+ {
15
+ link: '/components/card-deck',
16
+ title: 'Card 2',
17
+ content: `<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec efficitur, tortor eu faucibus facilisis, felis libero blandit dolor.</p>`
18
+ },
19
+ {
20
+ link: '/components/card-deck',
21
+ title: 'Card 3',
22
+ content: `<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec efficitur, tortor eu faucibus facilisis, felis libero blandit dolor.</p><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec efficitur.</p>`
23
+ }
24
+ ]
25
+ },
26
+ slots: {
27
+ default: '<p>Hello</p>'
28
+ }
29
+ })
30
+
31
+ it('renders the content before the carousel', () => {
32
+ expect(test.html()).toContain('<p>Hello</p>')
33
+ })
34
+
35
+
36
+ it('renders the correct number of columns', () => {
37
+
38
+ expect(test.findAll('.col').length).toBe(3)
39
+ })
40
+
41
+ it('renders the correct number of pips', () => {
42
+
43
+ expect(test.findAll('.carousel__controls a').length).toBe(3)
44
+ })
45
+ })
@@ -1,85 +1,85 @@
1
- <template>
2
- <div class="container carousel" :id="'carousel'+id" ref="wrapper" :data-cols="cols" :data-sm-cols="smcols" :data-md-cols="mdcols">
3
- <slot><!-- Use for titles etc --></slot>
4
- <div class="carousel__wrapper">
5
- <div class="carousel__inner">
6
-
7
- <div v-if="type == 'card'" :class="`row row-cols-${cols} row-cols-sm-${smcols} row-cols-md-${mdcols} ${gap ? `g-${gap}`: ``}`">
8
- <div :class="`col carousel__item${colclass?` ${colclass}`:''}`" v-for="(value,index) in items" :key="index" :id="'carousel'+id+'slide'+(index+1)">
9
- <Card v-bind="value" :class="cardclass" :type="cardtype" :btnyype="btntype" :titleclass="titleclass" :ctatext="ctatext" :hidectatext="hidectatext"></Card>
10
- </div>
11
- </div>
12
- <div v-if="type != 'card'" :class="`row row-cols-${cols} row-cols-sm-${smcols} row-cols-md-${mdcols} ${gap ? `g-${gap}`: ``}`">
13
- <div :class="`col carousel__item${colclass?` ${colclass}`:''}`" v-for="(value,index) in items" :key="index" v-html="content(value)" :id="'carousel'+id+'slide'+(index+1)"></div>
14
- </div>
15
-
16
- </div>
17
-
18
- <div :class="`carousel__controls cols-${cols} cols-sm-${smcols} cols-md-${mdcols}`">
19
- <a v-for="(value,index) in items" :key="index" :href="'\#carousel'+id+'slide'+(index+1)" :class="`control-${index+1}`">Slide {{index+1}}</a>
20
- </div>
21
- <button class="btn btn-prev" data-go="0" disabled>Prev</button>
22
- <button class="btn btn-next" data-go="2">Next</button>
23
- </div>
24
- </div>
25
- </template>
26
-
27
-
28
- <style lang="scss">
29
- @import "../../../assets/sass/components/carousel.scss";
30
- </style>
31
-
32
-
33
- <script>
34
- import Card from '../../elements/Card/Card.vue'
35
- import CardDeck from '../CardDeck/CardDeck.vue'
36
- import carousel from '../../../assets/js/modules/carousel.js'
37
-
38
- // Inherit the card deck props
39
- let cardDeckProps = CardDeck.props;
40
- // Update the default values
41
- cardDeckProps.gap.default = 0
42
- cardDeckProps.cols.default = 1
43
- cardDeckProps.smcols.default = 2
44
- cardDeckProps.mdcols.default = 4
45
-
46
-
47
- export default {
48
- components: {
49
- Card
50
- },
51
- name: 'Carousel',
52
- data () {
53
- return {
54
- id: null
55
- }
56
- },
57
- props: {
58
- ...cardDeckProps,
59
- colclass: {
60
- type: String,
61
- required: false
62
- },
63
- type: {
64
- type: String,
65
- required: false
66
- }
67
- },
68
- computed: {
69
- content (){
70
- return (value) => {
71
- return `${value.image ? `<img src="${value.image}" alt="" />` : ''}${value.content?value.content:''}`;
72
- }
73
- }
74
- },
75
- mounted(){
76
-
77
- this.id = this._uid
78
-
79
- this.$nextTick(function () {
80
-
81
- carousel(this.$refs.wrapper);
82
- })
83
- }
84
- }
85
- </script>
1
+ <template>
2
+ <div class="container carousel" :id="'carousel'+id" ref="wrapper" :data-cols="cols" :data-sm-cols="smcols" :data-md-cols="mdcols">
3
+ <slot><!-- Use for titles etc --></slot>
4
+ <div class="carousel__wrapper">
5
+ <div class="carousel__inner">
6
+
7
+ <div v-if="type == 'card'" :class="`row row-cols-${cols} row-cols-sm-${smcols} row-cols-md-${mdcols} ${gap ? `g-${gap}`: ``}`">
8
+ <div :class="`col carousel__item${colclass?` ${colclass}`:''}`" v-for="(value,index) in items" :key="index" :id="'carousel'+id+'slide'+(index+1)">
9
+ <Card v-bind="value" :class="cardclass" :type="cardtype" :btnyype="btntype" :titleclass="titleclass" :ctatext="ctatext" :hidectatext="hidectatext"></Card>
10
+ </div>
11
+ </div>
12
+ <div v-if="type != 'card'" :class="`row row-cols-${cols} row-cols-sm-${smcols} row-cols-md-${mdcols} ${gap ? `g-${gap}`: ``}`">
13
+ <div :class="`col carousel__item${colclass?` ${colclass}`:''}`" v-for="(value,index) in items" :key="index" v-html="content(value)" :id="'carousel'+id+'slide'+(index+1)"></div>
14
+ </div>
15
+
16
+ </div>
17
+
18
+ <div :class="`carousel__controls cols-${cols} cols-sm-${smcols} cols-md-${mdcols}`">
19
+ <a v-for="(value,index) in items" :key="index" :href="'\#carousel'+id+'slide'+(index+1)" :class="`control-${index+1}`">Slide {{index+1}}</a>
20
+ </div>
21
+ <button class="btn btn-prev" data-go="0" disabled>Prev</button>
22
+ <button class="btn btn-next" data-go="2">Next</button>
23
+ </div>
24
+ </div>
25
+ </template>
26
+
27
+
28
+ <style lang="scss">
29
+ @import "../../../assets/sass/components/carousel.scss";
30
+ </style>
31
+
32
+
33
+ <script>
34
+ import Card from '../Card/Card.vue'
35
+ import CardDeck from '../CardDeck/CardDeck.vue'
36
+ import carousel from '../../../assets/ts/modules/carousel'
37
+
38
+ // Inherit the card deck props
39
+ let cardDeckProps = CardDeck.props;
40
+ // Update the default values
41
+ cardDeckProps.gap.default = 0
42
+ cardDeckProps.cols.default = 1
43
+ cardDeckProps.smcols.default = 2
44
+ cardDeckProps.mdcols.default = 4
45
+
46
+
47
+ export default {
48
+ components: {
49
+ Card
50
+ },
51
+ name: 'Carousel',
52
+ data () {
53
+ return {
54
+ id: null
55
+ }
56
+ },
57
+ props: {
58
+ ...cardDeckProps,
59
+ colclass: {
60
+ type: String,
61
+ required: false
62
+ },
63
+ type: {
64
+ type: String,
65
+ required: false
66
+ }
67
+ },
68
+ computed: {
69
+ content (){
70
+ return (value) => {
71
+ return `${value.image ? `<img src="${value.image}" alt="" />` : ''}${value.content?value.content:''}`;
72
+ }
73
+ }
74
+ },
75
+ mounted(){
76
+
77
+ this.id = this._uid
78
+
79
+ this.$nextTick(function () {
80
+
81
+ carousel(this.$refs.wrapper);
82
+ })
83
+ }
84
+ }
85
+ </script>
@@ -1,20 +1,20 @@
1
- ### Usage
2
-
3
- ```
4
- <Carousel :items="items" type="card"></Carousel>
5
- ```
6
-
7
- ### Properties
8
-
9
- **The carousel props inherit the card deck props** - this is so that when we use cards in the carousel we can still pass the same options.
10
-
11
- | Option | Type | Default Value | Description |
12
- | ------ | ---- | ------------- | ----------- |
13
- | type | String | - | Can be used to indicate that cards should be displayed in the carousel by giving the value 'card' |
14
- | colclass | String | - | Pass utility classes to the columns in the carousel. For example 'd-flex align-items-center' will align the items n the middle. |
15
-
16
- ### Slots
17
-
18
- | Option | Default Value | Description |
19
- | ------ | ------------- | ----------- |
1
+ ### Usage
2
+
3
+ ```
4
+ <Carousel :items="items" type="card"></Carousel>
5
+ ```
6
+
7
+ ### Properties
8
+
9
+ **The carousel props inherit the card deck props** - this is so that when we use cards in the carousel we can still pass the same options.
10
+
11
+ | Option | Type | Default Value | Description |
12
+ | ------ | ---- | ------------- | ----------- |
13
+ | type | String | - | Can be used to indicate that cards should be displayed in the carousel by giving the value 'card' |
14
+ | colclass | String | - | Pass utility classes to the columns in the carousel. For example 'd-flex align-items-center' will align the items n the middle. |
15
+
16
+ ### Slots
17
+
18
+ | Option | Default Value | Description |
19
+ | ------ | ------------- | ----------- |
20
20
  | default | - | Will display before the carousel |