Skip to content
This repository has been archived by the owner on Mar 21, 2019. It is now read-only.

Latest commit

 

History

History
172 lines (131 loc) · 4.74 KB

README.md

File metadata and controls

172 lines (131 loc) · 4.74 KB

wilson

Build Status Clojars Project

Wilson had no reason to suspect that anyone else was in this room; he had every reason to expect the contrary. He had locked himself in his room for the purpose of completing his thesis in one sustained drive. He had to--tomorrow was the last day for submission, yesterday the thesis had been no more than a title: "An investigation into Certain Mathematical Aspects of a Rigor of Metaphysics."

By His Bootstraps, Robert A. Heinlein (as Anson MacDonald)

Wilson is an opinionated library to help you use Twitter Bootstrap 3 in Clojurescript, particularly with Reagent.

Development

To run figwheel server for testing do lein figwheel dev and use components by editing dev-src/wilson/core.cljs file.

Table component

Simple example

Display simple table with selected columns:

(:require [wilson.dom :as d])

(d/table
 (d/prepare-keys [:a [:c :d]])
 [{:a 1 :b 1 :c {:d "a"}}
 {:a 3 :b 2 :c {:d "b"}}
 {:a 8 :b 3 :c {:d "c"}}
 {:a 2 :b 4 :c {:d "d"}}
 {:a 4 :b 5 :c {:d "e"}}])

Sorted rows

Sort table rows using wilson.dom/sort-rows by key :a:

(:require [wilson.dom :as d])

(def rows [{:a 1 :b 1 :c {:d "a"}}
          {:a 3 :b 2 :c {:d "b"}}
          {:a 8 :b 3 :c {:d "c"}}
          {:a 2 :b 4 :c {:d "d"}}
          {:a 4 :b 5 :c {:d "e"}}])

(def sorted-rows (d/sort-rows
                  rows
                  {:default (fn [k rows] (sort-by k rows))}
                  :a))

(d/table
 (d/prepare-keys [:a [:c :d]])
 sorted-rows)

Display all available columns

Instead of typing columns by hand, you can use wilson.dom/get-all-keys:

(:require [wilson.dom :as d])

(def rows [{:a 1 :b 1 :c {:d "a"}}
          {:a 3 :b 2 :c {:d "b"}}
          {:a 8 :b 3 :c {:d "c"}}
          {:a 2 :b 4 :c {:d "d"}}
          {:a 4 :b 5 :c {:d "e"}}])

(def all-ks (distinct (mapcat d/get-all-keys rows)))

(d/table
 (d/prepare-keys all-ks)
 rows)

Sortable table component

In addition to a standard table, you can create a table with rows sortable by column user clicks on:

(:require [wilson.dom :as d]
          [reagent.core :as r])

(defonce app-state (r/atom {}))

(def ks (d/prepare-keys [:a :b [:c :d]]))

(def rows [{:a 1 :b 1 :c {:d "a"}}
          {:a 3 :b 2 :c {:d "b"}}
          {:a 8 :b 3 :c {:d "c"}}
          {:a 2 :b 4 :c {:d "d"}}
          {:a 4 :b 5 :c {:d "e"}}])

[d/sorted-table
 ks
 rows
 app-state]

For app-state above you can also use Reagent Session.

For expected UX, you should style your sorted table using asc and desc css classes (added to table headers corresponding to current sorting key). Example styles can be found inside site.css

react-bootstrap components

Wilson includes all React-Bootstrap components. Here's an example usage of Bootstrap Popover:

(:require [reagent.core :as r]
          [wilson.react-bootstrap :refer [overlay-trigger popover]])

(defn component-with-popover
  []
  [overlay-trigger {:placement :right
                    :trigger :click
                    :overlay (r/as-component
                              [popover {:id "your-popover"}
                               [:div "Popover content."]])}
    [:button "Click me to toggle popover"]])

Affix

Toggle position of an element depending on scroll position of your page.

(:require [wilson.dom :refer [affix]])

[:div.affix-wrapper
 [affix
  [:div "Your content inside an affix."]]]

And add the following css

.affix-wrapper .affix {
  position: fixed;
  top: 0;
}

Modals

To add Bootstrap modal to your page first include modal-window (one per page - content of a modal is controlled by entries in your app state). After that you can use modal-button to add buttons triggering the modal (and setting its content).

(:require [reagent.core :as r]
          [wilson.dom :refer [modal-window modal-button]])

(defn home
  []
  (let [state (r/atom {})]
   [:div
    [modal-window state]]
    [modal-button "Modal title" "Modal content" "Click me!" state]))