theophilusx.yorick.basic

A collection of simple components which are too basic to require their own namespace.

a

(a title & {:keys [href on-click class attrs icon-data]})

Creates an anchor component. The required argument is the text title to be used in the anchor. Optional keyword arguments include

Key	Description
`:href`	a hypertext reference. Defaults to `#` if not provided
`:on-click`	a function with no arguments to be executed when the
	link is clicked
`:class`	a string or vector of strings representing CSS class names
`:attrs`	a map of HTML attribute values. Keys are HTML attribute
	names as keywords e.g. `:role`
`:icon-data`	an icon definition map to add an icon to the link title.
	See `theophilusx.yorick.icon` for details on map structure

breadcrumbs

(breadcrumbs sid crumbs & {:keys [class position separator size]})

Renders a breadcrumb link line. Creates a list of page links representing a breadcrumb trail. The sid argument is a state path keyword where periods represent path separators e.g. :ui.breadcrumb.current represents the path keys [:ui :breadcrumb :current]. The crumbs argument is a vector of maps representing each link in the trail. Each map consists of the following keys

Key	Description
`:name`	Text to use in the link
`:icon`	An icon data map describing an icon to add to the link
	See `theophilusx.yorick.icon` for description of icon data map
`:active`	True if this link is active
`:value`	The value to set in the global state atom when the link is
	selected

This component also accepts optional keyword arguments

Key	Description
`:class`	A string or vector of strings representing CSS class names
`:position`	Position of the breadcrumbs, either `:center` or `:right`
`:separator`	Type of link separator to use. Possible values are
	`:arrow`, `:bullet`, `:dot`, `:succeeds`
`:size`	Size of the breadcrumbs. Possible values are `:small`,
	`:medium`, `:large`

img

(img src & {:keys [class attrs]})

A basic component to generate an HTML element. The expected argument is a path or link to the image file. Additional optional keyword arguments are

Key	Description
`:class`	a string or vector of strings specifying CSS class names
`:attrs`	a map of HTML attribute values. Keys are the HTML attribute
	names as keywords e.g. `:id`

notification

(notification body & {:keys [class delete]})

Simple notification component with optional close button. This component displays whatever is passed in as the body argument as a notification. Supports the following optional keyword arguments

Key	Description
`:class`	A string or vector of strings specifying CSS class names
`:delete`	Adds a delete (X) button to top left corner of notification

render-map

(render-map m)

Render a ClojureScript map as an HTML table. Uses render-vec and render-set to render values which are ClojuresScript vectors or maps.

render-set

(render-set s)

Render a ClojureScript set as a string. Values are separated by commas (,) and surrounded by parenthesis.

render-vec

(render-vec v)

Render a ClojureScript vector as an un-ordered list