fulcro.ui.bootstrap3 — fulcrologic/fulcro 2.8.13-1-SNAPSHOT

address clj/s

(address name & {:keys [street street2 city-state phone email]})

Formats an address

alert clj/s

(alert {:keys [kind onClose] :as props} & children)

Renders an alert.

Props can contain normal DOM props, and additionally:

kind - The kind of alert: :info, :success, :warning, or :danger. Defaults to :danger. onClose - What to do when the close button is pressed. If nil, close will not be rendered.

badge clj/s

(badge props & children)

Wraps children in an (inline) bootstrap badge.

props are standard DOM props.

bg-danger clj/s

A CSS classname for a contextual danger background color

bg-info clj/s

A CSS classname for a contextual info background color

bg-primary clj/s

A CSS classname for a contextual primary background color

bg-success clj/s

A CSS classname for a contextual success background color

bg-warning clj/s

A CSS classname for a contextual warning background color

breadcrumb-item clj/s

(breadcrumb-item label)

(breadcrumb-item label onClick)

Define a breadcrumb.

label - The label to show. You should internationalize this yourself. onClick - A function. What to do when the item is clicked. Not needed for the last item.

breadcrumbs clj/s

(breadcrumbs props & items)

props - Properties to place on the top-level ol. items - a list of breadcrumb-item

button clj/s

(button {:keys [kind size as-block] :as attrs} & children)

Render a button with optional styling

kind - Optional. One of :primary, :success, :info, :warning, or :danger. Defaults to none (default). size - Optional. One of :xs, :sm, or :lg. Defaults to a normal size. as-block - Optional. Boolean. When true makes the button a block element.

button-group clj/s

(button-group {:keys [size kind] :as attrs} & children)

Groups nested buttons together in a horizontal row.

size - (optional) can be :xs, :sm, or :lg. kind - (optional) can be :vertical or :justified

button-toolbar clj/s

(button-toolbar attrs & children)

Groups button groups together as a toolbar, and a bit of space between each group

caption clj/s

(caption props & children)

Renders content that has padding and a lightened color for the font.

Carousel clj/s≠

clj

cljs

(Carousel)

carousel-ident clj/s

(carousel-ident props-or-id)

CarouselItem clj/s≠

clj

cljs

(CarouselItem)

center-block clj/s

A CSS class for centering a block element

clearfix clj/s

A CSS class used on the PARENT to clear floats within that parent.

close-button clj/s

(close-button attrs)

col clj/s

(col {:keys [className xs sm md lg xs-offset sm-offset md-offset lg-offset]
      :as props}
     &
     children)

Output a div that represents a column in the 12-column responsive grid.

Any React props are allowed. The following special one pertain to the column:

xs The width of the column on xs screens sm The width of the column on sm screens md The width of the column on md screens lg The width of the column on lg screens xs-offset The offset of the column on xs screens sm-offset The offset of the column on sm screens md-offset The offset of the column on md screens lg-offset The offset of the column on lg screens

Collapse clj/s≠

clj

cljs

(Collapse)

collapse-ident clj/s

(collapse-ident id-or-props)

container clj/s

(container attrs & children)

Top-level container for bootstrap grid content. This is a responsive fixed-width container. See also container-fluid.

container-fluid clj/s

(container-fluid attrs & children)

Top-level container for bootstrap grid content. This is a responsive full-width container. See also container.

dropdown clj/s

(dropdown id label items)

Creates a dropdown's state. Create items with dropdown-item or dropdown-divider.

Dropdown clj/s≠

clj

cljs

(Dropdown)

dropdown-divider clj/s

(dropdown-divider id)

Creates a divider between items. Must have a unique ID

dropdown-ident clj/s

(dropdown-ident id-or-props)

dropdown-item clj/s

(dropdown-item id label)

Define the state for an item of a dropdown.

dropdown-item-ident clj/s

(dropdown-item-ident id-or-props)

dropdown-item-table clj/s

dropdown-table clj/s

DropdownItem clj/s≠

clj

cljs

(DropdownItem)

form-horizontal clj/s

(form-horizontal attrs & children)

