1.0.0 • Published 5 years ago

react-use-quicklink v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

react-use-quicklink

Support me on Patreon License MIT

Quicklink hook for React. Run quicklink in your React application using a simple hook and prefetch all your links.

Note: This is using the new React Hooks API Proposal which is subject to change until React 16.7 final.

You'll need to install react, react-dom, etc at ^16.7.0-alpha.0

Installation

Install using yarn

yarn add react-use-quicklink

Or using npm

npm install --save react-use-quicklink

Usage

Import it as use it inside any React function component.

import useQuicklink from "react-use-quicklink";

function App() {
  useQuicklink(); // this is all you need

  return <UI />; // render some UI here with anchor tags to prefetch
}

That's all, now it will run quicklink. Aditionally you can pass a custom configuration as an object to the useQuicklink hook.

import useQuicklink from "react-use-quicklink";

function App() {
  useQuicklink({
    origins: [
      // add mine
      "my-website.com",
      "api.my-website.com",
      // add third-parties
      "other-website.com",
      "example.com"
      // ...
    ]
  });

  return <UI />;
}