Dirkster.SuggestBoxLib 1.2.1

Provides a WPF/MVVM AutoComplete control

Install-Package Dirkster.SuggestBoxLib -Version 1.2.1
dotnet add package Dirkster.SuggestBoxLib --version 1.2.1
<PackageReference Include="Dirkster.SuggestBoxLib" Version="1.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Dirkster.SuggestBoxLib --version 1.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Build status Release NuGet

Net4 NetCore3

The SuggestBox control in this repository was originally developed by <b>Leung Yat Chun Joseph <a href="https://github.com/lycj">lycj</a></b> in his FileExplorer application originating from CodePlex and <a href="https://www.codeproject.com/Members/Fainx">CodeProject</a>.

SuggestBoxLib

<h2><img src="https://raw.githubusercontent.com/Dirkster99/Docu/master/SuggestBoxLib/icons/AutoComplete_64x.png" height="64"/>&nbsp;Overview</h2>

A WPF Dark/Light AutoComplete TextBox that can easily handle 20.000+ entries.

This project implements a WPF Dark/Light AutoComplete TextBox that can easily handle 20.000+ entries in the
list of suggestions. The screenshots below show a dark themed demo appliaction with a classic AutoComplete
use case for browsing the file system. This control can also be used to browse other data structures since
the data processing is implemented in the ViewModel/Model layers of the MVVM demo app, while
the control itself is limited to the view.

Review the Wiki section to find out more details of the available API.

This control is also used in a Metro Breadcrumb control.

The first two screenshots show how a seperate combobox like drop down control can be used to select an entry from
a list of recently visited locations (bound to a collection in the viewmodel):

A selection of a recently visited location can be used as a starting point to follow up with more suggestions:

The control can shorten text that is too long for display by inserting ellipses '...' on the:

  • left
  • right or in the
  • center

of a given string. This display is available only if the control is not currently focused.

User Feedback

The control implements a NextTargetLocationArgs event that can be raised via enter/escape key in the textbox control to support keyboard
gestures to confirm/cancel editing of a location.

Error Feedback

The control can show a red rectangle if the user types a completely unmatchable string. This red rectangle
can be triggered with the property attached to the checkbox in the demo application.

Highlighting Color and Themes

Screenshot in this repository where done with this highlighting color on Windows 10:

A Dark/Light themed demo application and a Generic application are part of this repository.

Load Light or Dark brush resources in you resource dictionary to take advantage of existing definitions.

    <ResourceDictionary.MergedDictionaries>
        <ResourceDictionary Source="/SuggestBoxLib;component/Themes/DarkBrushes.xaml" />
    </ResourceDictionary.MergedDictionaries>
    <ResourceDictionary.MergedDictionaries>
        <ResourceDictionary Source="/SuggestBoxLib;component/Themes/LightBrushes.xaml" />
    </ResourceDictionary.MergedDictionaries>

These definitions do not theme all controls used within this library. You should use a standard theming library, such as:

to also theme standard elements, such as, button and textblock etc.

Build status Release NuGet

Net4 NetCore3

The SuggestBox control in this repository was originally developed by <b>Leung Yat Chun Joseph <a href="https://github.com/lycj">lycj</a></b> in his FileExplorer application originating from CodePlex and <a href="https://www.codeproject.com/Members/Fainx">CodeProject</a>.

SuggestBoxLib

<h2><img src="https://raw.githubusercontent.com/Dirkster99/Docu/master/SuggestBoxLib/icons/AutoComplete_64x.png" height="64"/>&nbsp;Overview</h2>

A WPF Dark/Light AutoComplete TextBox that can easily handle 20.000+ entries.

This project implements a WPF Dark/Light AutoComplete TextBox that can easily handle 20.000+ entries in the
list of suggestions. The screenshots below show a dark themed demo appliaction with a classic AutoComplete
use case for browsing the file system. This control can also be used to browse other data structures since
the data processing is implemented in the ViewModel/Model layers of the MVVM demo app, while
the control itself is limited to the view.

Review the Wiki section to find out more details of the available API.

This control is also used in a Metro Breadcrumb control.

The first two screenshots show how a seperate combobox like drop down control can be used to select an entry from
a list of recently visited locations (bound to a collection in the viewmodel):

A selection of a recently visited location can be used as a starting point to follow up with more suggestions:

The control can shorten text that is too long for display by inserting ellipses '...' on the:

  • left
  • right or in the
  • center

of a given string. This display is available only if the control is not currently focused.

User Feedback

The control implements a NextTargetLocationArgs event that can be raised via enter/escape key in the textbox control to support keyboard
gestures to confirm/cancel editing of a location.

Error Feedback

The control can show a red rectangle if the user types a completely unmatchable string. This red rectangle
can be triggered with the property attached to the checkbox in the demo application.

Highlighting Color and Themes

Screenshot in this repository where done with this highlighting color on Windows 10:

A Dark/Light themed demo application and a Generic application are part of this repository.

Load Light or Dark brush resources in you resource dictionary to take advantage of existing definitions.

    <ResourceDictionary.MergedDictionaries>
        <ResourceDictionary Source="/SuggestBoxLib;component/Themes/DarkBrushes.xaml" />
    </ResourceDictionary.MergedDictionaries>
    <ResourceDictionary.MergedDictionaries>
        <ResourceDictionary Source="/SuggestBoxLib;component/Themes/LightBrushes.xaml" />
    </ResourceDictionary.MergedDictionaries>

These definitions do not theme all controls used within this library. You should use a standard theming library, such as:

to also theme standard elements, such as, button and textblock etc.

Release Notes

Package Update with support based on .NetCore 3 Preview 8 and .Net4.5.2

  • .NETCoreApp 3.0

    • No dependencies.
  • .NETFramework 4.5.1

    • No dependencies.

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.2.1 87 9/7/2019
1.2.0 52 9/7/2019
1.1.1.1 137 5/20/2019
1.1.1 88 5/18/2019
1.1.0 77 5/17/2019
1.0.1 292 1/22/2019
1.0.0 166 1/19/2019