1. class
  2. Beartropy
  3. \
  4. Tables
  5. \
  6. Classes
  7. \
  8. Columns
  9. \
  10. Column

Column

class Column

Traits

Columns

Properties

string $column_id

The unique identifier column for rows.

 from  Columns
string $custom_column_id

A custom column ID override.

 from  Columns
Collection|null $columns

Collection of defined columns.

 from  Columns
bool $show_column_toggle

Whether to show the column toggle dropdown.

 from  Columns
bool $column_toggle_dd_status

Status of the column toggle dropdown (open/closed).

 from  Columns
bool $hasMobileCollapsedColumns

Indicates if there are columns collapsed on mobile view.

 from  Columns
array $mobileCollapsedColumns

Array of columns that are collapsed on mobile.

 from  Columns
string $label
string $key
string $index
bool $isVisible
bool $isHidden
bool $hideFromSelector
Closure|null $customData
string $classes
string $th_classes
string $th_wrapper_classes
bool $has_modified_data
bool $hide_on_mobile
bool $collapseOnMobile
bool $show_on_mobile
bool $cardTitle
Closure|null $cardTitleCallback
bool $triggerCardInfoModal
bool $showOnCard
bool $isEditable
string $editableType
array $editableOptions
callable|string|null $editableCallback
callable|null $sortableCallback
callable|null $searchableCallback
Closure|null $secondaryHeaderCallback
bool $isSortable
bool $isSearchable
static protected string[] $existingKeys
string|null $updateField

Methods

void
setColumns()

Initialize and process column definitions.

from  Columns
Collection
getFreshColumns()

Get a fresh collection of column instances with closures intact.

from  Columns
array
resolveSecondaryHeaders(mixed $paginatedData)

Resolve secondary header values by calling each column's callback with the current rows.

from  Columns
void
showColumnToggle(bool $bool)

Show or hide the column toggle dropdown.

from  Columns
void
setColumnID(string $column_id)

Set the primary key column used to identify rows.

from  Columns
Columns
hideOnMobile(bool $bool)

Hide this column on mobile devices.

from  Columns
Columns
showOnMobile(bool $bool = true)

Show this column only on mobile devices.

from  Columns
Columns
view(string $view)

Set a custom Blade view for rendering the column cell.

from  Columns
Columns
styling(string $classes)

Set CSS classes for the column's table cell (td).

from  Columns
Columns
thStyling(string $classes)

Set CSS classes for the column's table header (th).

from  Columns
Columns
thWrapperStyling(string $classes)

Set CSS classes for the column's header wrapper element.

from  Columns
Columns
disableToggleWhen(Closure $function)

Set a closure that determines when the toggle should be disabled.

from  Columns
Columns
hideToggleWhen(Closure $function)

Set a closure that determines when the toggle should be hidden.

from  Columns
Columns
trigger(string $trigger)

Set the method name to call when a toggle column is toggled.

from  Columns
Columns
isBool()

Mark this column as a boolean column.

from  Columns
Columns
trueIs(mixed $true)

Set the value that represents "true" for boolean columns.

from  Columns
Columns
trueLabel(string $string)

Set the display label/icon for the "true" state.

from  Columns
Columns
falseLabel(string $string)

Set the display label/icon for the "false" state.

from  Columns
Columns
toHtml()

Allow the column value to be rendered as raw HTML.

from  Columns
Columns
text(string $text)

Set the display text for a link column.

from  Columns
Columns
href(Closure $function)

Set a closure that resolves the URL for a link column.

from  Columns
Columns
target(string $target)

Set the target attribute for a link column (e.g. '_blank').

from  Columns
Columns
popup(array $array = ['width' => 750, 'height' => 800])

Open the link in a popup window with the given dimensions.

from  Columns
Columns
classes(string $classes)

Set CSS classes for a link column's anchor tag.

from  Columns
Columns
customData(Closure $function)

Set a closure to transform the column's display value.

from  Columns
Columns
hideWhen(bool $bool)

Conditionally hide the column and remove it from the column selector.

