Skip to content

chore(grid): deprecate component #3625

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.

Sign up for GitHub

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

Merged
Kiarokh merged 1 commit into from
Aug 1, 2025
Merged

chore(grid): deprecate component #3625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions etc/lime-elements.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,7 @@ export namespace Components {
"transformErrors"?: (errors: FormError[]) => FormError[];
"value": object;
}
// @deprecated
export interface LimelGrid {
}
export interface LimelHeader {
Expand Down Expand Up @@ -1549,6 +1550,7 @@ export namespace JSX {
"transformErrors"?: (errors: FormError[]) => FormError[];
"value"?: object;
}
// @deprecated
export interface LimelGrid {
}
export interface LimelHeader {
Expand Down
94 changes: 0 additions & 94 deletions src/components/grid/examples/grid.scss
View file
Open in desktop

This file was deleted.

49 changes: 0 additions & 49 deletions src/components/grid/examples/grid.tsx
View file
Open in desktop

This file was deleted.

14 changes: 10 additions & 4 deletions src/components/grid/grid.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { Component, h } from '@stencil/core';

/**
* The `limel-grid` component creates a grid which can be used to control the
* layout of other components. It uses CSS [grid-template-areas](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-areas)
* to enable easy configuration of its child-elements.
* This component is deprecated and will be removed in a future version of
* Lime Elements. Please use CSS for your flexible container needs 🙂
*
* @exampleComponent limel-example-grid
* @deprecated Please use CSS instead https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout
* @private
* @slot - Grid content
*/
@Component({
Expand All @@ -14,6 +14,12 @@ import { Component, h } from '@stencil/core';
styleUrl: 'grid.scss',
})
export class Grid {
public componentWillLoad() {
Copy link

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

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

[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.

Suggested change
public componentWillLoad() {
public componentDidLoad() {

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@Kiarokh Kiarokh Jul 31, 2025

Choose a reason for hiding this comment

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

I copied from limel-flex-container where we do the same thing using componentWillLoad()

console.warn(
'limel-grid is deprecated, please use CSS instead: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout'
);
}

public render() {
return <slot />;
}
Expand Down