Index | Tables API

A

$ Bulk#allSelected — Property in class Bulk: Indicates if all data (across all pages) is selected.
$ Data#all_data_count — Property in class Data: Total count of all data records (before filtering).
Filters::applyFilters() — Method in class Filters: Apply filters to the data collection (Array/Collection mode).
Filters::applyFiltersToQuery() — Method in class Filters: Apply filters to the Eloquent query.
RowManipulators::addRowToTable() — Method in class RowManipulators: Add a new row to the table data (and cache).
Search::applySearchToQuery() — Method in class Search: Apply global search to the Eloquent query.
Sort::applySortToQuery() — Method in class Sort: Apply sorting to the Eloquent query.
Spinner::addTargetsToSpinner() — Method in class Spinner: Add more triggers (methods/properties) to the spinner.
View::addButtons() — Method in class View: Add custom buttons to the table header.
View::addCardModalButtons() — Method in class View: Add buttons to the card modal view.
View::addTableClasses() — Method in class View: Add CSS classes to the table element.

B

BoolColumn — Class in namespace Beartropy\Tables\Classes\Columns
Bulk — Class in namespace Beartropy\Tables\Traits
$ View#bulkThemeOverride — Property in class View
$ View#buttonThemeOverride — Property in class View
YATProvider::boot() — Method in class YATProvider: Bootstrap any package services.

C

Column — Class in namespace Beartropy\Tables\Classes\Columns
$ Column#customData — Property in class Column
$ Column#classes — Property in class Column
$ Column#collapseOnMobile — Property in class Column
$ Column#cardTitle — Property in class Column
Column::collapseOnMobile() — Method in class Column: Set the column to collapse on mobile devices.
Column::cardTitle() — Method in class Column
$ Filter#column — Property in class Filter
$ FilterBool#compared_with — Property in class FilterBool
MakeComponent::createTable() — Method in class MakeComponent
GenericExport::collection() — Method in class GenericExport
GenericExport::columnWidths() — Method in class GenericExport
Cache — Class in namespace Beartropy\Tables\Traits
$ Cache#cachePrefix — Property in class Cache: Prefix for cache keys.
$ Cache#cacheTimeStamp — Property in class Cache: Timestamp of the cached data.
Cache::cacheData() — Method in class Cache: Cache the current user data.
Cache::clearData() — Method in class Cache: Clear the cached data for this table.
Columns — Class in namespace Beartropy\Tables\Traits
$ Columns#column_id — Property in class Columns: The unique identifier column for rows.
$ Columns#custom_column_id — Property in class Columns: A custom column ID override.
$ Columns#columns — Property in class Columns: Collection of defined columns.
$ Columns#column_toggle_dd_status — Property in class Columns: Status of the column toggle dropdown (open/closed).
Columns::classes() — Method in class Columns
Columns::customData() — Method in class Columns
$ Data#cachePrefix — Property in class Data: Cache prefix used in the Data trait scope.
Filters::clearAllFilters() — Method in class Filters: Clear all active filters and search.
$ Pagination#currentPageNumber — Property in class Pagination: Current page number.
$ View#customHeader — Property in class View
View::closeMobileCardDetails() — Method in class View: Close the mobile details modal.

D

DateColumn — Class in namespace Beartropy\Tables\Classes\Columns
$ ToggleColumn#disableToggleWhen — Property in class ToggleColumn
$ FilterDateRange#daterange — Property in class FilterDateRange
$ MakeComponent#description — Property in class MakeComponent
$ GenericExport#data — Property in class GenericExport
Columns::disableToggleWhen() — Method in class Columns
Data — Class in namespace Beartropy\Tables\Traits

E

$ Column#editableType — Property in class Column
$ Column#editableOptions — Property in class Column
$ Column#editableCallback — Property in class Column
$ Column#existingKeys — Property in class Column
Column::editable() — Method in class Column: Mark the column as editable.
$ DateColumn#emptyValue — Property in class DateColumn: The value to display when the date is empty or null.
DateColumn::emptyValue() — Method in class DateColumn: Set the value to display when the date is empty or null.
$ Filter#existingKeys — Property in class Filter
MakeComponent::ensureDirectoryExists() — Method in class MakeComponent
Bulk::emptySelection() — Method in class Bulk: Clear the current selection.
Data::exportToClipboard() — Method in class Data: Export the current table data to clipboard (CSV/TSV).
Editable — Class in namespace Beartropy\Tables\Traits
RowManipulators::expandMobileRow() — Method in class RowManipulators: Expand the mobile details view for a row.

F

$ BoolColumn#false_icon — Property in class BoolColumn
Filter — Class in namespace Beartropy\Tables\Classes\Filters
FilterBool — Class in namespace Beartropy\Tables\Classes\Filters
FilterDateRange — Class in namespace Beartropy\Tables\Classes\Filters
FilterSelect — Class in namespace Beartropy\Tables\Classes\Filters
FilterSelectMagic — Class in namespace Beartropy\Tables\Classes\Filters
FilterString — Class in namespace Beartropy\Tables\Classes\Filters
Columns::falseLabel() — Method in class Columns
$ Data#filtered_data_count — Property in class Data: Count of data records after filtering.
Filters — Class in namespace Beartropy\Tables\Traits
$ Filters#filters — Property in class Filters: Collection of defined filters.
$ Pagination#forcePageNumber — Property in class Pagination: Force a specific page number.
Search::filteredData() — Method in class Search: Filter the data based on global search (Array mode).

G

Column::generateUniqueKey() — Method in class Column
MakeComponent::generateFileFromStub() — Method in class MakeComponent
GenericExport — Class in namespace Beartropy\Tables\Exports
GenericExport::getExcelColumnName() — Method in class GenericExport
Bulk::getSelectedRows() — Method in class Bulk: Get the list of selected row IDs.
Cache::getCacheKey() — Method in class Cache: Generate a unique cache key for the current user and table.
Cache::getCachedData() — Method in class Cache: Retrieve cached data.
Columns::getFreshColumns() — Method in class Columns
Data::getAllOriginalData() — Method in class Data: Get all original data without modifications.
Data::getAllData() — Method in class Data: Get all data available to the table.
Data::getAfterFiltersOriginalData() — Method in class Data: Get original data after filters are applied.
Data::getAfterFiltersData() — Method in class Data: Get data after applying search, filters, and sorting.
Data::getSelectedOriginalData() — Method in class Data: Get selected original data without modifications.
Data::getSelectedData() — Method in class Data: Get selected rows data.
Data::getRowByID() — Method in class Data: Get a single row by its ID.
Data::getCurrentPageData() — Method in class Data: Get data for the current page.
Data::getCustomData() — Method in class Data: Get columns with custom data closure.
Data::getLinkColumns() — Method in class Data: Get columns configured as links.
Data::getToggleColumns() — Method in class Data: Get columns with toggle functionality.
Filters::getColumnKey() — Method in class Filters: Identify the column key from a filter label.
Filters::getFreshFilters() — Method in class Filters: Get a fresh instance of filters with current state merged.
Pagination::getPageData() — Method in class Pagination: Get paginated data for a specific page number.
View::getThemeConfig() — Method in class View: Get configuration for a specific theme from presets.
View::gatherEnvData() — Method in class View: Detect environmental data (e.g. mobile device).
View::getRowStripingClasses() — Method in class View: Get the CSS classes for row striping based on configuration.

H

$ Column#hideFromSelector — Property in class Column
$ Column#has_modified_data — Property in class Column
$ Column#hide_on_mobile — Property in class Column
$ LinkColumn#href — Property in class LinkColumn
$ LinkColumn#has_modified_data — Property in class LinkColumn
$ ToggleColumn#hideToggleWhen — Property in class ToggleColumn
MakeComponent::handle() — Method in class MakeComponent
$ GenericExport#headers — Property in class GenericExport
GenericExport::headings() — Method in class GenericExport
$ Bulk#has_bulk — Property in class Bulk: Indicates if the table has bulk actions enabled.
Bulk::hasBulk() — Method in class Bulk: Enable or disable bulk actions.
$ Columns#hasMobileCollapsedColumns — Property in class Columns: Indicates if there are columns collapsed on mobile view.
Columns::hideOnMobile() — Method in class Columns
Columns::hideToggleWhen() — Method in class Columns
Columns::href() — Method in class Columns
Columns::hideWhen() — Method in class Columns
Columns::hideFromSelector() — Method in class Columns
$ Filters#has_filters — Property in class Filters
$ StateHandler#handle_state — Property in class StateHandler
$ StateHandler#handler_prefix — Property in class StateHandler
$ View#has_counter — Property in class View

I

$ BoolColumn#isBool — Property in class BoolColumn
$ Column#index — Property in class Column
$ Column#isVisible — Property in class Column
$ Column#isHidden — Property in class Column
$ Column#isEditable — Property in class Column
$ Column#isSortable — Property in class Column
$ Column#isSearchable — Property in class Column
$ DateColumn#isDate — Property in class DateColumn
$ DateColumn#inputFormat — Property in class DateColumn: The expected input format of the date.
DateColumn::inputFormat() — Method in class DateColumn: Set the expected input format of the date.
$ LinkColumn#isLink — Property in class LinkColumn
$ ToggleColumn#isToggle — Property in class ToggleColumn
$ Filter#input — Property in class Filter
Columns::isBool() — Method in class Columns
Columns::isVisible() — Method in class Columns
$ View#inputThemeOverride — Property in class View

K

$ Column#key — Property in class Column
$ Filter#key — Property in class Filter

L

$ Column#label — Property in class Column
LinkColumn — Class in namespace Beartropy\Tables\Classes\Columns
$ Filter#label — Property in class Filter
$ Spinner#loading_table_spinner — Property in class Spinner
$ Spinner#loading_table_spinner_custom_view — Property in class Spinner
$ View#layout — Property in class View
$ YATBaseTable#layout — Property in class YATBaseTable: The layout to be used for rendering the table.

M

BoolColumn::make() — Method in class BoolColumn: Static factory method.
Column::make() — Method in class Column: static Constructor.
DateColumn::make() — Method in class DateColumn: Static factory method.
LinkColumn::make() — Method in class LinkColumn: Static factory method.
ToggleColumn::make() — Method in class ToggleColumn: Static factory method.
FilterBool::make() — Method in class FilterBool: Static factory method.
FilterDateRange::make() — Method in class FilterDateRange: Static factory method.
FilterSelect::make() — Method in class FilterSelect: Static factory method.
FilterSelectMagic::make() — Method in class FilterSelectMagic: Static factory method.
FilterString::make() — Method in class FilterString: Static factory method.
MakeComponent — Class in namespace Beartropy\Tables\Console\Commands
$ Columns#mobileCollapsedColumns — Property in class Columns: Array of columns that are collapsed on mobile.
$ View#main_wrapper_classes — Property in class View
$ View#modals_view — Property in class View
$ View#mobileDetailsModalOpen — Property in class View
$ View#mobileDetailsRow — Property in class View
View::mountView() — Method in class View: Initialize view settings.
$ YATBaseTable#model — Property in class YATBaseTable: The model or builder instance used for the table data.
YATBaseTable::mount() — Method in class YATBaseTable: Initialize the component.

O

$ DateColumn#outputFormat — Property in class DateColumn: The desired output format for the date.
DateColumn::outputFormat() — Method in class DateColumn: Set the desired output format for the date.
$ FilterSelect#options — Property in class FilterSelect
$ FilterSelectMagic#options — Property in class FilterSelectMagic
$ GenericExport#original_headers — Property in class GenericExport
Options — Class in namespace Beartropy\Tables\Traits
$ Options#options — Property in class Options: Options available for the table (e.g. for select filters or other UI elements).
$ View#override_table_classes — Property in class View
View::openMobileCardDetails() — Method in class View: Open the mobile details modal for a specific row.
View::overrideTitleClasses() — Method in class View: Override default title classes.

P

Column::pushLeft() — Method in class Column
Column::pushRight() — Method in class Column
$ MakeComponent#parser — Property in class MakeComponent
MakeComponent::promptForMissingArguments() — Method in class MakeComponent
$ Bulk#pageSelected — Property in class Bulk: Indicates if the current page is selected.
Columns::popup() — Method in class Columns
Data::parseData() — Method in class Data: Parse and cache the initial data.
Data::processCollection() — Method in class Data: Process a collection of rows.
Pagination — Class in namespace Beartropy\Tables\Traits
$ Pagination#paginationTheme — Property in class Pagination: The pagination theme to use (e.g. 'tailwind', 'bootstrap').
$ Pagination#perPage — Property in class Pagination: Number of items per page.
$ Pagination#perPageDisplay — Property in class Pagination: Display value for per page selector.
$ Pagination#perPageOptions — Property in class Pagination: Available options for items per page.
Pagination::paginateData() — Method in class Pagination: specific method to handle pagination logic.

Q

$ Filter#queryCallback — Property in class Filter
Filter::query() — Method in class Filter: Define a custom query callback for the filter.

R

Column::resetStaticKeys() — Method in class Column
RowManipulators — Class in namespace Beartropy\Tables\Traits
RowManipulators::removeRowFromTable() — Method in class RowManipulators: Remove a row from the table data (and cache).
YATBaseTable::refresh() — Method in class YATBaseTable: Refresh the table component.
YATBaseTable::render() — Method in class YATBaseTable: Render the component.
YATProvider::register() — Method in class YATProvider: Register any application services.

S

$ Column#show_on_mobile — Property in class Column
$ Column#showOnCard — Property in class Column
$ Column#sortableCallback — Property in class Column
$ Column#searchableCallback — Property in class Column
Column::showOnCard() — Method in class Column
Column::sortable() — Method in class Column: Mark the column as sortable.
Column::searchable() — Method in class Column: Mark the column as searchable.
Column::setUpdateField() — Method in class Column
$ MakeComponent#signature — Property in class MakeComponent
$ GenericExport#sheetName — Property in class GenericExport
$ GenericExport#strip_tags — Property in class GenericExport
GenericExport::styles() — Method in class GenericExport
$ Bulk#selectAll — Property in class Bulk: Controls the "Select All" checkbox state.
Bulk::selectCurrentPage() — Method in class Bulk: Select all rows on the current page.
Bulk::select_all_data() — Method in class Bulk: Select all rows across all pages (after filters).
Cache::setCachePrefix() — Method in class Cache: Set the cache prefix.
$ Columns#show_column_toggle — Property in class Columns: Whether to show the column toggle dropdown.
Columns::setColumns() — Method in class Columns
Columns::showColumnToggle() — Method in class Columns
Columns::setColumnID() — Method in class Columns
Columns::showOnMobile() — Method in class Columns
Columns::styling() — Method in class Columns
Columns::sortColumnBy() — Method in class Columns
Data::stripModifiedRows() — Method in class Data: Strip modified row internal keys from the collection.
$ Filters#show_filters — Property in class Filters
Filters::setFilters() — Method in class Filters: Initialize filters.
Options::setOptions() — Method in class Options: Initialize and normalize options.
Pagination::setPerPageDefault() — Method in class Pagination: Set the default items per page.
Pagination::setPerPageOptions() — Method in class Pagination: Set available per-page options.
Search — Class in namespace Beartropy\Tables\Traits
Search::setSearchLabel() — Method in class Search: Set the label for the global search input.
Sort — Class in namespace Beartropy\Tables\Traits
$ Sort#sortColumn — Property in class Sort
$ Sort#sortDirection — Property in class Sort
Sort::setSortDirectionAsc() — Method in class Sort: Set sort direction to ascending.
Sort::setSortDirectionDesc() — Method in class Sort: Set sort direction to descending.
Sort::setSortColumn() — Method in class Sort: Set the column to sort by.
Sort::sortBy() — Method in class Sort: Toggle sorting for a specific column.
Sort::sortData() — Method in class Sort: Sort the data collection (Array mode).
Spinner — Class in namespace Beartropy\Tables\Traits
Spinner::setTableSpinnerView() — Method in class Spinner: Set a custom view for the loading spinner.
StateHandler — Class in namespace Beartropy\Tables\Traits
StateHandler::setHandlerPrefix() — Method in class StateHandler
StateHandler::saveTableState() — Method in class StateHandler
StateHandler::setTableState() — Method in class StateHandler
$ View#sticky_header — Property in class View
$ View#showCardsOnMobile — Property in class View
$ View#showOptionsOnlyOnRowSelect — Property in class View
$ View#stripRows — Property in class View
View::setTheme() — Method in class View: Set the table theme.
View::setBulkThemeOverride() — Method in class View: Override the bulk actions theme.
View::setButtonThemeOverride() — Method in class View: Override the button theme.
View::setInputThemeOverride() — Method in class View: Override specific theme settings.
View::showCounter() — Method in class View: Toggle the record counter display.
View::showCardsOnMobile() — Method in class View
View::setTitle() — Method in class View: Set the table title.
View::setCustomHeader() — Method in class View: Set custom HTML content for the header.
View::setComponentClasses() — Method in class View: Set CSS classes for the main component wrapper.
View::setTableClasses() — Method in class View: Set (overwrite) CSS classes for the table element.
View::setStickyHeader() — Method in class View: Enable sticky header for the table.
View::setModalsView() — Method in class View: Set the view for modals.
View::setMostLeftView() — Method in class View: Set the view for the leftmost header area.
View::setLessLeftView() — Method in class View: Set the view for the inner left header area.
View::setMostRightView() — Method in class View: Set the view for the rightmost header area.
View::setLessRightView() — Method in class View: Set the view for the inner right header area.
View::setButtonVariant() — Method in class View: Set the button variant style.
View::showOptionsOnlyOnRowSelect() — Method in class View: Configure options visibility based on row selection specific logic.
View::setLayout() — Method in class View: Set the main layout view.
View::stripRows() — Method in class View: Enable or disable striped rows.
YATBaseTable::showOnlyTable() — Method in class YATBaseTable: Configure the table display mode.

T

$ BoolColumn#true_icon — Property in class BoolColumn
$ Column#th_classes — Property in class Column
$ Column#th_wrapper_classes — Property in class Column
$ LinkColumn#text — Property in class LinkColumn
$ LinkColumn#tag_styles — Property in class LinkColumn
ToggleColumn — Class in namespace Beartropy\Tables\Classes\Columns
$ ToggleColumn#trigger — Property in class ToggleColumn
$ FilterBool#type — Property in class FilterBool
$ FilterDateRange#type — Property in class FilterDateRange
$ FilterSelect#type — Property in class FilterSelect
$ FilterSelectMagic#type — Property in class FilterSelectMagic
$ FilterString#type — Property in class FilterString
Columns::thStyling() — Method in class Columns
Columns::thWrapperStyling() — Method in class Columns
Columns::trigger() — Method in class Columns
Columns::trueIs() — Method in class Columns
Columns::trueLabel() — Method in class Columns
Columns::toHtml() — Method in class Columns
Columns::text() — Method in class Columns
Columns::target() — Method in class Columns
Data::transformRow() — Method in class Data: Transform a single row.
RowManipulators::toggleExpandedRow() — Method in class RowManipulators: Toggle the expansion state of a row.
RowManipulators::toggleBoolean() — Method in class RowManipulators: Toggle a boolean column value for a row.
$ Spinner#trigger_spinner — Property in class Spinner: Actions that trigger the loading spinner.
$ View#title — Property in class View
$ View#titleClasses — Property in class View
$ View#table_classes — Property in class View
$ View#theme — Property in class View
$ View#themeConfig — Property in class View