Set up a container for labeled inputs (which should have :split) to render the labels beside the fields.

get-abs-position clj/s

(get-abs-position ele)

Get a map (with the keys :left and :top) that has the absolute position of the given DOM element.

glyph-icons clj/s

glyphicon clj/s

(glyphicon {:keys [size] :or {size "10pt"} :as attrs} icon)

Render a glyphicon in a span. Legal icon names are in b/glyph-icons.

attrs will be added to the span's attributes.

size - The size of the icon font. Defaults to 10pt.

hidden clj/s

A CSS class for BLOCK-level elements. Element is not in flow.

hidden-lg clj/s

A CSS class to hide the element according to screen size

hidden-md clj/s

A CSS class to hide the element according to screen size

hidden-sm clj/s

A CSS class to hide the element according to screen size

hidden-xs clj/s

A CSS class to hide the element according to screen size

img clj/s

(img {:keys [is-responsive shape] :as attrs})

Render an img tag with bootstrap classes.

is-responsive - Boolean. Marks the image so that it scales to its container. shape - Optional. One of :rounded, :circle, or :thumbnail

All other normal react attributes (including className) are allowed.

inline-ul clj/s

(inline-ul attrs & children)

Render an inline unordered list

invisible clj/s

A CSS class for BLOCK-level elements. Element still affects flow.

jumbotron clj/s

(jumbotron props & children)

Wraps children in a jumbotron

label clj/s

(label {:keys [kind] :as props :or {kind :default}} & children)

Wraps children in an (inline) bootstrap label.

props are standard DOM props, with support for the additional:

kind - One of :primary, :success, :warning, :info, :danger. Defaults to :default.

labeled-input clj/s

(labeled-input {:keys [id type className placeholder split help warning error
                       success input-generator]
                :as attrs}
               label)

An input with a label. All of the attrs apply to the input itself. You must supply a type and id for the field to work correctly. DO NOT USE for checkbox or radio.

The additional attributes are supported:

:split - A number from 1 to 11. The number of sm columns to allocate to the field label. If not specified, the label will be above the input. The parent must use the .form-horizontal class. :help - A string. If supplied, displayed as the help text for the field. NOT shown if warning, error, or success are set. :input-generator An (optional) function of props -> input to be called to generate the DOM input. It will receive a clj map of properties and should return an input that has those minimum properties. It can, of course, augment those.

You should only ever supply zero or one of the following: :warning - A boolean or string. If set as a string, that content replaces the help text. :error - A boolean or string. If set as a string, that content replaces the help text. :success - A boolean or string. If set as a string, that content replaces the help text.

lead clj/s

(lead attrs & children)

Generates a lead paragraph with an increased font size.

Modal clj/s≠

clj

cljs

(Modal)

modal-ident clj/s

(modal-ident props-or-id)

Get the ident for a modal with the given props or ID

ModalBody clj/s≠

clj

cljs

(ModalBody)

ModalFooter clj/s≠

clj

cljs

(ModalFooter)

ModalTitle clj/s≠

clj

cljs

(ModalTitle)

Nav clj/s≠

clj

cljs

(Nav)

nav clj/s

(nav id kind layout active-link-id links)

Creates a navigation control.

• kind - One of :tabs or :pills
• layout - One of :normal, :stacked or :justified
• active-link-id - Which of the nested links is the active one
• links - A vector of nav-link or dropdown instances.

nav-ident clj/s

(nav-ident id-or-props)

nav-link clj/s

(nav-link id label disabled?)

Creates a navigation link. ID must be globally unique. The label will be run through tr-unsafe, so it can be internationalized.

nav-link-ident clj/s

(nav-link-ident id-or-props)

nav-link-table clj/s

nav-table clj/s

NavItemUnion clj/s≠

clj

cljs

(NavItemUnion)

NavLink clj/s≠

clj

cljs

(NavLink)

pager clj/s

(pager props & children)

A light next/previous pair of controls. Use pager-next and pager-previous as the children of this.

pager-next clj/s

(pager-next {:keys [onClick disabled]} & label-children)

Render a next button in a pager

pager-previous clj/s

(pager-previous {:keys [onClick disabled]} & label-children)

