Adding options to allow/disallow resizing the start or end of a region #3965
Conversation
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 eslint
src/plugins/regions.tsOops! Something went wrong! :( ESLint: 9.17.0 ESLint couldn't find an eslint.config.(js|mjs|cjs) file. From ESLint v9.0.0, the default configuration file is now eslint.config.js. https://eslint.org/docs/latest/use/configure/migration-guide If you still have problems after following the migration guide, please stop by WalkthroughThe changes in the Changes
Sequence DiagramsequenceDiagram
participant User
participant RegionsPlugin
participant SingleRegion
User->>SingleRegion: Create Region
User->>SingleRegion: Set resize options
alt Resize Start Allowed
User->>SingleRegion: Resize Start
else Resize Start Blocked
SingleRegion-->>User: Prevent Resize
end
alt Resize End Allowed
User->>SingleRegion: Resize End
else Resize End Blocked
SingleRegion-->>User: Prevent Resize
end
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/plugins/regions.ts (1)
307-308: Consider adding user feedback when resize is prevented.While the resize prevention logic is correct, it might be helpful to provide visual or programmatic feedback when a resize attempt is blocked due to
resizeStartorresizeEndbeing false.Consider emitting an event or updating the cursor style:
private onResize(dx: number, side: 'start' | 'end') { if (!this.resize) return - if (!this.resizeStart && side === 'start') return - if (!this.resizeEnd && side === 'end') return + if (!this.resizeStart && side === 'start') { + // Emit event or update cursor to indicate resize is not allowed + this.element.style.cursor = 'not-allowed' + return + } + if (!this.resizeEnd && side === 'end') { + // Emit event or update cursor to indicate resize is not allowed + this.element.style.cursor = 'not-allowed' + return + } this._onUpdate(dx, side) }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/plugins/regions.ts(5 hunks)
🔇 Additional comments (4)
src/plugins/regions.ts (4)
63-66: LGTM! Well-documented type definitions.
The new optional properties are properly typed and documented, maintaining backward compatibility.
88-89: LGTM! Consistent property declarations and initialization.
The new properties follow the established pattern and are properly initialized with sensible defaults.
Also applies to: 107-108
402-409: LGTM! Clean and consistent options update implementation.
The new options are handled consistently with the existing pattern, maintaining code readability with proper spacing.
307-309: Verify the resize prevention behavior with tests.
The PR objectives mention missing end-to-end tests. Consider adding tests to verify:
- Resize prevention when
resizeStartis false - Resize prevention when
resizeEndis false - Resize allowed when both flags are true
Short description
This optionally allows disabling resizing one end of a region. My use case is to allow extending a region in only one direction. This doesn't change any of the styling because it's easy enough to override the styling for a handle with css.
Implementation details
Just a few minor options on the region plugin. Similar to the resize option, we just check the setting in the onResize handler.
How to test it
Set
resizeStartorresizeEndto false and check that you can't change the value of the start/end respectively.Checklist
Summary by CodeRabbit
New Features
resizeStartandresizeEnd.Bug Fixes