Actions Redirect

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

This document explains the Actions Redirect service in the Components Library.

Overview

Actions Redirect is an Angular Service that performs the hard redirect to the URL.

Check out an example usage of the Actions Redirect.

Service configuration:

  • type—an action type.
  • url—a URL to redirect.
<spy-button-action
    [action]="{
        type: 'redirect',
        url: 'https://spryker.com',
    }"
>
</spy-button-action>

Service registration

Register the service:

declare module '@spryker/actions' {
    interface ActionsRegistry {
        redirect: RedirectActionHandlerService;
    }
}

@NgModule({
    imports: [
        ActionsModule.withActions({
            redirect: RedirectActionHandlerService,
        }),
    ],
})
export class RootModule {}

Interfaces

Below you can find interfaces for the Actions Redirect:

export interface RedirectActionConfig extends ActionConfig {
    url: string;
}