Add ability to hide SurveyTaskList if empty

[felideon]

Overview

Adds hideIfEmpty and emptyText props to the SurveyTaskList component.

• For incomplete task lists, hideIfEmpty helps users not have to implement their own conditionals using schedules/custom fields, and makes it nice to use multiple task lists on the same view, which the surveyCategory property now makes more likely to occur.
• Previously, complete task lists were always hidden if empty. The new property allows users to display an empty complete task list, but, by default (i.e. if hideIfEmpty is undefined) will keep the previous behavior.
• emptyText provides a way for users to override the default string for empty lists, which was also changed (and re-translated). Previously, only incomplete task lists had a message when empty, but now there's also a default message for empty complete task lists.

Also includes a refactor to make the SurveyTaskList stories code consistent with more recent components, fixing a type deprecation.

Security

REMINDER: All file contents are public.

• [x] I have ensured no secure credentials or sensitive information remain in code, metadata, comments, etc.
  • [x] Please verify that you double checked that .storybook/preview.js does not contain your participant access key details.
  • [x] There are no temporary testing changes committed such as API base URLs, access tokens, print/log statements, etc.
• [x] These changes do not introduce any security risks, or any such risks have been properly mitigated.

Checklist

Testing

• [ ] MyDataHelps iOS app
• [ ] MyDataHelps Android app
• [ ] MyDataHelps website

Documentation

• [x] I have added relevant Storybook updates to this PR as well.
• [ ] If this feature requires a developer doc update

Consider "Squash and merge" as needed to keep the commit history reasonable on main.

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Enhanced SurveyTaskList component to manage and display empty states with customizable messages.
  • Added new stories in Storybook to demonstrate various states of the SurveyTaskList, including EmptyIncomplete and EmptyComplete.
  • Updated localization for task completion messages across multiple languages to provide clearer feedback on task statuses.

• Bug Fixes

  • Improved handling of loading states and rendering logic when no tasks are available.

[coderabbitai[bot]]

Walkthrough

The changes involve modifications to the SurveyTaskList component and its associated Storybook stories. The SurveyTaskList.stories.tsx file has been refactored to use a new render function for story definitions, replacing the previous Template function. Additionally, several stories have been updated or added to enhance their structure. In the SurveyTaskList.tsx file, new optional properties hideIfEmpty and emptyText have been introduced to the component's props, and the logic has been updated to handle an "Empty" state, improving the component's flexibility in managing task displays.

Changes

File Path	Change Summary
src/components/container/SurveyTaskList/SurveyTaskList.stories.tsx	- Refactored story definitions to use a new render function instead of Template. - Updated existing stories and added new stories (EmptyIncomplete, EmptyComplete).
src/components/container/SurveyTaskList/SurveyTaskList.tsx	- Added optional properties hideIfEmpty and emptyText to SurveyTaskListProps. - Expanded SurveyTaskListListPreviewState to include "Empty". - Updated rendering logic to handle empty states.
src/helpers/strings-de.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".
src/helpers/strings-en.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".
src/helpers/strings-es.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".
src/helpers/strings-fr.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".
src/helpers/strings-it.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".
src/helpers/strings-nl.ts	- Added keys "empty-tasks-incomplete" and "empty-tasks-complete" without removing any existing keys.
src/helpers/strings-pl.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".
src/helpers/strings-pt.ts	- Removed key "all-tasks-complete" and added keys "empty-tasks-incomplete" and "empty-tasks-complete".

---

📜 Recent review details

**Configuration used: CodeRabbit UI** **Review profile: CHILL**

📥 Commits

Files that changed from the base of the PR and between cd9fa5491e32d2549d8b4ce1590de78b079ef04e and b76545b91ec4da4f75bce7b629dac07ba40265ae.

📒 Files selected for processing (1)

* src/components/container/SurveyTaskList/SurveyTaskList.tsx (4 hunks)

🧰 Additional context used

🪛 Biome

src/components/container/SurveyTaskList/SurveyTaskList.tsx

[error] 19-19: Don't use 'Function' as a type. Prefer explicitly define the function shape. This type accepts any function-like value, which can be a common source of bugs. (lint/complexity/noBannedTypes)

🔇 Additional comments (5)

src/components/container/SurveyTaskList/SurveyTaskList.tsx (5)

`28-29`: **Added 'hideIfEmpty' and 'emptyText' properties to SurveyTaskListProps** The inclusion of the optional `hideIfEmpty` and `emptyText` properties enhances the component's flexibility, allowing for conditional rendering and custom empty messages. --- `32-32`: **Updated 'SurveyTaskListListPreviewState' to include 'Empty' state** Extending the `SurveyTaskListListPreviewState` type with the `"Empty"` state improves the component's preview capabilities, enabling simulation of empty task lists. --- `93-97`: **Properly handle the 'Empty' preview state** The implementation correctly handles the `"Empty"` preview state by setting `tasks` to an empty array and updating the loading state, ensuring accurate previews. --- `143-147`: **Correctly manage 'hideIfEmpty' based on 'status'** The logic ensures that when `status` is `"complete"`, `hideIfEmpty` defaults to `true`, maintaining backward compatibility and aligning with expected behavior. --- `162-164`: **Simplified rendering of the empty message** Using `props.emptyText?.trim() || language(\`empty-tasks-\${props.status}\`)` enhances readability and efficiently handles the empty message display.

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.