Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikolap/reframe-utils
Collection of utility and helper functions for re-frame. Gitlab repo mirror.
https://github.com/nikolap/reframe-utils
re-frame reagent utility
Last synced: about 1 month ago
JSON representation
Collection of utility and helper functions for re-frame. Gitlab repo mirror.
- Host: GitHub
- URL: https://github.com/nikolap/reframe-utils
- Owner: nikolap
- License: mit
- Created: 2016-09-06T21:11:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-17T07:48:37.000Z (over 3 years ago)
- Last Synced: 2024-11-03T22:48:31.626Z (about 2 months ago)
- Topics: re-frame, reagent, utility
- Language: Clojure
- Homepage:
- Size: 19.5 KB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-re-frame - re-frame-utils - frame. (Tools / Utils)
README
# reframe-utils
[](https://clojars.org/reframe-utils)
A collection of commonly used utility functions/helper functions for re-frame.
## Usage
If you've been using the magical [reagent](https://github.com/reagent-project/reagent) and [re-frame](https://github.com/Day8/re-frame) libraries, and are anything like me, you will have implemented a bunch of helper functions that manage common subscription and event/handler registration events that you create. After copy and pasting these like a pleb from project to project it seemed like about time to put together a library that has commonly used ones. The purpose of this library is to add syntactic sugar to help you reduce the lines of code you need to write when using re-frame.
If you have any additional helper functions you wish to submit or suggest, please make a pull request or add an issue!
To begin using the library ensure you have the latest reframe-utils included in your leiningen or boot dependencies and add the following to any namespaces you wish to use the utilities with.
It's worth noting that all of the utilities in this library can handle namespaced keywords, e.g. :library/books, intelligently.
`(require [reframe-utils.core :as rf-utils])`
### Subscription utilities
#### `reg-basic-sub` ####
Used to register a basic get query from the database
```clojure
(reg-basic-sub :common/active-page)
;; Equivalent to
(reg-basic-sub :common/active-page :common/active-page)
;; Equivalent to
(reg-sub
:common/active-page
(fn [db _]
(:common/active-page db)))
```
#### `reg-sub-by-id` ####
```clojure
(reg-sub-by-id :common/pages)
;; Equivalent to
(reg-sub-by-id :common/pages :common/pages)
;; Equivalent to
(reg-sub-by-id :common/pages :common/pages :id)
;; Equivalent to
(reg-sub
:common/pages
(fn [db [_ id]]
(->> :common/pages
(get db)
(filter
(fn [item]
(= (get item :id) id)))
first)))
```
### Event/handler utilities
#### `reg-set-event` ####
Used to register a basic associative set to a keyworded value in the database
```clojure
(reg-set-event :active-page)
;; Equivalent to
(reg-set-event :set-active-page :active-page)
;; Equivalent to
(reg-event-db
:set-active-page
(fn [db [_ page]]
(assoc db :active-page page)))
```
Unless specified otherwise, event/handler utilities you can do crazy stuff like this which lets you update/change values of nested keywords
```clojure
(reg-set-event :set-deep-deep-value [:deep :super-deep :super-duper-deep])
;; Equivalent to
(reg-event-db
:set-deep-deep-value
(fn [db [_ page]]
(assoc-in db [:deep :super-deep :super-duper-deep] page)))
```
#### `reg-add-event` ####
Used to register a basic conj update to a keyworded value in the database
```clojure
(reg-add-event :cases/add-case :cases/case)
;; Equivalent to
(reg-event-db
:cases/add-case
(fn [db [_ case]]
(update db :cases/case conj case)))
```
#### `reg-update-event` ####
Used to register a basic replace update to a keyworded value in the database. Requires a given old and new value.
```clojure
(reg-update-event :cases/update-case :cases/case)
;; Equivalent to
(reg-event-db
:cases/update-case
(fn [db [_ old-case new-case]]
(update db :cases/case #(replace {old new} %))))
```
#### `reg-remove-event` ####
Used to register a basic remove update to a keyworded value in the database. Removes the exact value that is passed through.
```clojure
(reg-remove-event :cases/delete-case :cases/case)
;; Equivalent to
(reg-event-db
:cases/delete-case
(fn [db [_ case]]
(update db :cases/case
(fn [cases]
(remove #(= % case) cases)))))
```
#### `reg-update-by-id-event` ####
View source for usage details. More docs to come eventually...
#### `reg-add-or-update-by-id-event` ####
View source for usage details. More docs to come eventually...
### General utilities
#### `multi-generation` ####
Used to generate multiple events or subscriptions at one go
```clojure
(multi-generation reg-basic-sub
:active-page
[:active-cow :cow])
;; will generate two subscriptions, active-page and active-cow
```
### AJAX utilities
#### `reg-ajax-get-event` ####
```clojure
(reg-ajax-get-event "/api/request-call" :data)
;; Equivalent to
(reg-ajax-get-event "/api/request-call" :get-data :data)
;; You would then dispatch the event as follows
(dispatch [:get-data])
;; If there are variable uri params to pass through you can register an event as follows
(reg-ajax-get-event "/api/items/%s" :item)
;; And then you would dispatch it like so
(dispatch [:get-item 1]) ;; => call GET on "/api/items/1" and assoc-in the response to :item
```
#### `reg-ajax-post-event` ####
View source for usage details. More docs to come eventually...
#### `reg-ajax-put-event` ####
View source for usage details. More docs to come eventually...
## License
Copyright © 2016 Nikola Peric
Distributed under the MIT License