Function Label

Parameters

• params: {
      bold?: boolean;
      children?: ReactNode;
      className?: string;
      error?: boolean;
      for?: string;
      id?: string;
      maxHeight?: number;
      maxWidth?: number;
      minHeight?: number;
      minWidth?: number;
      style?: CSSProperties;
      tooltip?: string;
      variant?: LabelVariant;
      visible?: boolean;
      warning?: boolean;
      wrap?: boolean;
  }

  • Optionalbold?: boolean

    Whether to use a bold font weight.

  • Optionalchildren?: ReactNode

  • OptionalclassName?: string

  • Optionalerror?: boolean

    Whether to use an error colour.

  • Optionalfor?: string

    Indicates the form component this label connects to by its ID.

  • Optionalid?: string

  • OptionalmaxHeight?: number

  • OptionalmaxWidth?: number

  • OptionalminHeight?: number

  • OptionalminWidth?: number

  • Optionalstyle?: CSSProperties

  • Optionaltooltip?: string

    Tooltip text.

    To indicate placement side, add one of the following prefixes:

    • <?top?>
    • <?bottom?>
    • <?left?>
    • <?right?>

  • Optionalvariant?: LabelVariant

  • Optionalvisible?: boolean

    If false, excludes label from layout.

  • Optionalwarning?: boolean

    Whether to use a warning colour.

  • Optionalwrap?: boolean

    Whether to include word wrapping.