@flayyer/ping-script

1.1.0 • Public • Published

@flayyer/ping-script

Monitor and pre-render Flayyer URLs - Browser script

This script will only work on pages where a <meta> tag is present and related to og:image or twitter:image and has for content a Flayyer URL. In other cases this will result in a no-op.

Install

This script is hosted in npm and served through unpkg.com

Add this script inside and at the end of the <body> tag:

<script async defer src="https://unpkg.com/@flayyer/ping-script/dist/ping.min.js"></script>
<noscript>
  <img src="https://edge.flayyer.com/v2/ping.gif" alt=""/>
</noscript>

So a fully-featured but also minimalist site using Flayyer should look like this:

<!DOCTYPE html>
<html lang="en" prefix="og: https://ogp.me/ns#">
<head>
  <title>Example</title>
  <meta property="og:image" content="https://flayyer.host/v2/tenant/deck/template.jpeg?title=Example" />
</head>
<body>
  <h1>Example</h1>
  ...
  <script async defer src="https://unpkg.com/@flayyer/ping-script/dist/ping.min.js"></script>
  <noscript>
    <img src="https://edge.flayyer.com/v2/ping.gif" alt=""/>
  </noscript>
</body>
</html>

By using this script we are able to pre-render the image at https://flayyer.host/v2/tenant/deck/template.jpeg?title=Example and also keep track of outside visitors that may be interested in your link thanks to the preview we generated.

Specific version

While https://unpkg.com/@flayyer/ping-script/dist/ping.min.js is going to grab the latest version of this script, you can opt to use a specific version using the syntax described in https://unpkg.com/

Size

We care about performance and we don´t want to impact the loading speed of your website. This script has the following filesize and we are continuously working to add more features while reducing the size as much as possible.

┌───────────────────────────────┐
│                               │
│   Destination: dist/ping.js   │
│   Bundle Size:  9.33 KB       │
│   Minified Size:  3.24 KB     │
│   Gzipped Size:  1.67 KB      │
│                               │
└───────────────────────────────┘
┌───────────────────────────────────┐
│                                   │
│   Destination: dist/ping.min.js   │
│   Bundle Size:  3.16 KB           │
│   Minified Size:  3.16 KB         │
│   Gzipped Size:  1.68 KB          │
│                                   │
└───────────────────────────────────┘

Package Sidebar

Install

npm i @flayyer/ping-script

Homepage

flayyer.com

Weekly Downloads

0

Version

1.1.0

License

MIT

Unpacked Size

16.9 kB

Total Files

4

Last publish

Collaborators

  • francomendez
  • lopezjurip