[WEB-3979] Additional modification props for Encapsulated icons

[jamiehenson]

Jira Ticket Link / Motivation

Summary of changes

Adds extra props to modify EncapsulatedIcon because the designs differ across the pages on how it should look

How do you manually test this?

Reviewer Tasks (optional)

Merge/Deploy Checklist

• Written automated tests for implemented features/fixed bugs
• Rebased and squashed commits
• Commits have clear descriptions of their changes
• Checked for any performance regressions

Frontend Checklist

• No frontend changes in this PR
• Added before/after screenshots for changes
• Tested on different platforms/browsers with Browserstack
• Compared with the initial design / our brand guidelines
• Checked the code for accessibility issues (VoiceOver User Guide)?

Summary by CodeRabbit

• New Features

  • Updated the version of the @ably/ui package to 14.6.1, indicating potential bug fixes and improvements.
  • Introduced new props in the EncapsulatedIcon component for enhanced customization: innerClassName for additional styling and iconSize for specifying custom icon sizes.

• Bug Fixes

  • Adjusted logic for calculating icon size to accommodate new customization options.

[coderabbitai]

Walkthrough

The changes in this pull request involve updating the version number of the @ably/ui package in package.json and modifying the EncapsulatedIcon component in src/core/Icon/EncapsulatedIcon.tsx. The version is incremented from 14.6.0-dev.fd4036a to 14.6.1, indicating a minor release. The EncapsulatedIcon component now supports two new optional props: innerClassName for additional styling and iconSize for custom icon sizing, enhancing the component's flexibility without altering its core structure.

Changes

File	Change Summary
package.json	Updated version from 14.6.0-dev.fd4036a to 14.6.1.
src/core/Icon/EncapsulatedIcon.tsx	Added innerClassName?: string and iconSize?: string to EncapsulatedIconProps. Modified logic to accommodate new iconSize prop.

Possibly related PRs

• [WEB-3979] Encapsulated icons #487: The changes in this PR involve modifications to the EncapsulatedIcon component in src/core/Icon/EncapsulatedIcon.tsx, which directly relates to the updates made in the main PR regarding the same file and component.

Suggested labels

review

Suggested reviewers

• aralovelace

🐇 In the garden where icons play,
A new size blooms, bright as day.
With class names added, style's a breeze,
Custom icons dance with ease.
Version's up, let’s hop and cheer,
Changes made, the time is near! 🌼

---

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?

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.
  -- Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  -- @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 generate unit testing code.
  -- @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.

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 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: 0

Outside diff range and nitpick comments (1)

src/core/Icon/EncapsulatedIcon.tsx (1)

16-18: Nitpick: Maintain consistency in the order of the destructured props.

Consider reordering the destructured props to match the order in which they are declared in the EncapsulatedIconProps type:

-  className,
-  innerClassName,
   iconSize,
+  className,
+  innerClassName,
   ...iconProps

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 18de5c0 and ce1cac8.

Files ignored due to path filters (2)

• src/core/Icon/__snapshots__/Icon.stories.tsx.snap is excluded by !**/*.snap
• src/core/ProductTile/__snapshots__/ProductTile.stories.tsx.snap is excluded by !**/*.snap

Files selected for processing (2)

• package.json (1 hunks)
• src/core/Icon/EncapsulatedIcon.tsx (1 hunks)

Files skipped from review due to trivial changes (1)

• package.json

Additional comments not posted (4)

src/core/Icon/EncapsulatedIcon.tsx (4)

9-10: LGTM!

The addition of the optional innerClassName and iconSize props enhances the flexibility and customization options for the EncapsulatedIcon component. The types of the new props are appropriate.

---

23-25: LGTM!

The logic for determining the value of numericalIconSize based on the iconSize prop is correct. If iconSize is provided, it is parsed and used; otherwise, the previous behavior of subtracting 12 from numericalSize is maintained.

---

33-33: LGTM!

The innerClassName prop is correctly added to the className of the inner div, allowing for additional styling flexibility. The nullish coalescing operator ?? is used appropriately to provide an empty string as a fallback if innerClassName is not provided.

---

36-36: LGTM!

The size prop of the Icon component is correctly set to the value of numericalIconSize, which is determined based on the iconSize prop or the default calculation. The value is properly interpolated into a string to match the expected type of the size prop.