U

$ Column#updateField — Property in class Column
Bulk::updatedSelectAll() — Method in class Bulk: Handle updates to the "Select All" checkbox.
Cache::updateCacheData() — Method in class Cache: Update the cached data with new data.
Editable::updateField() — Method in class Editable: Update a specific field for a row.
Filters::updatedFilters() — Method in class Filters: Handle updates to filter inputs.
Pagination::updatedPerPageDisplay() — Method in class Pagination: Update the per-page display value.
Pagination::usePagination() — Method in class Pagination: Enable or disable pagination.
RowManipulators::updateRowOnTable() — Method in class RowManipulators: Update a row's data in the table (and cache).
$ Search#useGlobalSearch — Property in class Search
Search::useGlobalSearch() — Method in class Search: Enable or disable global search.
Search::updatingSearch() — Method in class Search: Handle updates to the global search input.
Spinner::useTableSpinner() — Method in class Spinner: Enable or disable the table loading spinner.
StateHandler::useStateHandler() — Method in class StateHandler
$ View#useCards — Property in class View
View::useCards() — Method in class View

V

Columns::view() — Method in class Columns
View — Class in namespace Beartropy\Tables\Traits

W

$ BoolColumn#what_is_true — Property in class BoolColumn
$ ToggleColumn#what_is_true — Property in class ToggleColumn
$ Pagination#with_pagination — Property in class Pagination: Whether pagination is enabled.
$ YATBaseTable#with — Property in class YATBaseTable: An array of relationships to eager load.
$ YATBaseTable#with_pagination — Property in class YATBaseTable: Indicates if pagination is enabled.

Y

$ Bulk#yat_selected_checkbox — Property in class Bulk: Array of selected row IDs for bulk actions.
$ RowManipulators#yatable_expanded_rows — Property in class RowManipulators
$ RowManipulators#yatable_expanded_rows_is_component — Property in class RowManipulators
$ RowManipulators#yatable_expanded_rows_content — Property in class RowManipulators
$ Search#yat_global_search — Property in class Search
$ Search#yat_global_search_label — Property in class Search
$ View#yat_most_left_view — Property in class View
$ View#yat_less_left_view — Property in class View
$ View#yat_most_right_view — Property in class View
$ View#yat_less_right_view — Property in class View
$ View#yat_is_mobile — Property in class View
$ View#yat_custom_buttons — Property in class View
$ View#yat_button_variant — Property in class View
$ View#yat_card_modal_buttons — Property in class View
YATBaseTable — Class in namespace Beartropy\Tables: Base Table Component.
YATProvider — Class in namespace Beartropy\Tables: Service Provider for Beartropy Tables.

_

BoolColumn::__construct() — Method in class BoolColumn: Create a new BoolColumn instance.
Column::__construct() — Method in class Column: Create a new Column instance.
DateColumn::__construct() — Method in class DateColumn: Create a new DateColumn instance.
LinkColumn::__construct() — Method in class LinkColumn: Create a new LinkColumn instance.
ToggleColumn::__construct() — Method in class ToggleColumn: Create a new ToggleColumn instance.
Filter::__construct() — Method in class Filter
FilterBool::__construct() — Method in class FilterBool: Create a new FilterBool instance.
FilterDateRange::__construct() — Method in class FilterDateRange: Create a new FilterDateRange instance.
FilterSelect::__construct() — Method in class FilterSelect: Create a new FilterSelect instance.
FilterSelectMagic::__construct() — Method in class FilterSelectMagic: Create a new FilterSelectMagic instance.
FilterString::__construct() — Method in class FilterString: Create a new FilterString instance.
GenericExport::__construct() — Method in class GenericExport