Liking cljdoc? Tell your friends :D

wagoe.admin.core.ui.list

Entity list-page components: search form, table rows, table, and the complete list page (toolbar + filter builder + table).

Pure Hiccup generators. Depends on base for URL helpers, field-value rendering, and column sizing, and on filters for the filter builder.

Entity list-page components: search form, table rows, table, and the
complete list page (toolbar + filter builder + table).

Pure Hiccup generators. Depends on `base` for URL helpers, field-value
rendering, and column sizing, and on `filters` for the filter builder.
raw docstring

entity-cellclj

(entity-cell entity-name record entity-config permissions display column href)

One [:td] of a list row: column as cells/columns describes it, double- click editable when the user may write the field. An inline save or cancel answers with this same cell, so the edited cell stays the one the list drew. href is the record's page, for a :title cell, or nil.

One `[:td]` of a list row: `column` as `cells/columns` describes it, double-
click editable when the user may write the field. An inline save or cancel
answers with this same cell, so the edited cell stays the one the list drew.
`href` is the record's page, for a :title cell, or nil.
sourceraw docstring

entity-list-pageclj

(entity-list-page entity-name
                  records
                  entity-config
                  table-query
                  total-count
                  permissions
                  &
                  [opts])

Complete entity list page with search, table, and actions.

Args: entity-name: Keyword entity name records: Collection of entity records entity-config: Entity configuration map table-query: Table query parameters total-count: Total number of records permissions: Permission flags opts: Optional map with :search, :filters, :flash, :display

Returns: Hiccup page structure

Complete entity list page with search, table, and actions.

Args:
  entity-name: Keyword entity name
  records: Collection of entity records
  entity-config: Entity configuration map
  table-query: Table query parameters
  total-count: Total number of records
  permissions: Permission flags
  opts: Optional map with :search, :filters, :flash, :display

Returns:
  Hiccup page structure
sourceraw docstring

entity-search-formclj

(entity-search-form entity-name entity-config current-search _current-filters)

Compact inline search form for entity list filtering.

Args: entity-name: Keyword entity name entity-config: Entity configuration map current-search: Current search term (optional) current-filters: Current filter values (optional)

Returns: Hiccup search form structure

Compact inline search form for entity list filtering.

Args:
  entity-name: Keyword entity name
  entity-config: Entity configuration map
  current-search: Current search term (optional)
  current-filters: Current filter values (optional)

 Returns:
   Hiccup search form structure
sourceraw docstring

entity-tableclj

(entity-table entity-name
              records
              entity-config
              table-query
              total-count
              permissions
              &
              [filters display])

Generate entity table with sorting and pagination.

Args: entity-name: Keyword entity name records: Collection of entity records entity-config: Entity configuration map table-query: Table query parameters (sort, page, etc.) total-count: Total number of records permissions: Permission flags filters: Optional search filters display: Optional display options threaded to cell rendering

Returns: Hiccup table structure

Generate entity table with sorting and pagination.

Args:
  entity-name: Keyword entity name
  records: Collection of entity records
  entity-config: Entity configuration map
  table-query: Table query parameters (sort, page, etc.)
  total-count: Total number of records
  permissions: Permission flags
  filters: Optional search filters
  display: Optional display options threaded to cell rendering

Returns:
  Hiccup table structure
sourceraw docstring

entity-table-rowclj

(entity-table-row entity-name
                  record
                  entity-config
                  permissions
                  &
                  [display cols return-to])

Generate entity table row.

Args: entity-name: Keyword entity name record: Entity record map entity-config: Entity configuration map permissions: Permission flags for this entity display: Optional display options (zone/date patterns) for value rendering cols: Optional list columns, when the caller built them for the table

Returns: Hiccup table row

Generate entity table row.

Args:
  entity-name: Keyword entity name
  record: Entity record map
  entity-config: Entity configuration map
  permissions: Permission flags for this entity
  display: Optional display options (zone/date patterns) for value rendering
  cols: Optional list columns, when the caller built them for the table

Returns:
  Hiccup table row
sourceraw docstring

facet-tabsclj

(facet-tabs entity-name entity-config table-query filters display)

The facet's values as tabs with their counts over the filtered set, the current one marked; All clears it (ADR-040). Nil without a facet.

The facet's values as tabs with their counts over the filtered set, the
current one marked; `All` clears it (ADR-040). Nil without a facet.
sourceraw docstring

field-cellclj

(field-cell entity-name
            record
            entity-config
            field
            permissions
            &
            [display return-to])

field's list cell for record alone: what an inline save or cancel returns. return-to is the list the row is on, as entity-table-row takes it.

`field`'s list cell for `record` alone: what an inline save or cancel
returns. `return-to` is the list the row is on, as `entity-table-row` takes it.
sourceraw docstring

filter-table-containerclj

(filter-table-container entity-name
                        records
                        entity-config
                        table-query
                        total-count
                        permissions
                        filters
                        display)

Filter builder and table: the target of filter requests, rendered the same on the page and in the fragment that replaces it.

Filter builder and table: the target of filter requests, rendered the same
on the page and in the fragment that replaces it.
sourceraw docstring

overview-stripclj

(overview-strip entity-name entity-config table-query filters display)

Summary and facet tabs above the table.

Summary and facet tabs above the table.
sourceraw docstring

record-count-badgeclj

(record-count-badge total-count)

The toolbar's record count. A table fragment carries it out of band, so it follows search and filters.

The toolbar's record count. A table fragment carries it out of band, so
it follows search and filters.
sourceraw docstring

summary-lineclj

(summary-line entity-config display)

The entity's :summary aggregates over the filtered set (ADR-040).

The entity's `:summary` aggregates over the filtered set (ADR-040).
sourceraw docstring

totals-rowclj

(totals-row records cols entity-config display)

A footer with the page total of each :total money or number column, or nil when the list has none (ADR-040).

A footer with the page total of each `:total` money or number column, or
nil when the list has none (ADR-040).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close