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

fix: fix line-height invalid close #154 #155

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Conversation

kagol
Copy link
Member

@kagol kagol commented Dec 17, 2024

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: #154

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • New Features
    • Introduced line height adjustment options in the toolbar, allowing users to customize text spacing in the editor.
    • Added functionality to set line height through the toolbar for enhanced text formatting.

Copy link

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request introduces line height configuration to the Fluent Editor's toolbar. By adding a new line height option to the TOOLBAR_CONFIG array in the custom-toolbar.vue file and implementing a corresponding handler in the FluentEditor class, users can now adjust text line spacing directly from the toolbar. This enhancement provides more granular text formatting control without modifying the core structure of the existing editor components.

Changes

File Change Summary
packages/docs/fluent-editor/demos/custom-toolbar.vue Added line height options ['1', '1.2', '1.5', '1.75', '2', '3', '4', '5'] to TOOLBAR_CONFIG
packages/fluent-editor/src/fluent-editor.ts Implemented 'lineheight' toolbar handler to set text line height using this.quill.format('line-height', value)

Sequence Diagram

sequenceDiagram
    participant User
    participant Toolbar
    participant FluentEditor
    participant Quill

    User->>Toolbar: Select line height
    Toolbar->>FluentEditor: Trigger lineheight handler
    FluentEditor->>Quill: format('line-height', value)
    Quill-->>User: Update text line spacing
Loading

Possibly related PRs

Suggested labels

bug, enhancement

Poem

🐰 Line by line, we hop and grow,
Spacing text with rabbit's flow
Toolbar magic, heights so neat
Formatting made simple and sweet!
Code hops higher, spacing clear 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

@github-actions github-actions bot added the bug Something isn't working label Dec 17, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
packages/docs/fluent-editor/demos/custom-toolbar.vue (1)

23-28: Consider UX implications of extreme line-height values

While the line-height configuration is well-structured, the higher values (3, 4, 5) might lead to poor readability. Consider:

  • Limiting the maximum value to 3
  • Adding a default value indicator
  • Adding tooltips to preview the spacing
-    { lineheight: ['1', '1.2', '1.5', '1.75', '2', '3', '4', '5'] },
+    { lineheight: [
+      { value: '1', default: true },
+      '1.2',
+      '1.5',
+      '1.75',
+      '2',
+      '3'
+    ] },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6aa523b and 4e3a293.

📒 Files selected for processing (2)
  • packages/docs/fluent-editor/demos/custom-toolbar.vue (1 hunks)
  • packages/fluent-editor/src/fluent-editor.ts (1 hunks)
🔇 Additional comments (1)
packages/fluent-editor/src/fluent-editor.ts (1)

146-148: Verify LineHeightStyle implementation and CSS conflicts

Please ensure:

  1. The LineHeightStyle implementation properly handles the line-height attribute
  2. There are no CSS conflicts with existing styles
✅ Verification successful

Let me gather more information about the line-height implementation.


Line-height implementation is properly integrated

The verification shows:

  1. LineHeightStyle is correctly implemented as a Parchment StyleAttributor with inline scope
  2. The format is properly registered in the editor
  3. CSS usage of line-height in the codebase is limited to component-specific styling and doesn't conflict with the format implementation
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check LineHeightStyle implementation
rg -A 10 "class LineHeightStyle"

# Check for potential CSS conflicts with line-height
rg "line-height" --type css

Length of output: 1358


Script:

#!/bin/bash
# Search for line-height format/style registration and implementation
rg -A 5 "line-height|lineHeight" --type ts

# Look for Quill format definitions
ast-grep --pattern 'format($$$)'

Length of output: 1380

Comment on lines +146 to +148
'lineheight': function (value) {
this.quill.format('line-height', value)
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add validation and error handling to line-height handler

The current implementation lacks value validation and error handling. Consider:

  • Validating numeric values
  • Adding error handling for invalid inputs
  • Supporting value cleanup (reset to default)
 'lineheight': function (value) {
+  // Reset to default if value is false or empty
+  if (!value) {
+    this.quill.format('line-height', false);
+    return;
+  }
+
+  // Validate numeric value
+  const numValue = parseFloat(value);
+  if (isNaN(numValue) || numValue < 1 || numValue > 5) {
+    console.warn(`Invalid line-height value: ${value}`);
+    return;
+  }
+
   this.quill.format('line-height', value)
 },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
'lineheight': function (value) {
this.quill.format('line-height', value)
},
'lineheight': function (value) {
// Reset to default if value is false or empty
if (!value) {
this.quill.format('line-height', false);
return;
}
// Validate numeric value
const numValue = parseFloat(value);
if (isNaN(numValue) || numValue < 1 || numValue > 5) {
console.warn(`Invalid line-height value: ${value}`);
return;
}
this.quill.format('line-height', value)
},

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ [Feature]: 希望支持行高设置
1 participant