Skip to content

Commit 8e85537

Browse files
committed
Update readme for final 3.0.0 release
1 parent eca9489 commit 8e85537

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
### Version 3.0
22

3-
The `3.0.0-beta` version is now available! This should resolve a number of text handling issues and lay the groundwork for better support of mixed text and token input. This version is still a little unstable, so I would only recommend it if you are having trouble using version `2.0.8`. You can find the docs for `2.0.8` [here](https://github.com/splitwise/TokenAutoComplete/tree/2.0.8).
3+
The `3.0.0` version is now available! This should resolve a number of text handling issues and lay the groundwork for better support of mixed text and token input. If you're still on `2.*`, you can find the docs for `2.0.8` [here](https://github.com/splitwise/TokenAutoComplete/tree/2.0.8).
44

55
### Upgrading from 2.* to 3.0
66

77
For most developers, the migration should be fairly simple. Here are the likely issues you'll need to resolve:
88

99
1. The view now inherits from `AppCompatAutoCompleteTextView`. You probably don't need to make any changes for this, but you will need to include the Android support library if you are not already.
1010

11-
1. `setTokenDeleteStyle` has been removed. Something similar to the Clear style has been hardcoded in. This feature never worked reliably and caused a lot of crashes.
11+
2. `setTokenDeleteStyle` has been removed. Something similar to the Clear style has been hardcoded in. This feature never worked reliably and caused a lot of crashes.
1212

13-
1. `addObject` has been renamed `addObjectAsync`. `removeObject` has been renamed `removeObjectAsync`. There are also `addObjectSync`/`removeObjectSync` versions that can be called from the UI thread and guarantee that `getObjects` will include these changes on the next call.
13+
3. `addObject` has been renamed `addObjectAsync`. `removeObject` has been renamed `removeObjectAsync`. There are also `addObjectSync`/`removeObjectSync` versions that can be called from the UI thread and guarantee that `getObjects` will include these changes on the next call.
1414

15-
1. `setAllowDuplicates(false)` has been made more flexible to deal with issues around different kinds of equality. If you need the 2.* version of the behavior, add this to your `TokenCompleteTextView` subclass:
15+
4. `setAllowDuplicates(false)` has been made more flexible to deal with issues around different kinds of equality. If you need the 2.* version of the behavior, add this to your `TokenCompleteTextView` subclass:
1616

1717
```
1818
@Override
@@ -21,7 +21,7 @@ public boolean shouldIgnoreToken(T token) {
2121
}
2222
```
2323

24-
1. `TokenListener` has a new method you will need to add:
24+
5. `TokenListener` has a new method you will need to add:
2525

2626
```
2727
public interface TokenListener<T> {
@@ -31,7 +31,7 @@ public interface TokenListener<T> {
3131
}
3232
```
3333

34-
1. `convertSerializableArrayToObjectArray` has been renamed `convertSerializableObjectsToTypedObjects`.
34+
6. `convertSerializableArrayToObjectArray` has been renamed `convertSerializableObjectsToTypedObjects`.
3535

3636
You may also find that the vertical alignment of your tokens has changed. It appears that the app compat text view layout is slightly different than the normal one. You will likely find that you need to adjust the baseline values for your token views.
3737

@@ -58,15 +58,15 @@ Setup
5858
### Gradle
5959
```
6060
dependencies {
61-
compile "com.splitwise:tokenautocomplete:3.0.0-beta@aar"
61+
compile "com.splitwise:tokenautocomplete:3.0.0@aar"
6262
}
6363
```
6464
### Maven
6565
```
6666
<dependency>
6767
<groupId>com.splitwise</groupId>
6868
<artifactId>tokenautocomplete</artifactId>
69-
<version>3.0.0-beta</version>
69+
<version>3.0.0</version>
7070
<type>aar</type>
7171
</dependency>
7272
```
@@ -203,7 +203,7 @@ Layout code
203203
android:layout_width="match_parent"
204204
android:layout_height="match_parent">
205205

206-
<com.tokenautocomplete.ContactsCompletionView
206+
<com.yourpackagename.ContactsCompletionView
207207
android:id="@+id/searchView"
208208
android:layout_width="match_parent"
209209
android:layout_height="wrap_content" />
@@ -504,7 +504,7 @@ These options should allow you to build something similar to a Tweet composing v
504504
preventFreeFormText(false);
505505
```
506506
507-
* Get the string value of the text content of the view, including reasonable string representations of the tokens. If `getContextText` is not using an acceptable string representation of the token, you can overrid `tokenToString` to change how the token is represented.
507+
* Get the string value of the text content of the view, including reasonable string representations of the tokens. If `getContextText` is not using an acceptable string representation of the token, you can override `tokenToString` to change how the token is represented.
508508
```java
509509
getContentText();
510510
```

0 commit comments

Comments
 (0)