Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HxSearchBox] [HxAutoauggest] [HxInputTags] Keyboard navigation #348 #351

Merged
merged 17 commits into from Sep 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -1,14 +1,16 @@
@using System.Globalization

<HxAutosuggest Label="CultureInfo"
Placeholder="Click here"
Placeholder="Start typing to see suggestions"
TItem="CultureInfo"
TValue="int?"
@bind-Value="@autosuggestValue"
DataProvider="ProvideSuggestions"
ValueSelector="(CultureInfo c) => c.LCID"
ItemFromValueResolver="ResolveAutosuggestItemFromValue">
<ItemTemplate Context="item">@item.EnglishName <sup>@item.LCID</sup></ItemTemplate>
<ItemTemplate Context="item">
@item.EnglishName <sup>@item.LCID</sup>
</ItemTemplate>
<EmptyTemplate>
<span class="p-2">Couldn't find any matching locale</span>
</EmptyTemplate>
Expand All @@ -18,28 +20,28 @@

@code
{
private int? autosuggestValue = 1033;
private int? autosuggestValue = 1033;

private async Task<AutosuggestDataProviderResult<CultureInfo>> ProvideSuggestions(AutosuggestDataProviderRequest request)
{
await Task.Delay(400); // backend API speed simulation
return new AutosuggestDataProviderResult<CultureInfo>
{
Data = CultureInfo.GetCultures(CultureTypes.AllCultures)
.Where(c => c.LCID != 4096) // see Remarks: https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo.lcid?view=net-5.0#System_Globalization_CultureInfo_LCID
.Where(c => c.EnglishName?.Contains(request.UserInput, StringComparison.CurrentCultureIgnoreCase) ?? false)
.OrderBy(c => c.EnglishName)
.ToList()
};
}
private async Task<AutosuggestDataProviderResult<CultureInfo>> ProvideSuggestions(AutosuggestDataProviderRequest request)
{
await Task.Delay(400); // backend API speed simulation
return new AutosuggestDataProviderResult<CultureInfo>
{
Data = CultureInfo.GetCultures(CultureTypes.AllCultures)
.Where(c => c.LCID != 4096) // see Remarks: https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo.lcid?view=net-5.0#System_Globalization_CultureInfo_LCID
.Where(c => c.EnglishName?.Contains(request.UserInput, StringComparison.CurrentCultureIgnoreCase) ?? false)
.OrderBy(c => c.EnglishName)
.ToList()
};
}

private async Task<CultureInfo> ResolveAutosuggestItemFromValue(int? value)
{
if (value is null)
{
return null;
}
await Task.Delay(400); // backend API speed simulation
return CultureInfo.GetCultureInfo(value.Value);
}
private async Task<CultureInfo> ResolveAutosuggestItemFromValue(int? value)
{
if (value is null)
{
return null;
}
await Task.Delay(400); // backend API speed simulation
return CultureInfo.GetCultureInfo(value.Value);
}
}
Expand Up @@ -2,17 +2,15 @@

<ComponentApiDoc Type="typeof(HxAutosuggest<TItem, TValue>)">
<MainContent>
<DocAlert Type="DocAlertType.Danger">
Due to breaking change in Bootstrap 5.2 the keyboard navigation does not work in <code>HxAutosuggest</code> and <code>HxSearchBox</code> (the <code>Up</code> and <code>Down</code> keys).
We are trying to fix this with Bootstrap team and will try to come up with a temporary solution on our side until the final solution will be available.<br />
You can check the progress here: <a href="https://github.com/havit/Havit.Blazor/issues/348">https://github.com/havit/Havit.Blazor/issues/348</a>.
</DocAlert>


<DocAlert Type="DocAlertType.Warning">
Although <code>HxAutosuggest</code> supports <a href="/components/Inputs#InputGroups">input groups</a>, ending input groups conflict with the search icon, therefore, when <code>InputGroupEndText</code> or <code>InputGroupEndTemplate</code> are set, the search icon is not displayed.
Due to breaking change in Bootstrap 5.2, the keyboard navigation stopped working for dropdowns triggered from <code>input</code> (the <code>Up</code> and <code>Down</code> keys).
As an experimental feature we added our own keyboard navigation routines to the affected components. This might be subject to future change.
You can check the progress here: <a href="https://github.com/havit/Havit.Blazor/issues/348">https://github.com/havit/Havit.Blazor/issues/348</a>.
</DocAlert>