from  Columns
Columns
hideFromSelector(bool $bool)

Hide this column from the column toggle selector.

from  Columns
Columns
isVisible(bool $bool)

Set the column's initial visibility.

from  Columns
Columns
sortColumnBy(string $column)

Set an alternative column key to use when sorting this column.

from  Columns
__construct(string $label, string|null $index = null)

Create a new Column instance.

static Column
make(string $label, string|null $key = null)

static Constructor.

Column
collapseOnMobile(bool $bool = true)

Set the column to collapse on mobile devices.

Column
cardTitle(bool|callable $callback = true)

Set the column as the card title for mobile devices.

Column
triggerCardInfoModal(bool $bool = true)

Toggle whether clicking the card title opens the info modal.

Column
showOnCard(bool $bool = true)

Toggle whether this column is displayed on mobile cards.

Column
sortable(bool|callable $callback = true)

Mark the column as sortable.

Column
secondaryHeader(callable $callback)

Set a secondary header callback for this column.

Column
searchable(bool|callable $callback = true)

Mark the column as searchable.

Column
editable(string $type = 'input', array $options = [], callable|null $onUpdate = null)

Mark the column as editable.

Column
setUpdateField(string $field)

Set the database field to use when saving editable values.

Column
pushLeft()

Align the column content to the left.

Column
pushRight()

Align the column content to the right.

Column
centered()

Center the column content.

static void
resetStaticKeys()

Reset the static key registry (used between test runs).

string
generateUniqueKey(string $label)

Generate a unique slug key from the column label.

Details

in Columns at line 53
void setColumns()

Initialize and process column definitions.

Handles mobile visibility, collapse behavior, and strips closures for Livewire serialization.

Return Value

void

in Columns at line 99
Collection getFreshColumns()

Get a fresh collection of column instances with closures intact.

Return Value

Collection

in Columns at line 114
array resolveSecondaryHeaders(mixed $paginatedData)

Resolve secondary header values by calling each column's callback with the current rows.

Parameters

mixed $paginatedData

Return Value

array

in Columns at line 136
void showColumnToggle(bool $bool)

Show or hide the column toggle dropdown.

Parameters

bool $bool

Return Value

void

in Columns at line 146
void setColumnID(string $column_id)

Set the primary key column used to identify rows.

Parameters

string $column_id

Return Value

void

in Columns at line 154
Columns hideOnMobile(bool $bool)

Hide this column on mobile devices.

Parameters

bool $bool

Return Value

Columns

in Columns at line 164
Columns showOnMobile(bool $bool = true)

Show this column only on mobile devices.

Parameters

bool $bool

Return Value

Columns

in Columns at line 176
Columns view(string $view)

Set a custom Blade view for rendering the column cell.

Parameters

string $view

Return Value

Columns

in Columns at line 187
Columns styling(string $classes)

Set CSS classes for the column's table cell (td).

Parameters

string $classes

Return Value

Columns

in Columns at line 197
Columns thStyling(string $classes)

Set CSS classes for the column's table header (th).

Parameters

string $classes

Return Value

Columns

in Columns at line 207
Columns thWrapperStyling(string $classes)

Set CSS classes for the column's header wrapper element.

Parameters

string $classes

Return Value

Columns

in Columns at line 217
Columns disableToggleWhen(Closure $function)

Set a closure that determines when the toggle should be disabled.

Parameters

Closure $function

Return Value

Columns

in Columns at line 227
Columns hideToggleWhen(Closure $function)

Set a closure that determines when the toggle should be hidden.

Parameters

Closure $function

Return Value

Columns

in Columns at line 237
Columns trigger(string $trigger)

Set the method name to call when a toggle column is toggled.

Parameters

string $trigger

Return Value

Columns

in Columns at line 247
Columns isBool()

Mark this column as a boolean column.

Return Value

Columns

in Columns at line 259
Columns trueIs(mixed $true)

Set the value that represents "true" for boolean columns.

Parameters

mixed $true

Return Value

Columns

in Columns at line 271
Columns trueLabel(string $string)

