https://github.com/jtkdvlp/re-frame-readfile-fx

A re-frame effects handler for reading files via FileReader-Object
https://github.com/jtkdvlp/re-frame-readfile-fx

filereader re-frame readfiles

Last synced: 3 months ago
JSON representation

A re-frame effects handler for reading files via FileReader-Object

• Host: GitHub
• URL: https://github.com/jtkdvlp/re-frame-readfile-fx
• Owner: jtkDvlp
• License: mit
• Created: 2017-03-09T17:13:29.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-04-14T18:45:00.000Z (almost 3 years ago)
• Last Synced: 2025-09-23T16:08:23.991Z (4 months ago)
• Topics: filereader, re-frame, readfiles
• Language: Clojure
• Size: 10.7 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Clojars Project](https://img.shields.io/clojars/v/jtk-dvlp/re-frame-readfile-fx.svg)](https://clojars.org/jtk-dvlp/re-frame-readfile-fx)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/jtkDvlp/re-frame-worker-fx/blob/master/LICENSE)

# Readfile effect handler for re-frame

This [re-frame](https://github.com/Day8/re-frame) library contains an [FileReader-Object](https://developer.mozilla.org/docs/Web/API/FileReader) [effect handler](https://github.com/Day8/re-frame/tree/develop/docs). The handler can be addressed by `:readfile`.

## Changelog

### 2.0.0

* Move package into ns `jtk-dvlp.re-frame`

* Read files is a `map` of meta and content now.

* Clean up project.clj

* Move to figwheel-main for dev and test

## Getting started

### Get it / add dependency

Add the following dependency to your `project.cljs`:


[![Clojars Project](https://img.shields.io/clojars/v/jtk-dvlp/re-frame-readfile-fx.svg)](https://clojars.org/jtk-dvlp/re-frame-readfile-fx)

### Usage

See the following minimal code example or the [test.cljs](https://github.com/jtkDvlp/re-frame-readfile-fx/blob/master/test/jtk_dvlp/re_frame/readfile_fx_test.cljs).

```clojure

(ns your.project

  (:require [re-frame.core :as re-frame]

            [jtk-dvlp.re-frame.readfile-fx]))

(re-frame/reg-event-fx

 :some-event

 (fn [_ [_ files]]

   {:readfile {;; vector of file- and / or blob-objects

               :files files

               ;; charset via string for all files,

               ;; via vector of strings for every single file

               ;; or nil for default (utf-8). nil also works

               ;; from within vector (for every single file)

               :charsets ["windows-1252" nil]

               ;; dispatched on success conjoined with read files

               :on-success [:your-success-event]

               ;; dispatched on error conjoined with read files

               :on-error [:your-error-event]}}))

```

How to get files from file-input see the [test.cljs](https://github.com/jtkDvlp/re-frame-readfile-fx/blob/master/test/jtk_dvlp/re_frame/readfile_fx_test.cljs).

## Appendix

I´d be thankful to receive patches, comments and constructive criticism.

Hope the package is useful :-)