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


  • className
  • user




The attributes passed into the component.

element: Element

The root DOM element for the component.

isDraggedOver: undefined | boolean

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

loading: undefined | boolean

Whether or not an avatar upload is in progress.

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.


  • 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.


    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node


  • 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.


    Returns void

Generated using TypeDoc v0.24.8