https://github.com/utsavdotpro/searchablelistdialog
Bottom Dialog Searchable List built with Material.io
https://github.com/utsavdotpro/searchablelistdialog
android android-library java listview search-list-view
Last synced: about 2 months ago
JSON representation
Bottom Dialog Searchable List built with Material.io
- Host: GitHub
- URL: https://github.com/utsavdotpro/searchablelistdialog
- Owner: utsavdotpro
- Created: 2021-03-14T16:35:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-22T18:53:42.000Z (almost 3 years ago)
- Last Synced: 2025-02-03T10:12:09.414Z (4 months ago)
- Topics: android, android-library, java, listview, search-list-view
- Language: Java
- Homepage:
- Size: 3.27 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://jitpack.io/#utsavdotpro/SearchableListDialog)
# SearchableListDialog
Bottom Dialog Searchable List built with Material.io with custom search bar and custom list item view.
## Sample
| | |
| - | - |
| 
| 
|
| 
| 
|
## Features
- Works with literally any type of data
- One-on-one comparison
- Auto empty view
- Portable
- Clean UI
- Pre-optimized
- Easy to use
- Lightweight
---
## Implementation
**Step 1:** Add to project level build.gradle
```gradle
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
**Step 2:** Add to app level build.gradle
```gradle
dependencies {
implementation 'com.github.utsavdotpro:SearchableListDialog:VERSION'
}
```
---
## How to use?
In this example, I am creating a dialog search list for a list of customers with their name and business name. You can easily understand how it works from the example and implement according to your requirements.
- You can use any kind of object to populate and search for in the list
- Here, I have created a simple object `Customer` with basic setters and getters
> You can also check out the [example app](https://github.com/utsavdotpro/SearchableListDialog/tree/main/app/src/main/java/com/isolpro/searchablelistdialoglibrary)
### Creating List Adapter
SearchableListAdapter is built from BaseAdapter with only addition of `setItems()` and `getItems()` methods
```java
public class CustomersSearchableListAdapter extends SearchableListAdapter {
private final Context context;
private List customerList = new ArrayList<>();
public CustomersSearchableListAdapter(Context context) {
this.context = context;
}
@Override
public int getCount() {
return customerList.size();
}
@Override
public Customer getItem(int position) {
return customerList.get(position);
}
@Override
public long getItemId(int position) {
return customerList.get(position).getId();
}
@Override
public View getView(int position, View convertView, ViewGroup parent) {
ViewHolder holder = createNewOrGetExistingViewHolder(convertView);
holder.populateView(getItem(position));
convertView = holder.getBinding().getRoot();
convertView.setTag(holder);
return convertView;
}
private ViewHolder createNewOrGetExistingViewHolder(View view) {
if (view != null)
return (ViewHolder) view.getTag();
ListCustomerItemBinding binding = ListCustomerItemBinding.inflate(LayoutInflater.from(context));
return new ViewHolder(binding);
}
@Override
public List getItems() {
return customerList;
}
@Override
public void setItems(List customerList) {
this.customerList = customerList;
notifyDataSetChanged();
}
public class ViewHolder {
private final ListCustomerItemBinding binding;
public ViewHolder(ListCustomerItemBinding binding) {
this.binding = binding;
}
public ListCustomerItemBinding getBinding() {
return binding;
}
public void populateView(Customer customer) {
binding.tvName.setText(customer.getName());
binding.tvBusinessName.setText(customer.getBusinessName());
}
}
}
```
### Creating Dialog
```java
private CustomersSearchableListAdapter customersListAdapter;
private SearchableListDialog dialogListCustomers;
customersListAdapter = new CustomersSearchableListAdapter(activity);
dialogListCustomers = new SearchableListDialog<>(activity, customersListAdapter);
```
### Setting Items
Careful! Make sure you set the items to you `dialogListCustomers` and not `customersListAdapter`
```java
dialogListCustomers.setItems(customerList);
```
### Defining Search Matcher
Since SLD doesn't work with any specific object type, you have to define your own matcher(). This gives SLD its portability and you freedom to compare any way you like.
```java
dialogListCustomers.setSearchMatcher((customer, keyword) -> {
return customer.getName().toLowerCase().contains(keyword);
// return true if matched, else false
});
```
### Listening to Item Selection
```java
dialogListCustomers.setOnItemSelectedListener(customer -> {
// to whatever you like with the selected item (customer in this case)
});
```
---
> P.s. If you need me to write a better documentation, ping me at [email protected]