FrontendAPIInterface
Properties
list
list:
object
clearFilters()
Clear all filters from the list
Returns
void
closeThreeDotsDropdown()
Close the three dots 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?
optionalerror: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:
import adminforth from '@/adminforth'
adminforth.list.setFilter({field: 'name', operator: 'ilike', value: 'john'})
Parameters
| Parameter | Type | Description |
|---|---|---|
filter | FilterParams | The 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?
optionalerror: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
| Parameter | Type |
|---|---|
pk | any |
Returns
Promise<object>
error?
optionalerror:string
updateFilter()
Update a filter in the list
Example:
import adminforth from '@/adminforth';
adminforth.list.updateFilter({field: 'name', operator: 'ilike', value: 'john'})
Parameters
| Parameter | Type | Description |
|---|---|---|
filter | FilterParams | The filter to update |
Returns
void
menu
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:
import adminforth from '@/adminforth'
adminforth.alert({message: 'Hello', variant: 'success'})
Parameters
| Parameter | Type | Description |
|---|---|---|
params | AlertParams | The parameters of the alert |
Returns
void
closeUserMenuDropdown()
closeUserMenuDropdown():
void
Close the user menu dropdown
Returns
void
confirm()
confirm(
params):Promise<void>
Show a confirmation dialog
The dialog will be displayed to the user
Example:
import adminforth from '@/adminforth'
const isConfirmed = await adminforth.confirm({message: 'Are you sure?', yes: 'Yes', no: 'No'})
if (isConfirmed) {
your code...
}
Parameters
| Parameter | Type | Description |
|---|---|---|
params | ConfirmParams | The parameters of the dialog |
Returns
Promise<void>
A promise that resolves when the user confirms the dialog