Skip to content
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.

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

Remove unprefixed elements #559

Merged
merged 5 commits into from
Jan 4, 2025
Merged

Remove unprefixed elements #559

merged 5 commits into from
Jan 4, 2025

Conversation

trezy
Copy link
Collaborator

@trezy trezy commented Dec 31, 2024

Description of change
  • Removes unprefixed elements by default
  • Updates the README
    • Update supported React versions
    • Update minimum Pixi.js version in install command
    • Remove deprecated APIs
    • Abstract Typescript docs into their own section
    • Add documentation for enabling the unprefixed elements

Fixes: #549

Pre-Merge Checklist
  • Tests and/or benchmarks are included
  • Documentation is changed or added
  • Lint process passed (npm run lint)
  • Tests passed (npm run test)

BREAKING CHANGE: unprefixed elements must be explicitly added

Signed-off-by: Trezy <[email protected]>
@trezy trezy added enhancement New feature or request v8 Issues related to Pixi React v8 labels Dec 31, 2024
@trezy trezy self-assigned this Dec 31, 2024
Copy link

codesandbox-ci bot commented Dec 31, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 1ba1ba6:

Sandbox Source
pixi.js-sandbox Configuration

@trezy trezy force-pushed the remove-unprefixed-elements branch from 0b85efa to 2e0981d Compare December 31, 2024 08:11
@trezy trezy requested a review from thejustinwalsh January 1, 2025 02:47
@thejustinwalsh
Copy link
Collaborator

thejustinwalsh commented Jan 1, 2025

I tested the PR in 2 passes on an existing project...

  1. React 19 & Unprefixed Elements: thejustinwalsh/infinistg@66a2fc7
  2. Prefixed Elements: thejustinwalsh/infinistg@4e195cb

It might be worth documenting the pattern for extending built in types, as it changes slightly as well...

// before @pixi/react#559
export type TilingSpriteProps = JSX.IntrinsicElements['tilingSprite'] & {
  image?: string;
  texture?: Texture;
};


// after @pixi/react#559
export type TilingSpriteProps = PixiElements['pixiTilingSprite'] & {
  image?: string;
  texture?: Texture;
};

thejustinwalsh
thejustinwalsh previously approved these changes Jan 1, 2025
Copy link
Collaborator

@thejustinwalsh thejustinwalsh left a comment

Choose a reason for hiding this comment

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

This is a great solution, works wonderfully and leaves control in the user's hands for pixi element naming preference.

@trezy trezy enabled auto-merge January 4, 2025 05:58
@trezy trezy requested a review from thejustinwalsh January 4, 2025 06:02
@trezy trezy added this pull request to the merge queue Jan 4, 2025
Merged via the queue into beta with commit 003d0bb Jan 4, 2025
5 checks passed
@trezy trezy deleted the remove-unprefixed-elements branch January 4, 2025 06:08
Copy link

github-actions bot commented Jan 4, 2025

🎉 This PR is included in version 8.0.0-beta.20 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released on @beta v8 Issues related to Pixi React v8
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants