Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Uppload

Uppload image uploading widget

Hierarchy

  • Uppload

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create a new Uppload instance

    Parameters

    Returns Uppload

Properties

activeEffect

activeEffect: string = ""

activeService

activeService: string = "default"

container

container: HTMLDivElement

effects

effects: UpploadEffect[] = []

emitter

emitter: Emitter<Record<EventType, unknown>> = ...

Optional error

error?: string

file

file: IUpploadFile = ...

focusTrap

focusTrap: FocusTrap

inline

inline: boolean = false

isOpen

isOpen: boolean = false

lang

lang: ILanguage = {}

services

services: UpploadService[] = ...

settings

settings: IUpploadSettings

transitionDuration

transitionDuration: number = 300

uId

uId: string = ""

uploadProgress

uploadProgress: number = 0

Optional uploader

uploader?: IUploader | IMultipleUploader

Methods

Private bind

  • bind(value: string): void

  • Bind the image URL value to DOM elements

    Parameters

    • value: string

      URL of the image

    Returns void

close

  • close(): void

  • Close the Uppload widget

    Returns void

compress

  • compress(file: Blob): Promise<Blob>

  • Parameters

    • file: Blob

    Returns Promise<Blob>

Private getEffectsNavbar

  • getEffectsNavbar(): string

  • Returns the HTML template for the effects navbar

    Returns string

Private getNavbar

  • getNavbar(sidebar?: boolean): string

  • Returns the HTML template for the services navbar

    Parameters

    • sidebar: boolean = false

      Whether this is an input radio (for sidebar) or buttons (for home)

    Returns string

Private handle

  • handle(error: Error): void

  • Gracefully display an error message

    Parameters

    • error: Error

      Error to display

    Returns void

Private handlers

  • handlers(): void

  • Adds event handlers for the widget

    Returns void

hideHelp

  • hideHelp(): void

  • Returns void

Private install

  • Install a new uploader, service, or effect to this instance

    Parameters

    Returns void

modalOpen

  • modalOpen(): boolean

  • Returns whether the modal is currently open

    Returns boolean

navigate

  • navigate(service: string): void

  • Navigate to an Uppload service page

    Parameters

    • service: string

      Slug name of service (e.g., instagram)

    Returns void

Private next

  • Updates the file and goes to the active effect

    Parameters

    Returns undefined | Promise<string>

off

  • off(type: string, handler: (event?: any) => void): void

  • Remove an event listener

    Parameters

    • type: string

      Type of event listener (e.g., open)

    • handler: (event?: any) => void

      Event handler function

        • (event?: any): void

        • Parameters

          • Optional event: any

          Returns void

    Returns void

on

  • on(type: string, handler: (event?: any) => void): void

  • Add an event listener

    Parameters

    • type: string

      Type of event listener (e.g., open)

    • handler: (event?: any) => void

      Event handler function

        • (event?: any): void

        • Parameters

          • Optional event: any

          Returns void

    Returns void

open

  • open(): void

  • Open the Uppload widget

    Returns void

Private ready

  • ready(): void

  • Returns void

remove

  • remove(slug: string): void

  • Remove a plugin (effect or serve) from this instance

    Parameters

    • slug: string

      Slug of the plugin to be removed

    Returns void

Private render

  • render(): string

  • Render the content inside the widget container

    Returns string

Private renderActiveEffect

  • Render the currently active effect

    Parameters

    Returns undefined | string

Private renderActiveService

  • renderActiveService(): undefined | string

  • Render the currently active service

    Returns undefined | string

Private renderContainer

  • renderContainer(): void

  • Renders the main container for the widget

    Returns void

showHelp

  • showHelp(url: string): void

  • Show the help article for this plugin in a frame

    Parameters

    • url: string

      URL of help webpage

    Returns void

Private stopCurrentService

  • stopCurrentService(): void

  • Stops any actions being done by the currently active service For example, if your webcame is being accessed, kill that process

    Returns void

toggle

  • toggle(): void

  • Toggles the Uppload widget

    Returns void

Private update

  • update(): void

  • Re-render the widget

    Returns void

updatePlugins

  • Update the plugins for this instance

    Parameters

    Returns void

Private updateProgress

  • updateProgress(progressPercent: number): void

  • Updates the upload progress

    Parameters

    • progressPercent: number

      Current progress in percent

    Returns void

updateSettings

  • Update widget settings such as i18n

    Parameters

    Returns void

upload

  • upload(file: Blob | File): Promise<string>

  • Upload a file to the server

    Parameters

    • file: Blob | File

      A Blob object containing the file to upload

    Returns Promise<string>

    The file URL

Private uploadMultiple

  • uploadMultiple(file: Blob[]): Promise<any>

  • Uploads multiple files to the server

    Parameters

    • file: Blob[]

    Returns Promise<any>

    JSON response from server

use

Generated using TypeDoc