v-spotlight

Tiny reusable Spotlight component for your Vue App

Usage no npm install needed!

<script type="module">
  import vSpotlight from 'https://cdn.skypack.dev/v-spotlight';
</script>

README

V-Spotlight

NPM version NPM downloads CircleCI

  • 🔦 Tiny reusable Spotlight component for your Vue App

  • Demo Link - Click Here

  • This is on GitHub so let me know if I've b0rked it somewhere, give me a star :star: if you like it :beers:

Install

yarn add v-spotlight

CDN: UNPKG | jsDelivr

Usage

<template>
  <v-spotlight background="'https://placehold.it/1000x1000'"></v-spotlight>
</template>

<script>
import VSpotlight from 'v-spotlight';

export default {
  components: {
    VSpotlight,
  },
};
</script>

API

Props

  • background: Add background image for the spotlight
  • position: Background image cover position

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

v-spotlight © Vinayak, Released under the MIT License.
Authored and maintained by Vinayak Kulkarni with help from contributors (list).

vinayakkulkarni.dev · GitHub @vinayakkulkarni · Twitter @_vinayak_k