com.fulcrologic.rad.semantic-ui-options

Liking cljdoc? Tell your friends :D

All platforms.

action-button-render
body-class
controls-class
get-rendering-options
layout-class
rendering-options
report-action-button-grouping
report-controls-row-class
report-rotated-table-class
report-row-button-grouping
report-row-button-renderer
report-table-cell-class
report-table-class
report-table-header-class
selectable-table-rows?
set-global-rendering-options!

Documented option keys for setting rendering-specific customization options when using Semantic UI Plugin as your DOM renderer.

ALL options MUST appear under the rendering options key:

(ns ...
  (:require
     [com.fulcrologic.rad.semantic-ui-options :as suo]
     ...))

(defsc-report Report [this props]
  {suo/rendering-options { ... }}}

Most of the options in this file can be given a global default using

(set-global-rendering-options! fulcro-app options)

where the options is a map of option keys/values.

Documented option keys for setting rendering-specific customization
options when using Semantic UI Plugin as your DOM renderer.

ALL options MUST appear under the rendering options key:

```
(ns ...
  (:require
     [com.fulcrologic.rad.semantic-ui-options :as suo]
     ...))

(defsc-report Report [this props]
  {suo/rendering-options { ... }}}
```

Most of the options in this file can be given a global default using

```
(set-global-rendering-options! fulcro-app options)
```

where the `options` is a map of option keys/values.

raw docstring

action-button-render^clj/s

A (fn [instance {:keys [key control disabled? loading?]}] dom-element).

key - the key you used to add it to the controls list.
control - the map of options you gave for the control.
disabled?- true if the calculation of your disabled? option is true.
loading? - true if the component is loading data.

Overrides the rendering of action button controls.

You must return a DOM element to render for the control. If you return nil then the default (button) will be rendered.

A `(fn [instance {:keys [key control disabled? loading?]}] dom-element)`.

* `key` - the key you used to add it to the controls list.
* `control` - the map of options you gave for the control.
* `disabled?`-  true if the calculation of your disabled? option is true.
* `loading?` - true if the component is loading data.

Overrides the rendering of action button controls.

You must return a DOM element to render for the control. If you return nil then
the default (button) will be rendered.

source raw docstring

body-class^clj/s

The CSS class of the div that holds the actual body of the page (e.g. form or report). Defaults to some variant of 'ui attached segment'.

A string or (fn [instance] string?).

The CSS class of the div that holds the actual body of the page (e.g. form or report).
Defaults to some variant of 'ui attached segment'.

A string or `(fn [instance] string?)`.

source raw docstring

controls-class^clj/s

The CSS class of the div that holds the controls on layouts that have a control section. Defaults to some variant of 'ui top attached segment'.

A string or (fn [instance] string?).

The CSS class of the div that holds the controls on layouts that have a control section. Defaults
to some variant of 'ui top attached segment'.

A string or `(fn [instance] string?)`.

source raw docstring

get-rendering-options^clj/s

(get-rendering-options c & ks)

Get rendering options from a mounted component c.

WARNING: If c is a class, then global overrides will not be honored.

Get rendering options from a mounted component `c`.

WARNING: If c is a class, then global overrides will not be honored.

source raw docstring

layout-class^clj/s

The CSS class of the div that holds the top-level layout of the report or form. Defaults to some variant of 'ui segment'.

A string or (fn [instance] string?).

The CSS class of the div that holds the top-level layout of the report or form.  Defaults
to some variant of 'ui segment'.

A string or `(fn [instance] string?)`.

source raw docstring

rendering-options^clj/s

Top-level key for specifying rendering options. All SUI customization options MUST appear under this key.

Top-level key for specifying rendering options. All
SUI customization options MUST appear under this key.

source raw docstring

report-action-button-grouping^clj/s

A string or (fn [report-instance] string?). CSS class(es) to put in the div that surrounds the action buttons.

Defaults to 'ui right floated buttons'.

A string or `(fn [report-instance] string?)`.
CSS class(es) to put in the div that surrounds the action buttons.

Defaults to 'ui right floated buttons'.

source raw docstring

report-controls-row-class^clj/s

A string or (fn [report-instance zero-based-row-idx] string?). A function that returns the CSS class for the given row of the report controls input form. Defaults to 'n fields', where n is one, two, etc. The zero-based-row-idx is the row being rendered.

A string or `(fn [report-instance zero-based-row-idx] string?)`. A function that returns the CSS class
for the given row of the report controls input form. Defaults to 'n fields', where n
is one, two, etc.  The `zero-based-row-idx` is the row being rendered.

source raw docstring

report-rotated-table-class^clj/s

The CSS class of generated report tables that are rotated. Defaults to 'ui compact collapsing definition selectable table'.

A string or (fn [report-instance] string?).

The CSS class of generated report tables that are rotated. Defaults to 'ui compact collapsing definition selectable table'.

A string or `(fn [report-instance] string?)`.

source raw docstring

report-row-button-grouping^clj/s

A string or (fn [report-instance] string?). CSS class(es) to put in the div that surrounds the action buttons on a table row.

Defaults to 'ui buttons'.

A string or `(fn [report-instance] string?)`.
CSS class(es) to put in the div that surrounds the action buttons on a table row.

Defaults to 'ui buttons'.

source raw docstring

report-row-button-renderer^clj/s

A (fn [instance row-props {:keys [key disabled?]}] dom-element).

instance - the report instance
row-props - the data props of the row
key - a unique key that can be used for react on the element.
onClick - a generated function according to the buton's action setting
disabled?- true if the calculation of your disabled? option is true.

Overrides the rendering of action button controls.

You must return a DOM element to render for the control. If you return nil then the default (button) will be rendered.

A `(fn [instance row-props {:keys [key disabled?]}] dom-element)`.

* `instance` - the report instance
* `row-props` - the data props of the row
* `key` - a unique key that can be used for react on the element.
* `onClick` - a generated function according to the buton's action setting
* `disabled?`-  true if the calculation of your disabled? option is true.

Overrides the rendering of action button controls.

You must return a DOM element to render for the control. If you return nil then
the default (button) will be rendered.

source raw docstring

report-table-cell-class^clj/s

The CSS class of cells in a table-style report. Defaults to nothing for normal tables, and 'right aligned' for rotated ones. Action buttons are have a column index and default to 'collapsing'.

A (fn [report-instance zero-based-column-index] string?).

The CSS class of cells in a table-style report. Defaults to nothing for normal tables, and 'right aligned' for
 rotated ones. Action buttons are have a column index and default to 'collapsing'.

A `(fn [report-instance zero-based-column-index] string?)`.

source raw docstring

report-table-class^clj/s

The CSS class of generated report tables. Defaults to 'ui selectable table'.

A string or (fn [report-instance] string?).

The CSS class of generated report tables. Defaults to 'ui selectable table'.

A string or `(fn [report-instance] string?)`.

source raw docstring

report-table-header-class^clj/s

The CSS class of headers in a table-style report. Data cells defaults to nothing. Action buttons are have a column index and default to 'collapsing'.

A (fn [report-instance zero-based-column-index] string?).

NOTE: Action buttons are add and have a column index. They default to 'collapsing'

The CSS class of headers in a table-style report. Data cells defaults to nothing.
Action buttons are have a column index and default to 'collapsing'.

A `(fn [report-instance zero-based-column-index] string?)`.

NOTE: Action buttons are add and have a column index. They default to 'collapsing'

source raw docstring

selectable-table-rows?^clj/s

A boolean. When true the table will support click on a row to affix a highlight to that row.

A boolean. When true the table will support click on a row to affix a highlight to that row.

source raw docstring

set-global-rendering-options!^clj/s

(set-global-rendering-options! app options)

Set rendering options on the application such that they serve as defaults.

The options parameter to this function MUST NOT have the key suo/rendering-options, but should instead just have the parameters themselves (e.g. ::suo/action-button-renderer).

Set rendering options on the application such that they serve as *defaults*.

The `options` parameter to this function MUST NOT have the key suo/rendering-options, but
should instead just have the parameters themselves (e.g. ::suo/action-button-renderer).

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close