flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-10-29 16:05:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos&grammar in TextBoxComponent docs (#1091)

Browse Source
This commit is contained in:
Pasha Stetsenko
2021-11-12 00:05:45 -08:00
committed by GitHub
parent 0a7b87e202
commit 3a60f25401
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
packages/flame/lib/src/components/text_box_component.dart
View File

@ -10,25 +10,24 @@ import '../palette.dart';
import '../text.dart'; import '../text.dart';
import 'position_component.dart'; import 'position_component.dart';
/// A set of configurations for the [TextBoxComponent] itself (as opposed to /// A set of configurations for the [TextBoxComponent] itself, as opposed to
/// the [TextRenderer], that contains the configuration for how to render the /// the [TextRenderer], which contains the configuration for how to render the
/// text only (font size, color, family, etc)). /// text only (font size, color, family, etc).
class TextBoxConfig { class TextBoxConfig {
/// Max width this paragraph can take. Lines will be broken trying to respect /// Max width this paragraph can take. Lines will be broken trying to respect
/// word boundaries in as many lines as necessary. /// word boundaries in as many lines as necessary.
final double maxWidth; final double maxWidth;
/// Margins of the text box w.r.t the [PositionComponent.size]. /// Margins of the text box with respect to the [PositionComponent.size].
final EdgeInsets margins; final EdgeInsets margins;
/// Defaults to 0. If not zero the characters will appear one by one giving /// Defaults to 0. If not zero, the characters will appear one-by-one giving
/// a typying effect to the text box, and this will be the delay in seconds /// a typing effect to the text box, and this will be the delay in seconds
/// between each char. /// between each character.
final double timePerChar; final double timePerChar;
/// Defaults to 9. If not zero, this component will disapear this amount of /// Defaults to 0. If not zero, this component will disappear after this many
/// seconds after being completed (if [timePerChar] is set) or after first /// seconds after being fully typed out.
/// appearing (otherwise).
final double dismissDelay; final double dismissDelay;
/// Only relevant if [timePerChar] is set. If true, the box will start with /// Only relevant if [timePerChar] is set. If true, the box will start with