detectable_text_field

pub package License: MIT

Text widgets with detection feature. You can detect hashtags, at sign, or anything you want.

Refinement of hashtagable.

final

Usage

As TextField

    DetectableTextField(
      detectionRegExp: hashTagRegExp,
      detectedStyle: TextStyle(
        fontSize: 20,
        color: Colors.blue,
      ),
      basicStyle: TextStyle(
        fontSize: 20,
      ),
    )
  • detectionRegExp decides the text to detect. detectedStyle is the textStyle for detected text. basicStyle is the textStyle for not detected text.

  • Other arguments are basically same as material TextField.

As ReadOnlyText

If you want to use detection feature in the text only to display, DetectableText will help you.

    DetectableText(
      text: "#HashTag and @AtSign",
      detectionRegExp: hashTagAtSignRegExp,
      detectedStyle: TextStyle(
        fontSize: 20,
        color: Colors.blue,
      ),
      basicStyle: TextStyle(
        fontSize: 20,
      ),
      onTap: (tappedText){
        print(tappedText);
      },
    )

Usage of the arguments like detectionRegExp are same as the ones in DetectableTextField.

The argument onTap(String) is called when user tapped a detected text.

You can add some actions in this callback with the tapped text.

Sample RegExp

The widgets and methods in this package is expected to be used with RegExp. You can pick regExp from examples set in the package.

sample regExpdetection target
hashTagRegExpWords start with hashtag
atSignRegExpWords start with at sign
hashTagAtSignRegExpWords start with hashtag or at sign
  • The detection rules are almost same as twitter.
    1. It needs space before # or @.
    2. It stops detection if there's emoji or symbol.
  • The examples currently support six languages: English, Japanese, Korean, Spanish, Arabic, and Thai.

  • The sample for url detection is planned to be added.

Customize with useful functions

  • Check if there are detections
   print(isDetected("Hello #World", hashTagRegExp));
   // true

   print(isDetected("Hello World", hasgTagRegExp));
   // false

  • Extract detections from text
   final List<String> detections = extractDetections("#Hello World #Flutter Dart #Thank you", hashTagRegExp);
   // ["#Hello", "#Flutter", "#Thank"]

If you have any requests or questions, please feel free to ask on github.

Libraries

composer
detectable_editable_text
detectable_text
detectable_text_field
detectable_text_field
detector
functions
sample_regular_expressions