Skip to content

Commit 772135f

Browse files
committed
feat: Update README with troubleshooting and performance tips sections
1 parent a0bf615 commit 772135f

1 file changed

Lines changed: 57 additions & 2 deletions

File tree

README.md

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,16 @@
33
A high-performance, AI-powered AutoComplete (TypeAhead) component for Blazor applications with semantic search, OData integration, and vector database support. Also known as: autosuggest, combobox, searchable dropdown, live search.
44

55
[![NuGet](https://img.shields.io/nuget/v/EasyAppDev.Blazor.AutoComplete.svg)](https://www.nuget.org/packages/EasyAppDev.Blazor.AutoComplete/)
6+
[![NuGet Downloads](https://img.shields.io/nuget/dt/EasyAppDev.Blazor.AutoComplete.svg)](https://www.nuget.org/packages/EasyAppDev.Blazor.AutoComplete/)
7+
[![GitHub stars](https://img.shields.io/github/stars/mashrulhaque/EasyAppDev.Blazor.AutoComplete?style=social)](https://github.com/mashrulhaque/EasyAppDev.Blazor.AutoComplete)
68
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
79
[![.NET](https://img.shields.io/badge/.NET-8.0%20%7C%209.0%20%7C%2010.0-blue)](https://dotnet.microsoft.com/)
810

9-
**[Live Demo](https://blazorautocomplete.easyappdev.com/)** | [NuGet Package](https://www.nuget.org/packages/EasyAppDev.Blazor.AutoComplete/) | [Documentation](#documentation)
11+
**[Live Demo](https://blazorautocomplete.easyappdev.com/)** | [NuGet Package](https://www.nuget.org/packages/EasyAppDev.Blazor.AutoComplete/) | [Get Started](#quick-start)
12+
13+
<p align="center">
14+
<img src="https://blazorautocomplete.easyappdev.com/images/demo-preview.gif" alt="Blazor AutoComplete Demo" width="600" />
15+
</p>
1016

1117
---
1218

@@ -65,6 +71,8 @@ A high-performance, AI-powered AutoComplete (TypeAhead) component for Blazor app
6571
- [API Reference](#api-reference)
6672
- [Packages](#packages)
6773
- [Requirements](#requirements)
74+
- [Performance](#performance)
75+
- [Troubleshooting](#troubleshooting)
6876
- [Support](#support)
6977

7078
---
@@ -320,7 +328,7 @@ Full control over rendering:
320328
</HeaderTemplate>
321329
<FooterTemplate>
322330
<div class="dropdown-footer text-muted small">
323-
Showing @context.Count results
331+
Type to search products
324332
</div>
325333
</FooterTemplate>
326334
</AutoComplete>
@@ -1171,6 +1179,53 @@ public static class AutoCompleteConstants
11711179

11721180
---
11731181

1182+
## Troubleshooting
1183+
1184+
### Common Issues
1185+
1186+
**Component not rendering / styles missing**
1187+
```html
1188+
<!-- Ensure CSS is added to App.razor or index.html -->
1189+
<link href="_content/EasyAppDev.Blazor.AutoComplete/styles/autocomplete.base.css" rel="stylesheet" />
1190+
```
1191+
1192+
**Dropdown not opening**
1193+
- Check that `Items` or `DataSource` is not null/empty
1194+
- Verify `MinSearchLength` - default is 1 character before filtering
1195+
1196+
**Items not filtering**
1197+
- Ensure `TextField` expression returns a non-null string
1198+
- Check `FilterStrategy` matches your use case (StartsWith vs Contains)
1199+
1200+
**Virtualization not working**
1201+
- Set `Virtualize="true"` explicitly
1202+
- Ensure `ItemHeight` matches your actual item height in pixels
1203+
- Check that item count exceeds `VirtualizationThreshold` (default: 100)
1204+
1205+
**OData requests failing**
1206+
- Verify `EndpointUrl` is correct and accessible
1207+
- Check CORS configuration on server
1208+
- Use browser DevTools Network tab to inspect generated OData queries
1209+
1210+
**Semantic search returning no results**
1211+
- Lower `SimilarityThreshold` (try 0.1 instead of 0.15)
1212+
- Ensure `MinSearchLength` is met (default: 3 for AI)
1213+
- Verify OpenAI/Azure API key is valid
1214+
- Check browser console for API errors
1215+
1216+
**AOT/Trimming build errors**
1217+
- Ensure you're using the latest package version
1218+
- The component is fully AOT-compatible; if issues persist, check for conflicts with other libraries
1219+
1220+
### Performance Tips
1221+
1222+
- Use `FilterStrategy.StartsWith` for fastest filtering
1223+
- Enable `Virtualize="true"` for datasets > 100 items
1224+
- Set appropriate `DebounceMs` (300-500ms) to reduce API calls
1225+
- For AI search, enable `PreWarmCache="true"` to pre-generate embeddings
1226+
1227+
---
1228+
11741229
## License
11751230

11761231
MIT License - see [LICENSE](LICENSE)

0 commit comments

Comments
 (0)