update README + types #50
Conversation
- breaking change: remove redundant `config.params` - remove redundant container-prop - update READMEs
WalkthroughThe pull request introduces modifications to the Changes
Sequence DiagramsequenceDiagram
participant App
participant ParticlesEngine
participant Particles
App->>ParticlesEngine: initParticlesEngine(loadFull)
ParticlesEngine-->>App: Initialization Complete
App->>Particles: Render with Config
Particles-->>App: Particles Rendered
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
components/solid/README.md (1)
33-46: Replace placeholder URL with actual example URL.The example uses a placeholder URL
https://foo.bar/particles.jsonwhich should be replaced with a real, working example URL.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
README.md(1 hunks)apps/solid/src/App.tsx(1 hunks)components/solid/README.md(2 hunks)components/solid/package.json(1 hunks)components/solid/src/IParticlesProps.ts(0 hunks)components/solid/src/Particles.tsx(1 hunks)
💤 Files with no reviewable changes (1)
- components/solid/src/IParticlesProps.ts
✅ Files skipped from review due to trivial changes (1)
- apps/solid/src/App.tsx
🧰 Additional context used
🪛 Markdownlint (0.37.0)
components/solid/README.md
49-49: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
README.md
49-49: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (5)
components/solid/src/Particles.tsx (1)
9-9: LGTM! Configuration handling simplified.The changes effectively streamline the configuration by:
- Ensuring
optionsis always defined throughmergeProps- Removing redundant
paramsproperty- Simplifying the resource creation logic
Let's verify that all usages of the removed
paramsproperty have been updated:Also applies to: 15-15
✅ Verification successful
✅ Verified:
paramsproperty removal is completeThe codebase scan confirms that all
paramsreferences have been properly removed, and configuration handling is consistently using the newmergePropspattern.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining usage of params property rg -l "params.*tsparticles" || echo "No remaining params usage found"Length of output: 102
Script:
#!/bin/bash # More thorough verification echo "=== Checking for any params usage in Solid files ===" fd -e tsx -e ts -e jsx -e js . components/solid/src -x rg -l "params" {} || echo "No params found in Solid components" echo -e "\n=== Checking for tsParticles configuration patterns ===" fd -e tsx -e ts -e jsx -e js . components/solid/src -x rg -l "tsparticles.*options|tsparticles.*config" {} || echo "No config patterns found" echo -e "\n=== Checking tests and examples ===" fd -e tsx -e ts -e jsx -e js . components/solid/tests components/solid/demo -x rg -l "params" {} || echo "No params usage in tests/examples"Length of output: 1043
components/solid/package.json (1)
120-120: LGTM! Focused TypeScript linting.The linting scope has been appropriately narrowed to TypeScript files, which aligns with the project's TypeScript-first approach.
components/solid/README.md (2)
52-67: LGTM! Improved example code.The example has been enhanced with:
- Modern Solid.js patterns using
Showcomponent- Simplified initialization using
createResource- Standard configuration using
configs.basic
80-81: LGTM! Standardized prop names.Props have been renamed to align with HTML standards:
className→classcanvasClassName→canvasClassREADME.md (1)
33-46: LGTM! Documentation consistency maintained.The changes in the main README.md mirror those in components/solid/README.md, maintaining consistency across documentation files.
Also applies to: 52-67, 80-81
params-propcontainer-propTODO:
update
codesandboxonce we published this version (currently they are pointing to a pre@tsparticles/solidversion)Summary by CodeRabbit
Documentation
@tsparticles/solidlibraryclassName→class,canvasClassName→canvasClass)Refactor
ShowcomponentChores