<Demo Type="typeof(HxAutosuggest_Demo_Basic)" />

</MainContent>
<CssVariables>
<ComponentApiDocCssVariable Name="--hx-autosuggest-input-close-icon-opacity" Default=".25">
Expand Down
Expand Up @@ -2,7 +2,13 @@

<ComponentApiDoc Type="typeof(HxInputTags)">
<MainContent>
<SectionTitle Id="BasicUsage" />
<DocAlert Type="DocAlertType.Warning">
Due to breaking change in Bootstrap 5.2, the keyboard navigation stopped working for dropdowns triggered from <code>input</code> (the <code>Up</code> and <code>Down</code> keys).
As an experimental feature we added our own keyboard navigation routines to the affected components. This might be subject to future change.
You can check the progress here: <a href="https://github.com/havit/Havit.Blazor/issues/348">https://github.com/havit/Havit.Blazor/issues/348</a>.
</DocAlert>

<SectionTitle Id="BasicUsage" />
<Demo Type="typeof(HxInputTags_Demo_Basic)" />

<SectionTitle Id="StaticSuggestions" />
Expand Down
@@ -1,12 +1,10 @@
<HxSearchBox DataProvider="ProvideSearchResults"
TItem="SearchBoxItem"
ItemTitleSelector="i => i.Title"
ItemSubtitleSelector="i => i.Subtitle"
ItemIconSelector="i => i.Icon"
TItem="SearchBoxItem"
Placeholder="Search"
OnItemSelected="OnItemSelected"
AllowTextQuery="true"
@bind-TextQuery="textQuery"
OnTextQueryTriggered="OnTextQueryTriggered">
<DefaultContentTemplate>
<div class="p-2 text-muted">Search for Mouse, Table or Door...</div>
Expand All @@ -18,21 +16,21 @@

<p class="mt-3">
Last selected item: @selectedItem?.Title<br/>
Triggered text-query: @triggeredTextQuery<br />
Bound text-query: @textQuery<br />
Last triggered text-query: @triggeredTextQuery<br />
</p>

