Actions Refresh Table

Edit on GitHub
You are browsing a previous version of the document. The latest version is 202212.0.

This document explains the Actions Refresh Table service in the Components Library.

Overview

Actions Refresh Table is an Angular Service that refreshes data of the table in the current context.

Check out an example usage of the Actions Refresh Table.

Service configuration:

  • type—an action type.
  • tableId—an id of the table that will be refreshed.
<spy-button-action
    [action]="{
        type: 'refresh-table',
        tableId: 'table-id',
    }"
>
</spy-button-action>

Service registration

Register the service:

declare module '@spryker/actions' {
    interface ActionsRegistry {
        'refresh-table': RefreshTableActionHandlerService;
    }
}

@NgModule({
    imports: [
        ActionsModule.withActions({
            'refresh-table': RefreshTableActionHandlerService,
        }),
    ],
})
export class RootModule {}

Interfaces

Below you can find interfaces for Actions Refresh Table:

export interface RefreshTableActionConfig extends ActionConfig {
    tableId?: string;
}