Merge pull request #6 from apertureless/feature/#5_custom_classes

✨ Add customizeable css classes #5

Author: apertureless

README.md

@@ -45,7 +45,14 @@ Is a compontent for fast 60fps parallax scroll effects in vue 2.
 | fixed | Boolean | false | Other parallax effect. Image is fixed in position |
 | sectionHeight | Number | 70 | section height for mobile |
 | breakpoint | String | '(min-width: 968px)' | Media query for mobile deactivation |
+| sectionClass | String | 'Masthead' | CSS class of the outer section tag |
+| containerClass | String | 'Masthead__image' | CSS class of the container holding the  image |
+| parallaxClass | String | 'is-parallax' | Modifier class for the parallax effect |
+| fixedClass | String | 'is-fixed' | Modifier class for the fixed parallax effect |
 
+## Customizing
+
+You can change some of the behavior by changing the css classes. To be more clean, you can change them over the props. No need to overwrite or `!important` the existing classes.
 
 ## Build Setup
 

src/components/Parallax.vue

@@ -1,6 +1,9 @@
 <template>
-  <section class="Masthead" ref="block" v-bind:style="{ height: sectionHeight + 'vh' }">
-    <div class="Masthead__image" v-bind:class="{'is-parallax': parallax, 'is-fixed': fixed }" ref="parallax">
+  <section v-bind:class="[sectionClass]" ref="block" v-bind:style="{ height: sectionHeight + 'vh' }">
+    <div
+      v-bind:class="[parallax ? parallaxClass : '', fixed ? fixedClass : '', containerClass]"
+      ref="parallax"
+      >
       <slot></slot>
     </div>
   </section>
@@ -29,6 +32,22 @@
         default: 70,
         type: Number,
         required: false
+      },
+      sectionClass: {
+        type: String,
+        default: 'Masthead'
+      },
+      containerClass: {
+        type: String,
+        default: 'Masthead__image'
+      },
+      parallaxClass: {
+        type: String,
+        default: 'is-parallax'
+      },
+      fixedClass: {
+        type: String,
+        default: 'is-fixed'
       }
     },