Home

Awesome

<p align="center"> <img src="https://raw.githubusercontent.com/nivaldomartinez/link-prevue/master/link-prevue.png" alt="Link Prevue" width="100"> </p>

link-prevue

A flexible component for generating a link preview

<p align="center"> <img src="https://media.giphy.com/media/dZ5jwDmXARwBkFlRbV/giphy.gif" alt="Link Prevue"> </p>

Intallation

npm install link-prevue

Basic usage

Javascript

import LinkPrevue from 'link-prevue'

HTML

<div id="app">
  <LinkPrevue url="https://vuejs.org/"></LinkPrevue>
</div>

:+1:

Custom card

To use a custom card, set your own html code between the aperture tag and the close tag of component. Using the scoped slot.

<div id="app">
  <LinkPrevue url="https://vuejs.org/">
    <template v-slot="props">
      <div class="card" style="width: 20rem;">
        <img class="card-img-top" :src="props.img" :alt="props.title" />
        <div class="card-block">
          <h4 class="card-title">{{props.title}}</h4>
          <p class="card-text">{{props.description}}</p>
          <a v-bind:href="props.url" class="btn btn-primary">More</a>
        </div>
      </div>
    </template>
  </LinkPrevue>
</div>

Custom loading indicator

To use a custom loading indicator, use the loading slot.

<div id="app">
  <LinkPrevue url="https://vuejs.org/">
    <template v-slot:loading>
      <!-- set your custom loading -->
      <h1>Loading...</h1>
    </template>
  </LinkPrevue>
</div>

Custom button handler

For custom button handler use the onButtonClick property, like.

HTML

<div id="app">
  <LinkPrevue url="https://vuejs.org/" :onButtonClick="onClick"></LinkPrevue>
</div>

Javascript

import LinkPrevue from 'link-prevue'

export default {
  components:{
    LinkPrevue
  },
  methods: {
    onClick(prevue) {
      console.log('click', prevue.images, prevue.title, prevue.url, prevue.description)
    }
  }
}

Props API

link-prevue have the following props for customize the component

PropTypeRequiredDefault ValueDescription
urlStringyesundefinedSite url for generate link preview
onButtonClickFunctionnoundefinedFunction for a custom button handler, params => prevue
cardWidthStringno'400px'Card width, accept px and %
showButtonBooleannotrueRender card button
apiUrlStringnohttps://link-preview-api.nivaldo.workers.dev/previewCustom API url, link-preview add a query param called ?url= check this

API REST

link-prevue uses an API REST for retrieve link data if you want to use your own API REST check this.

License

This code is distributed under the terms and conditions of the MIT license.

compatibility

versionvue
v2.xv3.x
v1.xv2.x