Gathering detailed insights and metrics for @rbngzlv/react-activestorage-provider
Gathering detailed insights and metrics for @rbngzlv/react-activestorage-provider
A React component that allows easy file upload using ActiveStorage
Installations
npm install @rbngzlv/react-activestorage-providerDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.14.0
NPM Version
6.13.4
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
rbngzlv
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
68 Commits
10 Branches
1 Contributors
Updated on Feb 02, 2020
Maintainers
1
Package Meta Information
Latest Version
6.0.0
Package Id
@rbngzlv/react-activestorage-provider@6.0.0
Unpacked Size
202.68 kB
Size
47.12 kB
File Count
17
NPM Version
6.13.4
Node Version
12.14.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Peer Dependencies
2
Dev Dependencies
34
@babel/core@babel/plugin-external-helpers@babel/plugin-proposal-class-properties@babel/plugin-proposal-object-rest-spread@babel/plugin-transform-runtime@babel/preset-env@babel/preset-flow@babel/preset-react@rails/activestoragebabel-corebabel-eslintbabel-jesteslinteslint-config-prettiereslint-config-standardeslint-plugin-flowtypeeslint-plugin-importeslint-plugin-jesteslint-plugin-nodeeslint-plugin-promiseeslint-plugin-reacteslint-plugin-standardflow-binflow-copy-sourcejestjest-fetch-mockprettierreactreact-test-rendererregenerator-runtimerolluprollup-plugin-babelrollup-plugin-commonjsrollup-plugin-node-resolve
react-activestorage-provider
ActiveStorage is an amazing addition to Rails 5.2, and as usual the team have made it fantastically simple to use... if you’re generating HTML server-side, that is. This component aims to make it just as easy to use from React.
ActiveStorageProvider handles the direct upload of a file to an ActiveStorage service and the attachment of that file to your model. It uses the render props pattern so you can build your own upload widget.
Install
1npm install --save react-activestorage-provider
Usage
ActiveStorageProvider makes it easy to add a simple upload button. When you call handleUpload with a FileList or an array of Files, this component creates a Blob record, uploads the file directly to your storage service, and then hits your Rails controller to attach the blob to your model. (If you want to handle the attachment yourself in order to, for example, provide other attributes, see the lower level DirectUploadProvider.)
1import ActiveStorageProvider from 'react-activestorage-provider' 2 3// ... 4 5return ( 6 <ActiveStorageProvider 7 endpoint={{ 8 path: '/profile', 9 model: 'User', 10 attribute: 'avatar', 11 method: 'PUT', 12 }} 13 onSubmit={user => this.setState({ avatar: user.avatar })} 14 render={({ handleUpload, uploads, ready }) => ( 15 <div> 16 <input 17 type="file" 18 disabled={!ready} 19 onChange={e => handleUpload(e.currentTarget.files)} 20 /> 21 22 {uploads.map(upload => { 23 switch (upload.state) { 24 case 'waiting': 25 return <p key={upload.id}>Waiting to upload {upload.file.name}</p> 26 case 'uploading': 27 return ( 28 <p key={upload.id}> 29 Uploading {upload.file.name}: {upload.progress}% 30 </p> 31 ) 32 case 'error': 33 return ( 34 <p key={upload.id}> 35 Error uploading {upload.file.name}: {upload.error} 36 </p> 37 ) 38 case 'finished': 39 return ( 40 <p key={upload.id}>Finished uploading {upload.file.name}</p> 41 ) 42 } 43 })} 44 </div> 45 )} 46 /> 47)
ActiveStorageProvider Props
These are your options for configuring ActiveStorageProvider.
| Prop (*required) | Description |
|---|---|
directUploadsPath | stringThe direct uploads path on your Rails app, if you’ve overridden ActiveStorage::DirectUploadsController |
endpoint* | { path: string, model: string, attribute: string, method: string, host?: string, port?: string, protocol?: string }The details for the request to attach the file |
headers | {[key: string]: string}Optional headers to add to request, can also be used to override default headers |
multiple | boolean (false)Whether the component should accept multiple files. If true, the model should use has_many_attached |
onBeforeBlobRequest | ({ id: string, file: File, xhr: XMLHttpRequest }) => mixedA callback that allows you to modify the blob request |
onBeforeStorageRequest | ({ id: string, file: File, xhr: XMLHttpRequest }) => mixedA callback that allows you to modify the storage request |
onError | Response => mixedA callback to handle an error (>= 400) response by the server in saving your model |
onSubmit* | Object => mixedA callback for the server response to successfully saving your model |
render* | RenderProps => React.NodeRender props |
RenderProps
This is the type of the argument with which your render function will be called.
1export type RenderProps = { 2 ready: boolean /* false while any file is uploading */, 3 uploads: ActiveStorageFileUpload[] /* uploads in progress */, 4 5 handleUpload: (FileList | File[]) => mixed /* call to initiate an upload */, 6 7 /* or, if you want more granular control... */ 8 9 /* call to set list of files to be uploaded */ 10 handleChooseFiles: (FileList | File[]) => mixed, 11 /* then call to begin the upload of the files in the list */ 12 handleBeginUpload: () => mixed, 13} 14 15type ActiveStorageFileUpload = 16 | { state: 'waiting', id: string, file: File } 17 | { state: 'uploading', id: string, file: File, progress: number } 18 | { state: 'error', id: string, file: File, error: string } 19 | { state: 'finished', id: string, file: File }
DirectUploadProvider
ActiveStorageProvider makes it simple to add a quick “upload” button by taking care of both uploading and attaching your file, but it shouldn’t stand in your way if you’re doing something more interesting. If you want to handle the second step, attaching your Blob record to your model, yourself, you can use the lower level DirectUploadProvider. It creates the blob records and uploads the user’s files directly to your storage service, then calls you back with the signed ids of those blobs. Then, you can create or update your model as you need.
1function PostForm() { 2 function handleAttachment(signedIds) { 3 const body = JSON.stringify({ post: { title: ..., images: signedIds }}) 4 fetch('/posts.json', { method: 'POST', body }) 5 } 6 7 return ( 8 <DirectUploadProvider multiple onSuccess={handleAttachment} render={...} /> 9 ) 10}
DirectUploadProvider is a named export, so
1import { DirectUploadProvider } from 'react-activestorage-provider'
and use it with the following props:
| Prop (*required) | Description |
|---|---|
directUploadsPath | stringThe direct uploads path on your Rails app, if you’ve overridden ActiveStorage::DirectUploadsController |
headers | {[key: string]: string}Optional headers to add to request |
multiple | booleanWhether the component should accept multiple files. If true, the model should use has_many_attached |
onBeforeBlobRequest | ({ id: string, file: File, xhr: XMLHttpRequest }) => mixedA callback that allows you to modify the blob request |
onBeforeStorageRequest | ({ id: string, file: File, xhr: XMLHttpRequest }) => mixedA callback that allows you to modify the storage request |
onSuccess* | (string[]) => mixedThe callback that will be called with the signed ids of the files after the upload is complete |
origin | { host?: string, port?: string, protocol?: string }The origin of your rails server. Defaults to where your React app is running |
render* | RenderProps => React.NodeRender props |
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
67 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
- Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
- Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More