Skip to content

Apply BitMarkdownEditor improvements (#13175) #13185

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.

Sign up for GitHub

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

Open
msynk wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Apply BitMarkdownEditor improvements (#13175) #13185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
10c0917
apply BitMarkdownEditor improvements #13175
msynk Sep 9, 2026
adc5487
further improvements
msynk Sep 10, 2026
be2c985
resolve review comments
msynk Sep 10, 2026
b20889e
code review
msynk Sep 10, 2026
d469d5c
fix build stuck on .net 8
msynk Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 124 additions & 60 deletions src/BlazorUI/Bit.BlazorUI.Extras/Components/MarkdownEditor/BitMarkdownEditor.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@namespace Bit.BlazorUI
@namespace Bit.BlazorUI
@inherits BitComponentBase

<div @ref="RootElement"
Expand All @@ -8,9 +8,23 @@
class="@ClassBuilder.Value"
dir="@Dir?.ToString().ToLower()">

@if (Label is not null || LabelTemplate is not null)
{
<label style="@Styles?.Label" class="bit-mde-lbl @Classes?.Label" for="@TextAreaId">
@if (LabelTemplate is not null)
{
@LabelTemplate
}
else
{
@Label
}
</label>
}

@if (ShowToolbar)
{
<div role="toolbar" aria-label="@ActiveTexts.ToolbarAriaLabel"
<div role="toolbar" aria-label="@ActiveTexts.ToolbarAriaLabel" aria-controls="@TextAreaId"
style="@Styles?.Toolbar" class="bit-mde-tlb @Classes?.Toolbar">
@foreach (var item in ActiveToolbar)
{
Expand All @@ -20,13 +34,16 @@
}
else if (item.Type is BitMarkdownEditorToolbarItemType.Dropdown)
{
@* A menu holding the active command says so on its trigger, so the caret's
heading level can be read off the closed toolbar. *@
<div class="bit-mde-dd">
<button type="button"
style="@Styles?.ToolbarButton"
class="bit-mde-btn @Classes?.ToolbarButton"
class="bit-mde-btn @Classes?.ToolbarButton @(IsToolbarItemActive(item) ? "bit-mde-act" : null)"
title="@GetToolbarItemTitle(item)"
aria-label="@GetToolbarItemLabel(item)"
aria-haspopup="true"
aria-keyshortcuts="@GetToolbarItemKeyShortcuts(item)"
aria-haspopup="menu"
aria-expanded="false"
data-cmd="@item.Name"
tabindex="-1"
Expand All @@ -36,20 +53,33 @@
<div class="bit-mde-ddm" role="menu" aria-label="@GetToolbarItemLabel(item)">
@foreach (var child in item.Children ?? [])
{
<button type="button"
role="menuitem"
class="bit-mde-btn bit-mde-mi @(IsToolbarItemActive(child) ? "bit-mde-act" : null)"
title="@GetToolbarItemTitle(child)"
aria-label="@GetToolbarItemLabel(child)"
data-cmd="@child.Name"
disabled="@IsToolbarItemDisabled(child)"
@onclick="() => OnToolbarItemClick(child)">
@((MarkupString)child.Icon)
@if (child.Text is not null)
{
<span class="bit-mde-mit">@child.Text</span>
}
</button>
if (child.Type is BitMarkdownEditorToolbarItemType.Separator)
{
<div class="bit-mde-msep" role="separator"></div>
}
else
{
@* A menu item that reports a state is a radio: the heading picker's
entries exclude one another, which "checked" says and "pressed"
does not. Everything else is a plain command. *@
<button type="button"
role="@(IsToolbarItemToggle(child) ? "menuitemradio" : "menuitem")"
tabindex="-1"
class="bit-mde-btn bit-mde-mi @(IsToolbarItemActive(child) ? "bit-mde-act" : null)"
title="@GetToolbarItemTitle(child)"
aria-label="@GetToolbarItemLabel(child)"
aria-keyshortcuts="@GetToolbarItemKeyShortcuts(child)"
aria-checked="@(IsToolbarItemToggle(child) ? (IsToolbarItemActive(child) ? "true" : "false") : null)"
data-cmd="@child.Name"
disabled="@IsToolbarItemDisabled(child)"
@onclick="() => OnToolbarItemClick(child)">
@((MarkupString)child.Icon)
@if (child.Text is not null)
{
<span class="bit-mde-mit">@child.Text</span>
}
</button>
}
}
</div>
</div>
Expand All @@ -61,6 +91,7 @@
class="bit-mde-btn @Classes?.ToolbarButton @(IsToolbarItemActive(item) ? "bit-mde-act" : null)"
title="@GetToolbarItemTitle(item)"
aria-label="@GetToolbarItemLabel(item)"
aria-keyshortcuts="@GetToolbarItemKeyShortcuts(item)"
aria-pressed="@(IsToolbarItemToggle(item) ? (IsToolbarItemActive(item) ? "true" : "false") : null)"
data-cmd="@item.Name"
tabindex="-1"
Expand All @@ -73,22 +104,74 @@
</div>
}

@if (_showFind)
{
<div class="bit-mde-fnd" role="region" aria-label="@ActiveTexts.FindReplaceTitle">
<input @ref="_findRef"
class="bit-mde-fni"
placeholder="@ActiveTexts.FindPlaceholder"
aria-label="@ActiveTexts.FindPlaceholder"
value="@_findText"
@oninput="e => OnFindTextChanged(e.Value?.ToString() ?? string.Empty)"
@onkeydown="OnFindKeyDown" />
<input class="bit-mde-fni"
placeholder="@ActiveTexts.ReplacePlaceholder"
aria-label="@ActiveTexts.ReplacePlaceholder"
value="@_replaceText"
@oninput="e => _replaceText = e.Value?.ToString() ?? string.Empty"
@onkeydown="OnReplaceKeyDown" />
<button type="button"
class="bit-mde-fnb bit-mde-fnc @(_matchCase ? "bit-mde-act" : null)"
aria-pressed="@(_matchCase ? "true" : "false")"
title="@ActiveTexts.MatchCaseAriaLabel"
aria-label="@ActiveTexts.MatchCaseAriaLabel"
@onclick="ToggleMatchCase">Aa</button>
<button type="button" class="bit-mde-fnb" title="@ActiveTexts.FindPreviousAriaLabel" aria-label="@ActiveTexts.FindPreviousAriaLabel" @onclick="FindPreviousMatch">&uarr;</button>
<button type="button" class="bit-mde-fnb" title="@ActiveTexts.FindNextAriaLabel" aria-label="@ActiveTexts.FindNextAriaLabel" @onclick="FindNextMatch">&darr;</button>
<span class="bit-mde-fns" aria-live="polite">@FindStatusText</span>
<button type="button" class="bit-mde-fnb" @onclick="ReplaceOne" disabled="@(ReadOnly || IsEnabled is false)">@ActiveTexts.ReplaceButton</button>
<button type="button"
class="bit-mde-fnb"
title="@ActiveTexts.ReplaceAllAriaLabel"
aria-label="@ActiveTexts.ReplaceAllAriaLabel"
@onclick="ReplaceAll"
disabled="@(ReadOnly || IsEnabled is false)">@ActiveTexts.ReplaceAllButton</button>
<button type="button" class="bit-mde-hcl" @onclick="CloseFind" aria-label="@ActiveTexts.CloseAriaLabel">&times;</button>
</div>
}

<div class="bit-mde-bdy bit-mde-@Mode.ToString().ToLowerInvariant()">
<div class="bit-mde-pne bit-mde-epn">
<textarea @ref="_textAreaRef"
id="@TextAreaId"
style="@Styles?.TextArea"
class="bit-mde-txa @Classes?.TextArea"
placeholder="@Placeholder"
aria-label="@ActiveTexts.EditorAriaLabel"
aria-label="@TextAreaAriaLabel"
aria-describedby="@TextAreaDescribedBy"
maxlength="@(MaxLength is > 0 ? MaxLength : null)"
spellcheck="@(SpellCheck ? "true" : "false")"
readonly="@(ReadOnly || IsEnabled is false)"
autocomplete="off"
autocapitalize="off"
autocorrect="off"></textarea>
autocorrect="off"
@onfocus="() => OnFocus.InvokeAsync()"
@onblur="() => OnBlur.InvokeAsync()"></textarea>
</div>

<div style="@Styles?.Preview" class="bit-mde-pne bit-mde-ppn @Classes?.Preview">
@if (PreviewTemplate is not null)
@* The preview pane scrolls on its own, so it needs to be reachable by keyboard
for the arrow keys to be able to scroll it. *@
<div style="@Styles?.Preview"
class="bit-mde-pne bit-mde-ppn @Classes?.Preview"
tabindex="0"
role="group"
aria-label="@ActiveTexts.PreviewAriaLabel">
@* Edit mode hides this pane, and rendering markdown nobody can see would re-parse the
whole document on every keystroke for nothing. *@
@if (Mode is BitMarkdownEditorMode.Edit)
{
}
else if (PreviewTemplate is not null)
{
@PreviewTemplate(_previewValue)
}
Expand All @@ -107,41 +190,27 @@
{
<div style="@Styles?.StatusBar" class="bit-mde-sbr @Classes?.StatusBar">
<span class="bit-mde-mod">@ActiveTexts.GetModeLabel(Mode)</span>
@if (ShowCursorPosition)
{
<span class="bit-mde-pos">@CursorPositionText</span>
@if (_selectedLength > 0)
{
<span class="bit-mde-pos">@SelectedText</span>
}
}
<span class="bit-mde-spc"></span>
<span aria-live="polite">@string.Format(ActiveTexts.WordsFormat, WordCount)</span>
<span aria-live="polite">@string.Format(ActiveTexts.CharsFormat, CharCount)</span>
<span>@string.Format(ActiveTexts.WordsFormat, WordCount)</span>
<span id="@CounterId" class="@(IsAtLimit ? "bit-mde-lim" : null)">@CharCountText</span>
@if (ShowReadingTime)
{
<span aria-live="polite">@string.Format(ActiveTexts.ReadingTimeFormat, ReadingMinutes)</span>
<span>@string.Format(ActiveTexts.ReadingTimeFormat, ReadingMinutes)</span>
}
</div>
}

@if (_showFind)
{
<div class="bit-mde-fnd" role="region" aria-label="@ActiveTexts.FindReplaceTitle">
<input @ref="_findRef"
class="bit-mde-fni"
placeholder="@ActiveTexts.FindPlaceholder"
aria-label="@ActiveTexts.FindPlaceholder"
value="@_findText"
@oninput="e => _findText = e.Value?.ToString() ?? string.Empty"
@onkeydown="OnFindKeyDown" />
<input class="bit-mde-fni"
placeholder="@ActiveTexts.ReplacePlaceholder"
aria-label="@ActiveTexts.ReplacePlaceholder"
value="@_replaceText"
@oninput="e => _replaceText = e.Value?.ToString() ?? string.Empty"
@onkeydown="OnFindKeyDown" />
<button type="button" class="bit-mde-fnb" @onclick="() => ReplaceOne()" disabled="@(ReadOnly || IsEnabled is false)">@ActiveTexts.ReplaceButton</button>
<button type="button" class="bit-mde-fnb" @onclick="() => ReplaceAll()" disabled="@(ReadOnly || IsEnabled is false)">@ActiveTexts.ReplaceAllButton</button>
<button type="button" class="bit-mde-hcl" @onclick="() => _showFind = false" aria-label="@ActiveTexts.CloseAriaLabel">&times;</button>
</div>
}

@if (_showHelp)
{
<div class="bit-mde-hlp" @onclick="() => _showHelp = false">
<div class="bit-mde-hlp" @onclick="CloseHelp">
<div @ref="_helpRef"
role="dialog"
aria-modal="true"
Expand All @@ -150,23 +219,18 @@
class="bit-mde-hcr"
@onkeydown="OnHelpKeyDown"
@onclick:stopPropagation="true">
<span tabindex="0" class="bit-mde-guard" @onfocus="FocusHelpClose" aria-hidden="true"></span>
<span tabindex="0" class="bit-mde-guard" @onfocus="FocusHelpClose"></span>
<header>
<strong>@ActiveTexts.KeyboardShortcutsTitle</strong>
<button type="button" @ref="_helpCloseRef" class="bit-mde-hcl" @onclick="() => _showHelp = false" aria-label="@ActiveTexts.CloseAriaLabel">&times;</button>
<button type="button" @ref="_helpCloseRef" class="bit-mde-hcl" @onclick="CloseHelp" aria-label="@ActiveTexts.CloseAriaLabel">&times;</button>
</header>
<dl>
<div><dt>@ActiveTexts.ShortcutBold</dt><dd>Ctrl/Cmd + B</dd></div>
<div><dt>@ActiveTexts.ShortcutItalic</dt><dd>Ctrl/Cmd + I</dd></div>
<div><dt>@ActiveTexts.ShortcutStrikethrough</dt><dd>Ctrl/Cmd + Shift + S</dd></div>
<div><dt>@ActiveTexts.ShortcutLink</dt><dd>Ctrl/Cmd + K</dd></div>
<div><dt>@ActiveTexts.ShortcutUndo</dt><dd>Ctrl/Cmd + Z</dd></div>
<div><dt>@ActiveTexts.ShortcutRedo</dt><dd>Ctrl/Cmd + Y (or Shift + Z)</dd></div>
<div><dt>@ActiveTexts.ShortcutIndentOutdent</dt><dd>Tab / Shift + Tab</dd></div>
<div><dt>@ActiveTexts.ShortcutContinueList</dt><dd>Enter</dd></div>
<div><dt>@ActiveTexts.ShortcutFind</dt><dd>Ctrl/Cmd + F</dd></div>
@foreach (var (label, keys) in HelpShortcuts)
{
<div><dt>@label</dt><dd>@keys</dd></div>
}
</dl>
<span tabindex="0" class="bit-mde-guard" @onfocus="FocusHelpClose" aria-hidden="true"></span>
<span tabindex="0" class="bit-mde-guard" @onfocus="FocusHelpClose"></span>
</div>
</div>
}
Expand Down
Loading
Loading