@code {
private SearchBoxItem selectedItem;
private string triggeredTextQuery;
private string textQuery;

List<SearchBoxItem> Data { get; set; } = new()
{
new() { Title = "Table", Subtitle = "50 000", Icon = BootstrapIcon.Table },
new() { Title = "Mouse", Subtitle = "400", Icon = BootstrapIcon.Mouse },
new() { Title = "Door", Subtitle = "1000", Icon = BootstrapIcon.DoorClosed }
};
{
new() { Title = "Table", Subtitle = "50 000", Icon = BootstrapIcon.Table },
new() { Title = "Mouse", Subtitle = "400", Icon = BootstrapIcon.Mouse },
new() { Title = "Door", Subtitle = "1000", Icon = BootstrapIcon.DoorClosed },
new() { Title = "Big table", Subtitle = "9 000", Icon = BootstrapIcon.Table },
new() { Title = "Small table", Subtitle = "7 200", Icon = BootstrapIcon.Table }
};

private void OnItemSelected(SearchBoxItem item)
{
Expand All @@ -49,12 +47,12 @@
await Task.Delay(400); // imitate slower server API

return new()
{
Data = Data.Where(i => i.Title.Contains(request.UserInput, StringComparison.OrdinalIgnoreCase))
};
{
Data = Data.Where(i => i.Title.Contains(request.UserInput, StringComparison.OrdinalIgnoreCase))
};
}

class SearchBoxItem
internal class SearchBoxItem
{
public string Title { get; set; }
public string Subtitle { get; set; }
Expand Down
@@ -0,0 +1,54 @@
<HxSearchBox DataProvider="ProvideSearchResults"
TItem="SearchBoxItem"
ItemTitleSelector="i => i.Title"
ItemSubtitleSelector="i => i.Subtitle"
ItemIconSelector="i => i.Icon"
Placeholder="Search"
AllowTextQuery="false"
OnItemSelected="OnItemSelected">
<DefaultContentTemplate>
<div class="p-2 text-muted">Search for Mouse, Table or Door...</div>
</DefaultContentTemplate>
<NotFoundTemplate>
<div class="small py-2 px-3 text-muted"><HxIcon CssClass="me-2" Icon="BootstrapIcon.EmojiFrown"/>Sorry, I did not find that...</div>
</NotFoundTemplate>
</HxSearchBox>

<p class="mt-3">
Last selected item: @selectedItem?.Title<br/>
</p>

@code {
private SearchBoxItem selectedItem;

List<SearchBoxItem> Data { get; set; } = new()
{
new() { Title = "Table", Subtitle = "50 000", Icon = BootstrapIcon.Table },
new() { Title = "Mouse", Subtitle = "400", Icon = BootstrapIcon.Mouse },
new() { Title = "Door", Subtitle = "1000", Icon = BootstrapIcon.DoorClosed },
new() { Title = "Big table", Subtitle = "9 000", Icon = BootstrapIcon.Table },
new() { Title = "Small table", Subtitle = "7 200", Icon = BootstrapIcon.Table }
};

private void OnItemSelected(SearchBoxItem item)
{
selectedItem = item;
}

private async Task<SearchBoxDataProviderResult<SearchBoxItem>> ProvideSearchResults(SearchBoxDataProviderRequest request)
{
await Task.Delay(400); // imitate slower server API

return new()
{
Data = Data.Where(i => i.Title.Contains(request.UserInput, StringComparison.OrdinalIgnoreCase))
};
}

class SearchBoxItem
{
public string Title { get; set; }
public string Subtitle { get; set; }
public BootstrapIcon Icon { get; set; }
}
}
Expand Up @@ -2,17 +2,18 @@

<ComponentApiDoc Type="typeof(HxSearchBox<TItem>)">
<MainContent>
<DocAlert Type="DocAlertType.Danger">
Due to breaking change in Bootstrap 5.2 the keyboard navigation does not work in <code>HxAutosuggest</code> and <code>HxSearchBox</code> (the <code>Up</code> and <code>Down</code> keys).
We are trying to fix this with Bootstrap team and will try to come up with a temporary solution on our side until the final solution will be available.<br />
<DocAlert Type="DocAlertType.Warning">
Due to breaking change in Bootstrap 5.2, the keyboard navigation stopped working for dropdowns triggered from <code>input</code> (the <code>Up</code> and <code>Down</code> keys).
As an experimental feature we added our own keyboard navigation routines to the affected components. This might be subject to future change.
You can check the progress here: <a href="https://github.com/havit/Havit.Blazor/issues/348">https://github.com/havit/Havit.Blazor/issues/348</a>.
</DocAlert>

<SectionTitle>Basic usage</SectionTitle>
<Demo Type="typeof(HxSearchBox_Demo)" />
<DocAlert Type="DocAlertType.Warning">
Although <code>HxSearchBox</code> supports <a href="/components/Inputs#InputGroups">input groups</a>, ending input groups conflict with the search icon, therefore, when <code>InputGroupEndText</code> or <code>InputGroupEndTemplate</code> are set, the search icon is not displayed.
</DocAlert>

<SectionTitle>Suggestions only</SectionTitle>
<p>You can disable free-text query by setting <code>AllowTextQuery="false"</code>. Only suggestions will be allowed.</p>
<Demo Type="typeof(HxSearchBox_Demo_DisableTextQuery)" />
</MainContent>
<CssVariables>
<ComponentApiDocCssVariable Name="--hx-search-box-item-icon-margin" Default="0 .5rem 0 0">
Expand Down
Expand Up @@ -43,7 +43,13 @@
<p>If you were using <code>PagerCssClass</code> in v2, replace it with new <code>PagerSettings</code> parameter:</p>
<CodeSnippet Language="razor" File="~\Pages\Migrations\MigratingToV3_HxGridPagerSettings.CodeSnippet.razor" />

<h5>4. [OPTIONAL] Replace obsolete components with new ones</h5>
<h5>3.4 <code>HxAutosuggest</code> first item highlighting</h5>
<p>
The <code>HighlightFirstSuggestion</code> parameter was removed. The component now highlights the first suggestion by default (cannot be disabled).
Remove the parameter from your code (incl. <code>HxAutosuggest.Settings</code> and <code>HxAutosuggest.Defaults</code>).
</p>

<h3>4. [OPTIONAL] Replace obsolete components with new ones</h3>
<p>
We replaced <code>HxInputCheckbox</code> with new <code>HxCheckbox</code> and <code>HxInputSwitch</code> with new <code>HxSwitch</code>.<br />
The original <code>Label</code> parameter is now <code>Text</code> (the <code>Label</code> parameter of new components has a different purpose, see <a href="/components/HxCheckbox"><code>HxCheckbox</code> documentation</a>).
Expand Down