Class AuthorizationGuard

Authorization wrapper.

Example

<Authorization passCondition={$isAuthenticated && !$isLoading} redirect="/auth/login">
<slot />
</Authorization>

Hierarchy

  • SvelteComponent<AuthorizationGuardProps, AuthorizationGuardEvents, AuthorizationGuardSlots>
    • AuthorizationGuard

Constructors

constructor

Properties

$$ $$events_def $$prop_def $$set $$slot_def

Methods

$capture_state $destroy $inject_state $on $set

Constructors

constructor

  • Parameters

    • options: ComponentConstructorOptions<{
          loadingComponent?: null | typeof SvelteComponent;
          passCondition: boolean;
          redirect?: string;
      }>

    Returns AuthorizationGuard

Properties

$$

$$: any

PRIVATE API

Do not use, may change at any time

$$events_def

$$events_def: {
    [evt: string]: CustomEvent<any>;
}

For type checking capabilities only. Does not exist at runtime.

DO NOT USE!

Type declaration

  • [evt: string]: CustomEvent<any>

$$prop_def

$$prop_def: {
    loadingComponent?: null | typeof SvelteComponent;
    passCondition: boolean;
    redirect?: string;
}

For type checking capabilities only. Does not exist at runtime.

DO NOT USE!

Type declaration

  • Optional loadingComponent?: null | typeof SvelteComponent

    Component to render while loading/authenticating.

    Example

    <div
      class="flex h-full min-h-[calc(100dvh-4rem)] w-full flex-col items-center justify-center px-4 pb-16"
    >
      <h1 class="mt-5 text-3xl md:text-5xl">Authenticating...</h1>
    </div>
  • passCondition: boolean

    Condition to pass the authorization check.

  • Optional redirect?: string

    Redirect to this path if the user is not authorized.

    Default

    '/'

$$set

$$set: any

PRIVATE API

Do not use, may change at any time

$$slot_def

$$slot_def: {
    default: {};
}

For type checking capabilities only. Does not exist at runtime.

DO NOT USE!

Type declaration

  • default: {}

    Methods

    $capture_state

    • $capture_state(): void

    • Returns void

    $destroy

    • $destroy(): void

    • Returns void

    $inject_state

    • $inject_state(): void

    • Returns void

    $on

    • $on<K extends string>(type: K, callback: undefined | null | ((e: CustomEvent<any>) => void)): (() => void)

    • Type Parameters

      • K extends string

      Parameters

      • type: K
      • callback: undefined | null | ((e: CustomEvent<any>) => void)

      Returns (() => void)

        • (): void

        • Returns void

    $set

    • $set(props: Partial<{
          loadingComponent?: null | typeof SvelteComponent;
          passCondition: boolean;
          redirect?: string;
      }>): void

    • Parameters

      • props: Partial<{
            loadingComponent?: null | typeof SvelteComponent;
            passCondition: boolean;
            redirect?: string;
        }>

      Returns void

    On This Page

    Generated using TypeDoc v0.25.2