Fix issues of ordered lists in BitMarkdownEditor (#10276)

[msynk]

closes #10276

Summary by CodeRabbit

• New Features

  • The Markdown Editor now supports more flexible content insertion, allowing for precise placement during editing.

• Refactor

  • List formatting has been streamlined, resulting in a more intuitive and consistent numbering experience.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request refines the ordered-list management in the Markdown editor by updating method signatures and renaming functions. The add method now accepts optional start and end positions, while the function formerly known as getLists has been renamed to getRepeat with simplified logic. Additionally, the logic in the correct and keydown methods has been streamlined to adjust the ordered list numbering more precisely.

Changes

File(s)	Change Summary
src/BlazorUI/.../BitMarkdownEditor.ts	- Updated Editor.add to accept optional start (s) and end (e) positions. - Renamed getLists to getRepeat with simplified logic. - Streamlined the correct method to adjust numbering and updated keydown to use getRepeat and pass the new parameters.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant E as Editor
    U->>E: Keydown event
    E->>E: Call getRepeat(input)
    E->>E: Call add(content, start, end)

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Correct handling of ordered list numbering (#10276)	✅

Poem

I'm hopping through the lines of code,
Where ordered lists now smoothly flow,
With options to add at any start or end,
My rabbit heart can now commend,
A code garden where neat lists grow!
🥕🐇

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 709ac05 and 23df6ec.

📒 Files selected for processing (1)

• src/BlazorUI/Bit.BlazorUI.Extras/Components/MarkdownEditor/BitMarkdownEditor.ts (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test

🔇 Additional comments (4)

src/BlazorUI/Bit.BlazorUI.Extras/Components/MarkdownEditor/BitMarkdownEditor.ts (4)

174-182: Improved method name and simplified logic

Renaming from getLists to getRepeat better reflects the method's purpose of detecting and returning a repeatable prefix pattern. The logic has been streamlined to directly return the formatted list prefix.

---

191-206: Streamlined ordered list handling logic

The refactored correct method is more concise and focused specifically on handling ordered lists. The change improves readability by:

1. Directly checking for numbers
2. Using a dedicated variable for the new number
3. Clearly separating the increment and decrement logic

This approach makes the code more maintainable while preserving the same functionality.

---

262-262: Method name update

The call is updated to use the renamed method, which is consistent with the other changes.

---

270-274: Improved handling of selection positions

Storing the original selection positions in ss and ee before modifying the text is a good practice. This ensures that the content is inserted at the correct location even after other operations like this.correct(num) might modify the text area's selection state.