LabelProps

Since 0.6

Signature

export interface LabelProps {
  /** Show this key instead of the component's. */
  textKey?: string
  /** Do not show the label until an event asks for it. */
  hidden?: boolean
  /** Event name → the key to show (or null to hide). */
  setText?: Record<string, string | null>
  /** A string table, when the host does not provide one. */
  strings?: Record<string, string>
}

Import: import type { LabelProps } from "@argus/gameplay"

Members

Member	Signature	Description
`textKey`	`textKey?: string`	Show this key instead of the component's.
`hidden`	`hidden?: boolean`	Do not show the label until an event asks for it.
`setText`	`setText?: Record<string, string \| null>`	Event name → the key to show (or null to hide).
`strings`	`strings?: Record<string, string>`	A string table, when the host does not provide one.