feat: don't spread key in withUnistyles

[jpudysz]

Summary

Fixes error in the console while mapping key:

Summary by CodeRabbit

• New Features
  • Components now support dynamic React keys based on style mappings, improving rendering behavior in lists and dynamic UI scenarios.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
react-native-unistyles-2.0	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 14, 2025 4:42am
react-native-unistyles-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 14, 2025 4:42am

[coderabbitai]

Walkthrough

The changes update the Mappings type to allow an optional key property in its return type. The higher-order component logic in both native and standard implementations is modified to extract and use this key as the React key prop when rendering components, prioritizing uniPropsKey over mappingsKey. No public API signatures are changed.

Changes

Files	Change Summary
src/core/withUnistyles/types.ts	Updated Mappings type to include an optional key?: string property in its return type.
src/core/withUnistyles/withUnistyles.native.tsx src/core/withUnistyles/withUnistyles.tsx	Modified to destructure and use key from mappings and uniProps results as the React key prop; adjusted JSX accordingly.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch feature/dont-spread-keys
• Post Copyable Unit Tests in Comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

src/core/withUnistyles/withUnistyles.native.tsx (1)

94-100: Runtime-changing keys will remount components

key={uniPropsKey || mappingsKey} means the wrapped component is fully remounted whenever either mapping returns a different key between renders.
If those keys are derived from theme/runtime-dependent values (e.g. random IDs, timestamps, colour hashes) you may inadvertently reset component state on every theme change.

Confirm the keys are:

1. Stable for a given render cycle, and
2. Change only when you want a remount.

If stability cannot be guaranteed, consider omitting key entirely outside list contexts, or gating the assignment:

- key={uniPropsKey || mappingsKey}
+ key={uniPropsKey ?? mappingsKey ?? undefined}

src/core/withUnistyles/withUnistyles.tsx (1)

65-69: Potential unnecessary remount (same concern as native file)

See remark in withUnistyles.native.tsx: changing uniPropsKey / mappingsKey between renders will force unmount / mount of NativeComponent, wiping its internal state. Validate key stability or drop it when not required.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d1ec70e and f8d77a9.

📒 Files selected for processing (3)

• src/core/withUnistyles/types.ts (1 hunks)
• src/core/withUnistyles/withUnistyles.native.tsx (2 hunks)
• src/core/withUnistyles/withUnistyles.tsx (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: lint

🔇 Additional comments (3)

src/core/withUnistyles/withUnistyles.native.tsx (1)

78-80: Good extraction of reserved key prop

Destructuring key out of the HOC-level props prevents React’s “key is not a prop” warning. Nice fix.

src/core/withUnistyles/withUnistyles.tsx (2)

30-32: Mirrors native fix — looks good

Same reserved-prop extraction logic as in the native implementation.

---

35-38: Filtering underscore-prefixed style keys

The extra !key.startsWith("_") guard hides private style fields from leaking to the DOM – nice defensive move.