chore(grid): deprecate component #3625
Conversation
Kiarokh
added
the
maintenance
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe changes remove the example grid SCSS and Stencil component files, eliminating the demonstration of the grid layout and its related styles. The main grid component is updated to include a deprecation notice in its documentation and logs a warning during component loading, advising users to use CSS grid layouts directly. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GridComponent
User->>GridComponent: Load limel-grid
activate GridComponent
GridComponent->>Console: Log deprecation warning
GridComponent-->>User: Render slot content
deactivate GridComponent
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
Documentation and Community
|
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the limel-grid component in favor of using native CSS grid layout capabilities. The component is being phased out as CSS grid provides more flexibility and advanced features than the wrapper component offers.
- Adds deprecation warnings and documentation to the grid component
- Removes the example implementation files to discourage further usage
- Marks the component as private in JSDoc
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/components/grid/grid.tsx | Adds deprecation warning, updates JSDoc with @deprecated and @Private tags |
| src/components/grid/examples/grid.tsx | Removes example component implementation |
| src/components/grid/examples/grid.scss | Removes example styling and grid configuration |
| styleUrl: 'grid.scss', | ||
| }) | ||
| export class Grid { | ||
| public componentWillLoad() { |
There was a problem hiding this comment.
[nitpick] Consider using componentDidLoad() instead of componentWillLoad() for the deprecation warning. This ensures the warning appears after the component is fully loaded and won't interfere with the component's initialization process.
| public componentWillLoad() { | |
| public componentDidLoad() { |
There was a problem hiding this comment.
I copied from limel-flex-container where we do the same thing using componentWillLoad()
|
Documentation has been published to https://lundalogik.github.io/lime-elements/versions/PR-3625/ |
What you can do with CSS is way more flexible and advanced than what this component offers
|
🎉 This PR is included in version 38.20.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What you can do with CSS is way more flexible and advanced than what this component offers
Summary by CodeRabbit
Review:
Browsers tested:
(Check any that applies, it's ok to leave boxes unchecked if testing something didn't seem relevant.)
Windows:
Linux:
macOS:
Mobile: