TextMatcher

A simple text watcher that matches specific targets like mention or hashtag in a string by defining rules

How It Works

What is Style

Style is basically a clickable span which lets you customize visual attributes of targets.

It's also used to differentiate between targets. So it's strongly recommended to have a different style for each single rule.

Basic example:

class CustomStyle : Style() {

  override fun updateDrawState(ds: TextPaint) {
    super.updateDrawState(ds)
    ds.apply {
      isUnderlineText = false
      color = Color.DKGRAY
      typeface = Typeface.create(Typeface.MONOSPACE, Typeface.BOLD)
    }
  }
}

There are 3 built-in styles for easy implementation. This can be changed in future according to needs.

1. SimpleStyle is a open class which takes textColor, isUnderline, isBold and typeface as parameter to let you easily change these attributes without creating or overriding any method. For further customizations you can still override the updateDrawState method

2. MentionStyle extends from SimpleStyle and intended to use only for mentions

3. HashtagStyle extends from SimpleStyle and intended to use only for hashtags

What is Rule

Rule is simply definition of target boundaries and matching conditions. It's also used to apply styles for matching targets.

There are 3 built-in rules for easy implementation. This can be changed in future according to needs.

1. SimpleRule is a open class which takes prefixes, allowedCharacters and style as parameter which matches targets starting with prefixes and ending with space or any word breaking character.

2. MentionRule extends from SimpleRule and matches targets which starts with @

3. HashtagRule extends from SimpleRule and matches targets which starts with #

Widgets

There are 3 built-in widgets for easy implementation. This can be changed in future according to needs.

1. MatcherTextView

2. MatcherEditText

3. MatcherInputEditText

Usage

1. Define Style

val mentionStyle = MentionStyle(
  textColor = ContextCompat.getColor(this, R.color.colorPrimary),
  isBold = true
)

2. Define and Register Rule

val mentionRule = MentionRule(
  allowedCharacters = "._-",
  style = mentionStyle
)

editText.addRule(mentionRule)

3. Register Listeners

To receive matching results on typing:

editText.setOnMatchListener { rule, text ->
}

To receive matching target's click event:

editText.setOnMatchClickListener { text->
}

Gradle

allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}

dependencies {
  implementation 'com.github.santalu:textmatcher:1.0.6'
}

License

Copyright 2019 Fatih Santalu

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.