Options
All
  • Public
  • Public/Protected
  • All
Menu

The AvatarEditor component displays a user's avatar along with a dropdown menu which allows the user to upload/remove the avatar.

Attrs

  • className
  • user

Hierarchy

Index

Constructors

constructor

Properties

attrs

The attributes passed into the component.

see

https://mithril.js.org/components.html#passing-data-to-components

element

element: Element

The root DOM element for the component.

isDraggedOver

isDraggedOver: undefined | boolean

Whether or not an image has been dragged over the dropzone.

loading

loading: undefined | boolean

Whether or not an avatar upload is in progress.

state

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

Methods

$

  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

controlItems

disableDragover

  • disableDragover(e: DragEvent): void

dropUpload

  • dropUpload(e: DragEvent): void

enableDragover

  • enableDragover(e: DragEvent): void

Protected failure

  • failure(response: object): void

onbeforeremove

onbeforeupdate

oncreate

oninit

  • oninit(vnode: any): void

onremove

onupdate

openPicker

  • openPicker(): void

quickUpload

  • quickUpload(e: MouseEvent): void
  • If the user doesn't have an avatar, there's no point in showing the controls dropdown, because only one option would be viable: uploading. Thus, when the avatar editor's dropdown toggle button is clicked, we prompt the user to upload an avatar immediately.

    Parameters

    • e: MouseEvent

    Returns void

remove

  • remove(): void

Protected success

  • success(response: object): void
  • After a successful upload/removal, push the updated user data into the store, and force a recomputation of the user's avatar color.

    Parameters

    • response: object

    Returns void

upload

  • upload(file: File): void

view

  • view(): Element

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs(attrs: unknown): void

Generated using TypeDoc version 0.22.10