Add a new Goal component.

greinard commented 1 month ago

Overview

This branch adds a new Goal component.

The component supports the following configuration:

label - The label to display next to the progress indicator.
targetValue - The value at which the goal has been "met" or "completed".
maxValue - The maximum value to use for the progress indicator (the denominator).
valueProvider - A SingleValueProvider<number> implementation that provides a single numeric progress value. Current implementations include static, random, and custom field value providers.
icon - An optional FontAwesome icon override. By default the star (solid) icon is used.
notStartedColor - Optionally override the color used when no progress has been made toward the goal.
inProgressColor - Optionally override the color used when the value is greater than 0, but still less than the targetValue.
completedColor - Optionally override the color used when the value is greater than or equal to the targetValue (i.e. once the goal has been met).

Here are a few samples from the storybook:

achievements_screenshot

I will reset the snapshot version numbers prior to merging.

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.
No new security risks. This branch just adds a new UI component for visualizing progress toward a goal.

Checklist

Testing

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

Documentation

[x] I have added relevant Storybook updates to this PR as well.

Summary by CodeRabbit

Release Notes

New Features
- Introduced a new Goal component for visualizing goal progress with a pie chart.
- Added a new CSS file to enhance the styling of goal-related components.
- Implemented a preview state feature for goals with various states (not started, in progress, complete, etc.).
- Enhanced Storybook configuration for the Goal component, showcasing different scenarios.
Chores
- Updated module exports to include new components and types for better accessibility.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request introduce several new components and functionalities related to goal visualization within the application. A new CSS file provides styling for goal-related elements, while a React component (Goal.tsx) is added to visualize goal progress using a pie chart. Additionally, a preview data file defines types and functions for managing goal states. Storybook configurations are created to showcase the Goal component in various scenarios. Helper functions for value providers are also implemented to support different goal states, enhancing the overall functionality and structure of the goal-related features.

Changes

File Path	Change Summary
`src/components/container/Goal/Goal.css`	New CSS file added with classes for styling goal components.
`src/components/container/Goal/Goal.previewData.ts`	New file defining `GoalPreviewState` type and `createPreviewValueProvider` function.
`src/components/container/Goal/Goal.stories.tsx`	New Storybook configuration with stories for the `Goal` component.
`src/components/container/Goal/Goal.tsx`	New React component for visualizing goal progress with a pie chart.
`src/components/container/Goal/index.ts`	Added exports for the default `Goal` component and `GoalPreviewState` type.
`src/components/container/index.ts`	Export statement added for `Goal` and `GoalPreviewState`.
`src/helpers/index.ts`	New export statement for all members from `single-value-providers`.
`src/helpers/single-value-providers.ts`	Comprehensive implementation of single-value providers and related factory functions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GoalComponent
    participant ValueProvider

    User->>GoalComponent: Request to view goal
    GoalComponent->>ValueProvider: Get current value
    ValueProvider-->>GoalComponent: Return value
    GoalComponent->>User: Display goal progress

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.

greinard commented 1 month ago

This feels more like a presentation than container component.

Per our README, here is the differentiation between presentational and container components:

### Presentational Components

Presentational components do NOT fetch data to populate themselves.  They are the underlying UI building blocks of the views and connected components.  These are things such as buttons, cards, and a display for a single survey task.

### Container Components

Container components fetch data via the MyDataHelps.js SDK.  These components will only function if used in a view inside MyDataHelps or via manually passing an access token to the SDK.

Since the Goal component fetches data for itself using the MDH.js SDK (among other sources), I think it fits best with the container components.

For example, this could not be dropped into vb without a wrapper. Unless I am missing something?

The Goal component can be dropped into the ViewBuilder anywhere and it should function appropriately. A user may wish to place it within a Card or a Section component, but that wouldn't be necessary.

greinard commented 1 month ago

I think I have addressed all of the feedback thus far. Please let me know if I have not alleviated a concern or if you would like me to address anything else/further.

greinard commented 1 month ago

I have reverted the snapshot version numbers. I would like to merge this today, if possible.

Are there any further objections or requests for delay?

Thanks!

CareEvolution / MyDataHelpsUI