Set the display label/icon for the "true" state.

Parameters

string $string

Return Value

Columns

in Columns at line 283
Columns falseLabel(string $string)

Set the display label/icon for the "false" state.

Parameters

string $string

Return Value

Columns

in Columns at line 293
Columns toHtml()

Allow the column value to be rendered as raw HTML.

Return Value

Columns

in Columns at line 305
Columns text(string $text)

Set the display text for a link column.

Parameters

string $text

Return Value

Columns

in Columns at line 317
Columns href(Closure $function)

Set a closure that resolves the URL for a link column.

Parameters

Closure $function

Return Value

Columns

in Columns at line 329
Columns target(string $target)

Set the target attribute for a link column (e.g. '_blank').

Parameters

string $target

Return Value

Columns

in Columns at line 343
Columns popup(array $array = ['width' => 750, 'height' => 800])

Open the link in a popup window with the given dimensions.

Parameters

array $array

Return Value

Columns

in Columns at line 357
Columns classes(string $classes)

Set CSS classes for a link column's anchor tag.

Parameters

string $classes

Return Value

Columns

in Columns at line 369
Columns customData(Closure $function)

Set a closure to transform the column's display value.

Parameters

Closure $function

Return Value

Columns

in Columns at line 379
Columns hideWhen(bool $bool)

Conditionally hide the column and remove it from the column selector.

Parameters

bool $bool

Return Value

Columns

in Columns at line 392
Columns hideFromSelector(bool $bool)

Hide this column from the column toggle selector.

Parameters

bool $bool

Return Value

Columns

in Columns at line 402
Columns isVisible(bool $bool)

Set the column's initial visibility.

Parameters

bool $bool

Return Value

Columns

in Columns at line 412
Columns sortColumnBy(string $column)

Set an alternative column key to use when sorting this column.

Parameters

string $column

Return Value

Columns

at line 105
__construct(string $label, string|null $index = null)

Create a new Column instance.

Parameters

string $label
string|null $index

at line 117
static Column make(string $label, string|null $key = null)

static Constructor.

Parameters

string $label
string|null $key

Return Value

Column

at line 125
Column collapseOnMobile(bool $bool = true)

Set the column to collapse on mobile devices.

Parameters

bool $bool

Return Value

Column

at line 137
Column cardTitle(bool|callable $callback = true)

Set the column as the card title for mobile devices.

Parameters

bool|callable $callback

Return Value

Column

at line 152
Column triggerCardInfoModal(bool $bool = true)

Toggle whether clicking the card title opens the info modal.

Parameters

bool $bool

Return Value

Column

at line 162
Column showOnCard(bool $bool = true)

Toggle whether this column is displayed on mobile cards.

Parameters

bool $bool

Return Value

Column

at line 174
Column sortable(bool|callable $callback = true)

Mark the column as sortable.

Parameters

bool|callable $callback

Return Value

Column

at line 194
Column secondaryHeader(callable $callback)

Set a secondary header callback for this column.

The callback receives the current rows collection and should return the content to display in the secondary header cell.

Parameters

callable $callback

Return Value

Column

at line 206
Column searchable(bool|callable $callback = true)

Mark the column as searchable.

Parameters

bool|callable $callback

Return Value

Column

at line 225
Column editable(string $type = 'input', array $options = [], callable|null $onUpdate = null)

Mark the column as editable.

Parameters

string $type
array $options
callable|null $onUpdate

Return Value

Column

at line 243
Column setUpdateField(string $field)

Set the database field to use when saving editable values.

Parameters

string $field

Return Value

Column

at line 253
Column pushLeft()

Align the column content to the left.

Return Value

Column

at line 267
Column pushRight()

Align the column content to the right.

Return Value

Column

at line 281
Column centered()

Center the column content.

Return Value

Column

at line 297
static void resetStaticKeys()

Reset the static key registry (used between test runs).

Return Value

void

at line 305
protected string generateUniqueKey(string $label)

Generate a unique slug key from the column label.

Parameters

string $label

Return Value

string