Class Portal

Hierarchy

  • SvelteComponentTyped<PortalProps, PortalEvents, PortalSlots>
    • Portal

Constructors

constructor

Properties

$$bindings? $$events_def $$prop_def $$slot_def element?

Methods

$destroy $on $set

Constructors

constructor

  • new Portal(options): Portal

  • Parameters

    • options: ComponentConstructorOptions<Properties<{
          target?: string | HTMLElement;
      }, {
          default: {};
      }>>

    Returns Portal

    Deprecated

    This constructor only exists when using the asClassComponent compatibility helper, which is a stop-gap solution. Migrate towards using mount instead. See migration guide for more info.

Properties

Optional$$bindings

$$bindings?: string

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

DO NOT USE!

$$events_def

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

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

DO NOT USE!

$$prop_def

$$prop_def: {
    target?: string | HTMLElement;
}

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

DO NOT USE!

Type declaration

  • Optionaltarget?: string | HTMLElement

    DOM Element or CSS Selector

$$slot_def

$$slot_def: {
    default: {};
}

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

DO NOT USE!

Static Optionalelement

element?: {
    prototype: HTMLElement;
    new (): HTMLElement;
}

The custom element version of the component. Only present if compiled with the customElement compiler option

Methods

$destroy

  • $destroy(): void

  • Returns void

    Deprecated

    This method only exists when using one of the legacy compatibility helpers, which is a stop-gap solution. See migration guide for more info.

$on

  • $on<K>(type, callback): (() => void)

  • Type Parameters

    • K extends string

    Parameters

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

        • Parameters

          • e: CustomEvent<any>

          Returns void

    Returns (() => void)

      • (): void

      • Returns void

    Deprecated

    This method only exists when using one of the legacy compatibility helpers, which is a stop-gap solution. See migration guide for more info.

$set

  • $set(props): void

  • Parameters

    • props: Partial<{
          target?: string | HTMLElement;
      }>

    Returns void

    Deprecated

    This method only exists when using one of the legacy compatibility helpers, which is a stop-gap solution. See migration guide for more info.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods