Skip to main content

FrontendAPIInterface

Properties

list

list: object

clearFilters()

Clear all filters from the list

Returns

void

closeThreeDotsDropdown()

Close the three dots dropdown

Returns

void

closeUserMenuDropdown()

Close the user menu dropdown

Returns

void

refresh()

Full refresh the list. Loader will be shown during fetching data. Will fully reload table data from the server. If new data available, it will be shown in the list.

Returns

Promise<object>

error?

optional error: string

setFilter()

Set a filter in the list Works only when user located on the list page. Can be used to set filter from charts or other components in pageInjections.

Example:

window.adminforth.list.setFilter({field: 'name', operator: 'ilike', value: 'john'})
Parameters
ParameterTypeDescription
filteranyThe filter to set
Returns

void

silentRefresh()

Silently Refresh existing rows in the list (without loader). Should be called when table data already loaded, otherwise method will return an error. If new data available, it will not appear in the list.

Returns

Promise<object>

error?

optional error: string

silentRefreshRow()

Refresh a specific row in the list without loader, row should be already shown in the list, otherwise method will return an error

Parameters
ParameterType
pkany
Returns

Promise<object>

error?

optional error: string

updateFilter()

Update a filter in the list

Example:

window.adminforth.list.updateFilter({field: 'name', operator: 'ilike', value: 'john'})
Parameters
ParameterTypeDescription
filteranyThe filter to update
Returns

void


menu: object

refreshMenuBadges()

Refreshes the badges in the menu, by recalling the badge function for each menu item

Returns

void

Methods

alert()

alert(params): void

Show an alert

The alert will be displayed to the user

Example:

 window.adminforth.alert({message: 'Hello', variant: 'success'})

Parameters

ParameterTypeDescription
paramsAlertParamsThe parameters of the alert

Returns

void


confirm()

confirm(params): Promise<void>

Show a confirmation dialog

The dialog will be displayed to the user

Example:

const isConfirmed = await window.adminforth.confirm({message: 'Are you sure?', yes: 'Yes', no: 'No'})
if (isConfirmed) {
your code...
}

Parameters

ParameterTypeDescription
paramsConfirmParamsThe parameters of the dialog

Returns

Promise<void>

A promise that resolves when the user confirms the dialog