Render a previous button in a pager

pagination clj/s

(pagination {:keys [size] :as props} & pagination-entries)

Render a pagination control.

props - A map of properties. size - One of :sm or :lg pagination-entries - One or more pagination-entry

pagination-entry clj/s

(pagination-entry {:keys [label disabled active onClick] :as props})

Create an entry in a pagination control. Forward and back buttons can be rendered at either end with any label, but the fulcro.ui.html-entities/raqao and laqao defs give a nicely sized font-based arrow.

panel clj/s

(panel {:keys [kind] :or {kind :default} :as props} & children)

Render a panel. Use panel-heading, panel-title, panel-body, and panel-footer for elements of the panel.

:kind is one of :primary, :success, :info, :warning, or :danger

panel-body clj/s

(panel-body props & children)

Render children in the body of a panel. Not needed for tables or list groups. Should come after (optional) panel-heading.

panel-footer clj/s

(panel-footer props & children)

Render children in a footer of a panel.

panel-group clj/s

(panel-group props & children)

A wrapper for panels that visually groups them together.

panel-heading clj/s

(panel-heading props & children)

Render a heading area in a panel. Must be first. Optional.

panel-title clj/s

(panel-title props & children)

Render a title in a panel. Must be in a panel-heading.

plain-ul clj/s

(plain-ul attrs & children)

Render an unstyled unordered list

PopOver clj/s≠

clj

cljs

(PopOver)

PopOverContent clj/s≠

clj

cljs

(PopOverContent)

PopOverTarget clj/s≠

clj

cljs

(PopOverTarget)

PopOverTitle clj/s≠

clj

cljs

(PopOverTitle)

progress-bar clj/s

(progress-bar {:keys [current kind animated?] :or {kind :info} :as props})

Render's a progress bar from an input of the current progress (a number from 0 to 100).

:current - The current value of progress (0 to 100) :animated? - Should the bar have a striped animation? :kind - One of :success, :warning, :danger, or :info

Any classname or other properties included will be placed on the top-level div of the progress bar.

pull-left clj/s

A CSS class for forcing a float

pull-right clj/s

A CSS class for forcing a float

quotation clj/s

(quotation {:keys [align credit source] :as attrs} & children)

Render a block quotation with optional citation and source.

align - :right or :left (default) credit - The name of the person. source - The place where it was said/written, you supply the joining preposition. children - The DOM element(s) (typicaly a p) that represent the body of the quotation

RenderInBody clj/s≠

clj

cljs

(RenderInBody)

RenderInBody_proto clj protocol

renderLayer clj

(renderLayer this)

row clj/s

(row props & children)

Generate a layout row. This is a div container for a row in a 12-wide grid responsive layout. Rows should contain layout columns generated with the col function of this namespace.

The properties are normal DOM attributes as a cljs map and can include standard React DOM properties.

set-active-nav-link* clj/s

(set-active-nav-link* state-map nav-id link-id)

set-dropdown-item-active* clj/s

(set-dropdown-item-active* state-map dropdown-id item-id)

show clj/s

A CSS class for BLOCK-level elements. Element affects flow and is visible.

table clj/s

(table {:keys [className styles] :as attrs} & children)

Renders a table. attrs can contain any normal react attributes, including :className.

Extended attributes that you can include are:

styles - A set of one or more of: #{:striped :bordered :condensed :hover}

table-styles clj/s

text-capitalize clj/s

A css transform that will change encosed text to capitalized text.

text-center clj/s

A CSS class for Center aligned text.

text-danger clj/s

A CSS classname for a danger text color

text-info clj/s

A CSS classname for a info text color

text-justify clj/s

A CSS class for Justified text.

text-left clj/s

A CSS class for Left aligned text.

text-lowercase clj/s

A css transform that will change encosed text to lowercased text.

text-muted clj/s

CSS class for a muted text color

text-nowrap clj/s

A CSS class for No wrap text.

text-primary clj/s

A CSS classname for a primary text color

text-right clj/s

A CSS class for Right aligned text.

text-success clj/s

A CSS classname for a success text color

text-uppercase clj/s

A css transform that will change encosed text to uppercased text.

