Module background/methods/redirect

Index

Functions

Functions

redirect

redirect(history: { push: any }, path: string, event?: { preventDefault: any }): void

- Defined in src/background/methods/redirect.ts:28
Prevent the default event and redirect to a new path, but only if it's different from the current path.

Parameters
- history: { push: any }
  
  { push: (path: string) => void }
  - push:function
    - push(path: string): void
    - Defined in src/background/methods/redirect.ts:29
      Parameters
      - path: string
      Returns void
- path: string
  
  The path to redirect to.
- Optional event: { preventDefault: any }
  - preventDefault:function
    - preventDefault(): void
    - Defined in src/background/methods/redirect.ts:31
      Returns void
Returns void

scrollToElement

scrollToElement(history: { push: any }, id: string, event?: { preventDefault: any }): void

- Defined in src/background/methods/redirect.ts:7
It scrolls to the element with the given id, and if the event is not null, it prevents the default action of the event

Parameters
- history: { push: any }
  
  This is the history object from React Router.
  - push:function
    - push(path: string): void
    - Defined in src/background/methods/redirect.ts:8
      Parameters
      - path: string
      Returns void
- id: string
  
  The id of the element to scroll to
- Optional event: { preventDefault: any }
  - preventDefault:function
    - preventDefault(): void
    - Defined in src/background/methods/redirect.ts:10
      Returns void
Returns void

Generated using TypeDoc version 0.22.15, the 4/20/2022