docs(layout): add JSDoc for kt.sidebar nesting behavior#136
Open
watany-dev wants to merge 12 commits into
Open
docs(layout): add JSDoc for kt.sidebar nesting behavior#136watany-dev wants to merge 12 commits into
watany-dev wants to merge 12 commits into
Conversation
Add @remarks section documenting: - Nested call support - Sidebar buffer output behavior - Exception safety via try/finally
Add comprehensive documentation for nested sidebar calls: - Supported patterns and output behavior - Implementation details with code examples - Non-recommended patterns for code clarity - Error handling guarantees with try/finally
Add E2E tests for mobile responsive behavior: - Verify fixed positioning on 375x667 viewport - Verify toggle button size >= 40px on mobile
Add E2E tests for mobile overlay behavior: - Verify overlay appears when sidebar is expanded - Verify clicking overlay closes the sidebar
Add E2E tests for tablet and desktop breakpoints: - Tablet (768px): verify fixed positioning at boundary - Desktop (1280px): verify relative positioning - Desktop: verify overlay is hidden
- Add sidebarWidth private property with default "280px" - Add setSidebarWidth() and getSidebarWidth() methods - Reset sidebarWidth in clear() method - Add unit tests for sidebarWidth functionality
- Use config.width to set custom sidebar width via RenderContext - Add unit tests for width configuration
- Add sidebarWidth property to RerunResult interface - Return sidebarWidth from rerun() function - Add unit tests for sidebarWidth functionality
- Add --kt-sidebar-width CSS variable to layout container
- Update CSS to use CSS variable with 280px fallback
- Enables custom sidebar width via kt.sidebar({ width: "350px" })
- Add optional rootId parameter to support sidebar diff updates - When rootId is provided, fallback uses replaceNode instead of replaceRoot - Add unit tests for rootId behavior
- Use diff() and toWebSocketPatches() for sidebar content - Pass rootId parameter for fallback to replaceNode - Handle initial render separately with direct replaceNode
Add E2E tests for sidebar diff updates: - Verify multiple increments work correctly - Verify sidebar structure remains intact after updates
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add @remarks section documenting: