feat(features): add tooltip to the inactive field publisher records

[FussuChalice]

Description

Add tooltip to the inactive field (if whole year is on)

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• Any dependent changes have been merged and published in downstream modules

[vercel]

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

Name	Status	Preview	Updated (UTC)
organized-app	✅ Ready (Inspect)	Visit Preview	Nov 13, 2024 7:42am

[rhahao]

Task linked: CU-86c0wkqn2 Add tooltip to the inactive field – Publisher records

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)

• src/locales/en/general.json is excluded by !**/*.json

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes in this pull request involve the integration of a Tooltip component around the MonthSelector component in the YearDetails section. The tooltip displays a message when the wholeYear property is true, enhancing the user interface. Additionally, a minor formatting change was made to the MonthSelectorProps type definition by adding a semicolon to the readOnly property. Overall, the structure of the components remains unchanged.

Changes

File	Change Summary
src/features/reports/publisher_records/years_stats/year_details/index.tsx	Added Tooltip around MonthSelector to display a message when wholeYear is true.
src/features/reports/service_year_month_selector/month_selector/index.types.ts	Updated MonthSelectorProps by adding a semicolon to the readOnly property for consistent formatting.

Possibly related PRs

• feat(components): add tooltips #2833: This PR introduces tooltips to various components, which is directly related to the main PR's addition of a Tooltip component around the MonthSelector.
• feat(features): add tooltips for speakers_catalog and fix bug with it… #2842: This PR also adds tooltips to the speakers_catalog, enhancing the user interface similarly to the changes made in the main PR.
• feat(features/about): add tooltip for force reload button #2862: This PR adds a tooltip to the force reload button, further aligning with the tooltip functionality introduced in the main PR.

---

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/features/reports/publisher_records/years_stats/year_details/index.tsx (1)

29-47: Good implementation with room for minor enhancements.

The Tooltip integration effectively enhances the UI by providing context when the whole year is selected. The implementation maintains layout consistency and properly handles translations.

Consider these accessibility and UX improvements:

 <Tooltip
   title={t('tr_wholeYearIsSelected')}
   delaySpeed={'fast'}
   show={wholeYear}
   followCursor
+  placement="top"
+  aria-label={t('tr_wholeYearIsSelected')}
   sx={{
     flex: 1,
   }}
 >

The placement prop ensures consistent positioning across different screen sizes, while aria-label improves accessibility for screen readers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 20deb1d and 3f20c31.

⛔ Files ignored due to path filters (1)

• src/locales/en/general.json is excluded by !**/*.json

📒 Files selected for processing (2)

• src/features/reports/publisher_records/years_stats/year_details/index.tsx (2 hunks)
• src/features/reports/service_year_month_selector/month_selector/index.types.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/features/reports/service_year_month_selector/month_selector/index.types.ts

🔇 Additional comments (1)

src/features/reports/publisher_records/years_stats/year_details/index.tsx (1)

11-11: LGTM! Import statement follows project conventions.

The Tooltip component import is correctly placed and uses the established absolute path pattern.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[cypress]

organized-app    Run #1567

Run Properties:   Passed #1567  •  e51f835d50: feat(features): add tooltip to the inactive field publisher records

Project	organized-app
Branch Review	main
Run status	Passed #1567
Run duration	00m 12s
Commit	e51f835d50: feat(features): add tooltip to the inactive field publisher records
Committer	Max Makaluk
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	0
Skipped	0
Passing	1
View all changes introduced in this branch ↗︎

[rhahao]

🎉 This PR is included in version 2.130.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