Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

use-object-url

1.0.0 • Public • Published

useObjectURL

Build Status License Library minified size Library minified + gzipped size

React Hook that receives an instance of File, Blob or MediaSource and creates an URL representing it. It releases URL when component unmount or parameter changes.

import useObjectURL from 'use-object-url';
 
const DownloadFileLink = ({ file, filename }) => {
  const fileURL = useObjectURL(file);
 
  return (
    <a href={fileURL} target="_blank" download={filename}>
      Download
    </a>
  );
};

Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

npm install use-object-url --save
 
# For Yarn, use the command below. 
yarn add use-object-url

Installation from CDN

This module has an UMD bundle available through JSDelivr and Unpkg CDNs.

<!-- For UNPKG use the code below. -->
<script src="https://unpkg.com/use-object-url"></script>
 
<!-- For JSDelivr use the code below. -->
<script src="https://cdn.jsdelivr.net/npm/use-object-url"></script>
 
<script>
  function PreviewImage(props) {
    // UMD module is exposed through the "useObjectURL" function.
    var imageURL = useObjectURL(props.uploadedImage);
 
    return React.createElement('img', {
      src: imageURL,
      alt: 'Uploaded image',
      title: 'Preview of uploaded image.'
    });
  }
</script> 

Documentation

Documentation generated from source files by Typedoc.

License

Released under MIT License.

Install

npm i use-object-url

DownloadsWeekly Downloads

15

Version

1.0.0

License

MIT

Unpacked Size

15.2 kB

Total Files

22

Last publish

Collaborators

  • avatar