text-warning clj/s

A CSS classname for a warning text color

thumbnail clj/s

(thumbnail props & children)

Renders a box around content. Typically used to double-box and image or generate Pinterest-style blocks.

ui-carousel clj/s

ui-carousel-item clj/s

Render a carousel item. Props can include src and alt for the image. If children are supplied, they will be treated as the caption.

ui-collapse clj/s

Render a collapse component that can height-animate in/out children. The props should be state from the app database initialized with get-initial-state of a Collapse component, and the children should be the elements you want to show/hide. Each component should have a unique (application-wide) ID. Use the toggle-collapse and set-collapse mutations to open/close.

ui-dropdown clj/s

(ui-dropdown props & {:keys [onSelect kind value stateful?] :as attrs})

Render a dropdown. The props are the state props of the dropdown. The additional by-name arguments:

onSelect - The function to call when a menu item is selected stateful? - If set to true, the dropdown will remember the selection and show it. kind - The kind of dropdown. See button.

ui-dropdown-item clj/s

(ui-dropdown-item props & {:keys [onSelect active?]})

Render a dropdown item. The props are the state props of the dropdown item. The additional by-name arguments:

onSelect - The function to call when a menu item is selected active? - render this item as active

ui-modal clj/s

(ui-modal props & children)

Render a modal.

Modals are stateful. You must compose in initial state and a query. Modals also have IDs.

Modal content should include a ui-modal-title, ui-modal-body, and ui-modal-footer as children. The footer usually contains one or more buttons.

Use the prim/get-initial-state function to pull a valid initial state for this component. The arguments are:

(prim/get-initial-state Modal {:id ID :sz SZ :backdrop BOOLEAN})

where the id is required (and must be unique among modals, and :sz is optional and must be :sm or :lg. The :backdrop option is boolean, and indicates you want a backdrop that blocks the UI. The :keyboard option defaults to true and enables removal of the dialog with ESC.

When rendering the modal, it typically looks something like this:

(b/ui-modal modal
  (b/ui-modal-title nil
    (dom/b nil "WARNING!"))
  (b/ui-modal-body nil
    (dom/p  {:className b/text-danger} "Stuff went sideways."))
  (b/ui-modal-footer nil
    (b/button {:onClick #(prim/transact! this `[(b/hide-modal {:id :warning-modal})])} "Bummer!"))))))

NOTE: The grid (row and col) can be used within the modal body without a container.

See the developer's guide for an example in the N15-Twitter-Bootstrap-Components section.

Available mudations: b/show-modal and b/hide-modal.

ui-modal-body clj/s

ui-modal-footer clj/s

ui-modal-title clj/s

ui-nav clj/s

(ui-nav props & {:keys [onSelect]})

Render a nav, which should have state declared with nav.

props - a cljs map of the data props onSelect - an optional named parameter to supply a function that is called when navigation is done.

ui-nav-item clj/s

ui-nav-link clj/s

ui-popover clj/s

ui-popover-content clj/s

ui-popover-target clj/s

ui-popover-title clj/s

ui-render-in-body clj/s

visible-lg-block clj/s

A responsive CSS class to show element according to screen size

visible-lg-inline clj/s

A responsive CSS class to show element according to screen size

visible-lg-inline-block clj/s

A responsive CSS class to show element according to screen size

visible-md-block clj/s

A responsive CSS class to show element according to screen size

visible-md-inline clj/s

A responsive CSS class to show element according to screen size

visible-md-inline-block clj/s

A responsive CSS class to show element according to screen size

visible-sm-block clj/s

A responsive CSS class to show element according to screen size

visible-sm-inline clj/s

A responsive CSS class to show element according to screen size

visible-sm-inline-block clj/s

A responsive CSS class to show element according to screen size

visible-xs-block clj/s

A responsive CSS class to show element according to screen size

visible-xs-inline clj/s

A responsive CSS class to show element according to screen size

visible-xs-inline-block clj/s

A responsive CSS class to show element according to screen size

well clj/s

(well {:keys [size] :as props} & children)

Inset content.

size - Optional to increase or decrease size. Can be :sm or :lg