-
-
Notifications
You must be signed in to change notification settings - Fork 267
Add new BitDataGrid component (#12502) #12504
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
base: develop
Are you sure you want to change the base?
Changes from 3 commits
fdaa067
8316057
8acd2aa
b9ba019
a44c223
8a11d7c
08a958f
5ccebf5
f359f8e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,101 +1,37 @@ | ||
| namespace BitBlazorUI { | ||
| export class DataGrid { | ||
| public static init(tableElement: any) { | ||
| DataGrid.enableColumnResizing(tableElement); | ||
|
|
||
| const bodyClickHandler = (event: any) => { | ||
| const columnOptionsElement = tableElement.tHead.querySelector('.bit-dtg-cop'); | ||
| if (columnOptionsElement && event.composedPath().indexOf(columnOptionsElement) < 0) { | ||
| tableElement.dispatchEvent(new CustomEvent('closecolumnoptions', { bubbles: true })); | ||
| // Infinite scrolling is the one feature that genuinely needs to read scroll | ||
| // position (which Blazor's scroll EventArgs do not expose), so this watches | ||
| // the viewport and notifies .NET when the user nears the end. | ||
| public static initInfiniteScroll(viewport: HTMLElement, dotNetRef: DotNetObject, threshold: number) { | ||
| const distance = threshold ?? 200; | ||
| let ticking = false; | ||
|
|
||
| const check = () => { | ||
| ticking = false; | ||
| if (!viewport) return; | ||
| const remaining = viewport.scrollHeight - viewport.scrollTop - viewport.clientHeight; | ||
| if (remaining <= distance) { | ||
| dotNetRef.invokeMethodAsync('OnInfiniteScrollNearEndAsync'); | ||
| } | ||
| }; | ||
| const keyDownHandler = (event: any) => { | ||
| const columnOptionsElement = tableElement.tHead.querySelector('.bit-dtg-cop'); | ||
| if (columnOptionsElement && event.key === "Escape") { | ||
| tableElement.dispatchEvent(new CustomEvent('closecolumnoptions', { bubbles: true })); | ||
|
|
||
| const onScroll = () => { | ||
| if (!ticking) { | ||
| ticking = true; | ||
| requestAnimationFrame(check); | ||
| } | ||
| }; | ||
|
|
||
| document.body.addEventListener('click', bodyClickHandler); | ||
| document.body.addEventListener('mousedown', bodyClickHandler); // Otherwise it seems strange that it doesn't go away until you release the mouse button | ||
| document.body.addEventListener('keydown', keyDownHandler); | ||
| viewport.addEventListener('scroll', onScroll, { passive: true }); | ||
| // Initial check so a first batch that doesn't fill the viewport keeps loading. | ||
| setTimeout(check, 0); | ||
|
|
||
| return { | ||
| stop: () => { | ||
| document.body.removeEventListener('click', bodyClickHandler); | ||
| document.body.removeEventListener('mousedown', bodyClickHandler); | ||
| document.body.removeEventListener('keydown', keyDownHandler); | ||
| } | ||
| check: () => check(), | ||
| scrollToTop: () => { if (viewport) viewport.scrollTop = 0; }, | ||
| dispose: () => viewport.removeEventListener('scroll', onScroll) | ||
|
msynk marked this conversation as resolved.
Outdated
|
||
| }; | ||
| } | ||
|
|
||
| public static checkColumnOptionsPosition(tableElement: any) { | ||
| const colOptions = tableElement.tHead && tableElement.tHead.querySelector('.bit-dtg-cop'); // Only match within *our* thead, not nested tables | ||
| if (colOptions) { | ||
| // We want the options popup to be positioned over the grid, not overflowing on either side, because it's possible that | ||
| // beyond either side is off-screen or outside the scroll range of an ancestor | ||
| const gridRect = tableElement.getBoundingClientRect(); | ||
| const optionsRect = colOptions.getBoundingClientRect(); | ||
| const leftOverhang = Math.max(0, gridRect.left - optionsRect.left); | ||
| const rightOverhang = Math.max(0, optionsRect.right - gridRect.right); | ||
| if (leftOverhang || rightOverhang) { | ||
| // In the unlikely event that it overhangs both sides, we'll center it | ||
| const applyOffset = leftOverhang && rightOverhang ? (leftOverhang - rightOverhang) / 2 : (leftOverhang - rightOverhang); | ||
| colOptions.style.transform = `translateX(${applyOffset}px)`; | ||
| } | ||
|
|
||
| colOptions.scrollIntoViewIfNeeded(); | ||
|
|
||
| const autoFocusElem = colOptions.querySelector('[autofocus]'); | ||
| if (autoFocusElem) { | ||
| autoFocusElem.focus(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static enableColumnResizing(tableElement: any) { | ||
| tableElement.tHead.querySelectorAll('.bit-dtg-drg').forEach((handle: any) => { | ||
| handle.addEventListener('mousedown', handleMouseDown); | ||
| if ('ontouchstart' in window) { | ||
| handle.addEventListener('touchstart', handleMouseDown); | ||
| } | ||
|
|
||
| function handleMouseDown(evt: any) { | ||
| evt.preventDefault(); | ||
| evt.stopPropagation(); | ||
|
|
||
| const th = handle.parentElement; | ||
| const startPageX = evt.touches ? evt.touches[0].pageX : evt.pageX; | ||
| const originalColumnWidth = th.offsetWidth; | ||
| const rtlMultiplier = window.getComputedStyle(th, null).getPropertyValue('direction') === 'rtl' ? -1 : 1; | ||
| let updatedColumnWidth = 0; | ||
|
|
||
| function handleMouseMove(evt: any) { | ||
| evt.stopPropagation(); | ||
| const newPageX = evt.touches ? evt.touches[0].pageX : evt.pageX; | ||
| const nextWidth = originalColumnWidth + (newPageX - startPageX) * rtlMultiplier; | ||
| if (Math.abs(nextWidth - updatedColumnWidth) > 0) { | ||
| updatedColumnWidth = nextWidth; | ||
| th.style.width = `${updatedColumnWidth}px`; | ||
| } | ||
| } | ||
|
|
||
| function handleMouseUp() { | ||
| document.body.removeEventListener('mousemove', handleMouseMove); | ||
| document.body.removeEventListener('mouseup', handleMouseUp); | ||
| document.body.removeEventListener('touchmove', handleMouseMove); | ||
| document.body.removeEventListener('touchend', handleMouseUp); | ||
| } | ||
|
|
||
| if (window.TouchEvent && evt instanceof TouchEvent) { | ||
| document.body.addEventListener('touchmove', handleMouseMove, { passive: true }); | ||
| document.body.addEventListener('touchend', handleMouseUp, { passive: true }); | ||
| } else { | ||
| document.body.addEventListener('mousemove', handleMouseMove, { passive: true }); | ||
| document.body.addEventListener('mouseup', handleMouseUp, { passive: true }); | ||
| } | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| @typeparam TItem | ||
| @namespace Bit.BlazorUI | ||
|
|
||
| @* A single data cell. Each cell owns one stable element with an unconditional @@ref so | ||
| keyboard navigation can move DOM focus via Blazor's FocusAsync without conditional | ||
| reference-capture frames (which break render-tree diffing). *@ | ||
| <div @ref="_el" class="@CssClass" role="gridcell" style="@Style" tabindex="@TabIndex" | ||
| @onclick="HandleClick" | ||
| @ondblclick="HandleDoubleClick" | ||
| @oncontextmenu="HandleContextMenu" | ||
| @oncontextmenu:preventDefault="Grid.OnCellContextMenu.HasDelegate" | ||
| @onfocusin="HandleFocusIn" | ||
| @onkeydown="HandleKeyDown"> | ||
|
msynk marked this conversation as resolved.
Outdated
|
||
| @ChildContent | ||
| </div> | ||
|
|
||
| @code { | ||
| [Parameter, EditorRequired] public BitDataGrid<TItem> Grid { get; set; } = default!; | ||
| [Parameter, EditorRequired] public TItem Item { get; set; } = default!; | ||
| [Parameter, EditorRequired] public BitDataGridColumn<TItem> Column { get; set; } = default!; | ||
| [Parameter] public int ColIndex { get; set; } | ||
| [Parameter] public string? CssClass { get; set; } | ||
| [Parameter] public string? Style { get; set; } | ||
| [Parameter] public RenderFragment? ChildContent { get; set; } | ||
|
|
||
| private ElementReference _el; | ||
|
|
||
| private int? TabIndex => Grid.CellNavigation ? Grid.CellTabIndex(Item, ColIndex) : (int?)null; | ||
| private bool Editing => Grid.IsEditing(Item); | ||
|
|
||
| protected override async Task OnAfterRenderAsync(bool firstRender) | ||
| { | ||
| if (Grid.CellNavigation && Grid.ShouldFocusCell(Item, ColIndex)) | ||
| { | ||
| Grid.ClearFocusPending(); | ||
| try { await _el.FocusAsync(); } catch { /* element may have been removed */ } | ||
| } | ||
| } | ||
|
|
||
| private Task HandleClick(MouseEventArgs e) => Grid.HandleCellClickAsync(Column, Item, e); | ||
| private Task HandleDoubleClick(MouseEventArgs e) => Grid.HandleCellDoubleClickAsync(Column, Item, e); | ||
| private Task HandleContextMenu(MouseEventArgs e) => Grid.HandleCellContextMenuAsync(Column, Item, e); | ||
|
|
||
| private void HandleFocusIn() | ||
| { | ||
| if (Grid.CellNavigation) Grid.SetFocusedCell(Item, ColIndex); | ||
| } | ||
|
|
||
| private async Task HandleKeyDown(KeyboardEventArgs e) | ||
| { | ||
| if (!Grid.CellNavigation) return; | ||
|
|
||
| // While inline-editing, the cell only handles the edit lifecycle keys; everything | ||
| // else (typing, caret movement) belongs to the editor input. | ||
| if (Editing) | ||
| { | ||
| if (e.Key == "Escape") | ||
| { | ||
| await Grid.CancelEditAsync(); | ||
| Grid.RefocusFocusedCell(); | ||
| } | ||
| else if (e.Key == "Enter") | ||
| { | ||
| await Grid.CommitEditAsync(); | ||
| Grid.RefocusFocusedCell(); | ||
| } | ||
| return; | ||
| } | ||
|
|
||
| await Grid.HandleCellKeyDownAsync(Item, ColIndex, e); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| @typeparam TItem | ||
| @namespace Bit.BlazorUI | ||
|
|
||
| @switch (Column.EffectiveDataType) | ||
| { | ||
| case BitDataGridColumnDataType.Boolean: | ||
| <input type="checkbox" class="bit-dtg-editor bit-dtg-editor-check" | ||
| checked="@(GetBool())" | ||
| @onchange="e => Set(e.Value)" /> | ||
| break; | ||
|
|
||
| case BitDataGridColumnDataType.Number: | ||
| <input type="number" class="bit-dtg-editor" step="any" | ||
| value="@(GetString())" | ||
| @oninput="e => Set(e.Value)" /> | ||
|
Comment on lines
+12
to
+15
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Format numeric editor values with invariant culture.
🐛 Proposed fix case BitDataGridColumnDataType.Number:
<input type="number" class="bit-dtg-editor" step="any"
- value="@(GetString())"
+ value="@(GetNumber())"
`@oninput`="e => Set(e.Value)" />
break;
@@
private object? Value => Column.GetValue(Item);
private string GetString() => Value?.ToString() ?? string.Empty;
+ private string GetNumber() => Value is IFormattable f
+ ? f.ToString(null, System.Globalization.CultureInfo.InvariantCulture)
+ : GetString();
private bool GetBool() => Value is bool b && b;Also applies to: 45-47 🤖 Prompt for AI Agents |
||
| break; | ||
|
|
||
| case BitDataGridColumnDataType.Date: | ||
| <input type="date" class="bit-dtg-editor" | ||
| value="@(GetDate())" | ||
| @onchange="e => Set(e.Value)" /> | ||
| break; | ||
|
|
||
| case BitDataGridColumnDataType.Enum: | ||
| <select class="bit-dtg-editor" value="@(GetString())" @onchange="e => Set(e.Value)"> | ||
| @foreach (var name in Enum.GetNames(Column.Accessor!.UnderlyingType)) | ||
| { | ||
|
msynk marked this conversation as resolved.
Outdated
|
||
| <option value="@name" selected="@(name == GetString())">@name</option> | ||
| } | ||
| </select> | ||
| break; | ||
|
|
||
| default: | ||
| <input type="text" class="bit-dtg-editor" | ||
| value="@(GetString())" | ||
| @oninput="e => Set(e.Value)" /> | ||
| break; | ||
| } | ||
|
|
||
| @code { | ||
| [Parameter, EditorRequired] public BitDataGrid<TItem> Grid { get; set; } = default!; | ||
| [Parameter, EditorRequired] public BitDataGridColumn<TItem> Column { get; set; } = default!; | ||
| [Parameter, EditorRequired] public TItem Item { get; set; } = default!; | ||
|
|
||
| private object? Value => Column.GetValue(Item); | ||
| private string GetString() => Value?.ToString() ?? string.Empty; | ||
| private bool GetBool() => Value is bool b && b; | ||
|
|
||
| private string GetDate() | ||
| { | ||
| return Value switch | ||
| { | ||
| DateTime dt => dt.ToString("yyyy-MM-dd"), | ||
| DateOnly d => d.ToString("yyyy-MM-dd"), | ||
| DateTimeOffset dto => dto.ToString("yyyy-MM-dd"), | ||
| _ => string.Empty | ||
| }; | ||
| } | ||
|
|
||
| private void Set(object? raw) => Grid.SetEditValue(Column, raw); | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.