edge_dewey/com.microsoft.edge.dewey.avatar/DeweyAvatar

DeweyAvatar

class DeweyAvatar @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null) : FrameLayout

A custom view for displaying an avatar image with a state badge.

The avatar image can be set using setImageBitmap, setImageResource, or setImageDrawable. Before showing the image, the avatar will display a placeholder image based on the Placeholder.Type set using setImagePlaceholder. The avatar can also display a state badge using setStateBadge.

The size of the avatar is limited to a set of predefined Sizes, which can be set using setSize. Therefore, WRAP_CONTENT should be used for the height and width of the view.

Constructors

constructor(context: Context, attrs: AttributeSet? = null)

Types

object Companion

class Placeholder(mType: DeweyAvatar.Placeholder.Type)

For adding a placeholder image to the avatar view.

annotation class Size

The size of the avatar view. Width and height are set to the same value.

enum StateBadge : Enum<DeweyAvatar.StateBadge>

The state badge to display at the bottom right of the avatar.

enum UiMode : Enum<DeweyAvatar.UiMode>

Can be used to force the UI mode of the avatar view.

Functions

fun getImageView(): ImageView

Get the image view of the avatar. For customization purposes.

fun setImageBitmap(bitmap: Bitmap)

Set the image of the avatar using a bitmap.

setImageDrawable

fun setImageDrawable(drawable: Drawable?)

Set the image of the avatar using a drawable.

setImagePlaceholder

fun setImagePlaceholder(type: DeweyAvatar.Placeholder.Type)

Set the placeholder image to display before the avatar image is set.

setImageResource

fun setImageResource(@DrawableRes resId: Int)

Set the image of the avatar using a resource ID.

fun setSize(size: Int)

Set the size of the avatar view.

fun setStateBadge(stateBadge: DeweyAvatar.StateBadge)

Set the state badge to display at the bottom right of the avatar.

fun setUiMode(uiMode: DeweyAvatar.UiMode)

Set the UI mode of the avatar view. Can be used to force the UI mode to light or dark.