structures/ink.ui.structures/Sentiment

Sentiment

@Serializable

enum Sentiment : Enum<Sentiment>

Signifier for the purpose of a UI element.

This is used in place of styling, by indicating the purpose or state of a UI element.

Entries

@SerialName(value = "nominal")

Default, normal, state of an element.

@SerialName(value = "primary")

Indicate to the user that this is the preferred element.

@SerialName(value = "positive")

Indicate a successful or positive result for a UI element

@SerialName(value = "negative")

Indicate a failed or negative result for a UI element

@SerialName(value = "caution")

Indicate danger associated with a UI element

@SerialName(value = "idle")

Indicate inactivity or a lack of data for a UI element

Properties

val entries: EnumEntries<Sentiment>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val name: String

val ordinal: Int

Functions

fun valueOf(value: String): Sentiment

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<Sentiment>

Returns an array containing the constants of this enum type, in the order they're declared.