Skip to content

refactor(esl-image): officially deprecate ESLImage#3742

Open
ala-n wants to merge 1 commit intomainfrom
chore/deprecate-image
Open

refactor(esl-image): officially deprecate ESLImage#3742
ala-n wants to merge 1 commit intomainfrom
chore/deprecate-image

Conversation

@ala-n
Copy link
Copy Markdown
Collaborator

@ala-n ala-n commented Apr 15, 2026

No description provided.

@ala-n ala-n added this to the ⚡ESL: 6.0.0 Major release milestone Apr 15, 2026
@ala-n ala-n requested review from a team April 15, 2026 01:47
@ala-n ala-n self-assigned this Apr 15, 2026
@ala-n ala-n requested review from NastaLeo, Copilot, dshovchko and yadamskaya and removed request for a team April 15, 2026 01:47
@ala-n ala-n added the needs review The PR is waiting for review label Apr 15, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR deprecates the legacy ESLImage custom element and removes it from the primary ESL “all” entrypoints, while keeping it available for the website demo app via explicit legacy imports.

Changes:

  • Mark ESLImage as deprecated in its JSDoc.
  • Remove esl-image exports/styles from packages/esl/src/all.ts and packages/esl/src/all.less.
  • Re-add legacy ESLImage exports/styles explicitly in packages/esl-website for demos.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/esl/src/esl-image/core/esl-image.ts Adds a deprecation notice to the ESLImage public API docs.
packages/esl/src/all.ts Stops re-exporting legacy esl-image from the main barrel entrypoint.
packages/esl/src/all.less Stops including legacy esl-image styles in the aggregated LESS bundle.
packages/esl-website/src/lib.ts Re-exports ESLImage via a deep import for website demos.
packages/esl-website/src/lib.less Re-imports legacy esl-image LESS for website demos.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -10,7 +10,6 @@ export * from './esl-traversing-query/core';
export * from './esl-a11y-group/core';

// Image
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

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

Removing the export * from './esl-image/core' re-export is a breaking API change for consumers that import ESLImage (and related types like ESLImageTagShape) from @exadel/esl (which maps to modules/all). If the intent is to deprecate rather than remove, consider keeping the re-export and relying on @deprecated annotations (or re-exporting with a deprecation notice) for at least one release cycle; otherwise this should be treated/communicated as a removal in the public entrypoint.

Suggested change
// Image
// Image
export * from './esl-image/core';

Copilot uses AI. Check for mistakes.
@import './esl-utils/all.less';

@import './esl-image/core.less';
@import './esl-image-utils/all.less';
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

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

Dropping esl-image/core.less from the aggregated all.less bundle changes the styling contract for consumers that previously relied on @exadel/esl/modules/all.less to include legacy esl-image styles (e.g., .img-container and [lazy]/[ready] rules). If the goal is a gradual deprecation, consider keeping the import for now (possibly behind a separate legacy bundle) to avoid silent visual regressions, or ensure the removal is clearly communicated as a breaking change.

Suggested change
@import './esl-image-utils/all.less';
@import './esl-image-utils/all.less';
@import './esl-image/core.less';

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs review The PR is waiting for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants