textFieldLayout property

String get textFieldLayout

Phrase to shown when the command is invoked by the end dev. Few provide the devs a good experiece and ease in command use. You can follow few of the good practises:

  • Keep it Short - Try to keep the phrase as short and precise much as possible.
  • Keep it Useful - Don't try to include additional words or phrases that are not required and don't serve any purpose.
  • Mention Inputs Required by Command - Make sure to ask all the inputs (such as the query, code, whatever is needed by the command). So that it is easier for the end dev to understand the futher inputs that is required to be shared

Example:

@override
  String get textFieldLayout =>
      "Hey, I'm here to help setting firebase in your project. Please share the firebase services you want to include $userRequirement";

Here, userRequirement is DashInput variable whose value will be provided by the user at runtime

Implementation

/// @override
///   String get textFieldLayout =>
///       "Hey, I'm here to help setting firebase in your project. Please share the firebase services you want to include $userRequirement";
/// ```
/// Here, `userRequirement` is DashInput variable whose value will be provided
/// by the user at runtime
String get textFieldLayout;