SelectableText constructor

const SelectableText(
  1. String data, {
  2. Key? key,
  3. FocusNode? focusNode,
  4. TextStyle? style,
  5. StrutStyle? strutStyle,
  6. TextAlign? textAlign,
  7. TextDirection? textDirection,
  8. TextScaler? textScaler,
  9. bool showCursor = false,
  10. bool autofocus = false,
  11. int? minLines,
  12. int? maxLines,
  13. double cursorWidth = 2.0,
  14. double? cursorHeight,
  15. Radius? cursorRadius,
  16. Color? cursorColor,
  17. BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight,
  18. BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight,
  19. DragStartBehavior dragStartBehavior = DragStartBehavior.start,
  20. bool enableInteractiveSelection = true,
  21. TextSelectionControls? selectionControls,
  22. GestureTapCallback? onTap,
  23. ScrollPhysics? scrollPhysics,
  24. String? semanticsLabel,
  25. TextHeightBehavior? textHeightBehavior,
  26. TextWidthBasis? textWidthBasis,
  27. SelectionChangedCallback? onSelectionChanged,
  28. bool useNativeContextMenu = false,
  29. EditableTextContextMenuBuilder? contextMenuBuilder = _defaultContextMenuBuilder,
  30. TextMagnifierConfiguration? magnifierConfiguration,
})

Creates selectable text from a plain string.

The data parameter is the text to display. All other parameters are optional and control various aspects of text rendering and selection.

Parameters:

  • data: The text string to display (required)
  • focusNode: Focus node for keyboard interaction
  • style: Text style for the content
  • strutStyle: Strut style for line height
  • textAlign: How to align text horizontally
  • textDirection: Text direction (LTR or RTL)
  • textScaler: Text scaling factor
  • showCursor: Whether to show the cursor (defaults to false)
  • autofocus: Auto-focus on mount (defaults to false)
  • minLines: Minimum number of lines to occupy
  • maxLines: Maximum number of lines before scrolling
  • cursorWidth: Width of cursor (defaults to 2.0)
  • cursorHeight: Height of cursor (null = line height)
  • cursorRadius: Cursor corner radius
  • cursorColor: Cursor color
  • selectionHeightStyle: Selection box height behavior
  • selectionWidthStyle: Selection box width behavior
  • dragStartBehavior: When to start drag gestures
  • enableInteractiveSelection: Enable selection (defaults to true)
  • selectionControls: Custom selection toolbar controls
  • onTap: Callback when text is tapped
  • scrollPhysics: Scroll behavior physics
  • semanticsLabel: Semantic label for accessibility
  • textHeightBehavior: How to handle line heights
  • textWidthBasis: Basis for measuring text width
  • onSelectionChanged: Callback when selection changes
  • useNativeContextMenu: Use platform context menu (defaults to false)
  • contextMenuBuilder: Custom context menu builder
  • magnifierConfiguration: Text magnifier configuration

Implementation

const SelectableText(
  String this.data, {
  super.key,
  this.focusNode,
  this.style,
  this.strutStyle,
  this.textAlign,
  this.textDirection,
  this.textScaler,
  this.showCursor = false,
  this.autofocus = false,
  this.minLines,
  this.maxLines,
  this.cursorWidth = 2.0,
  this.cursorHeight,
  this.cursorRadius,
  this.cursorColor,
  this.selectionHeightStyle = ui.BoxHeightStyle.tight,
  this.selectionWidthStyle = ui.BoxWidthStyle.tight,
  this.dragStartBehavior = DragStartBehavior.start,
  this.enableInteractiveSelection = true,
  this.selectionControls,
  this.onTap,
  this.scrollPhysics,
  this.semanticsLabel,
  this.textHeightBehavior,
  this.textWidthBasis,
  this.onSelectionChanged,
  this.useNativeContextMenu = false,
  this.contextMenuBuilder = _defaultContextMenuBuilder,
  this.magnifierConfiguration,
})  : assert(maxLines == null || maxLines > 0),
      assert(minLines == null || minLines > 0),
      assert(
        (maxLines == null) || (minLines == null) || (maxLines >= minLines),
        "minLines can't be greater than maxLines",
      ),
      textSpan = null;