fedimint / ui

https://ui-umber-ten.vercel.app
MIT License
27 stars 41 forks source link

feat: Add validation for federation name and dynamic warning message … #512

Closed kleyberthsantos closed 1 month ago

kleyberthsantos commented 2 months ago

Implement validation for federation name and add dynamic warning messages

Description:

Implemented federation name validation in SetConfiguration.tsx and BasicSettingsForm.tsx. Added a dynamic warning message in FederationSettingsForm.tsx to alert when the federation name field is empty. These improvements ensure that users provide a valid federation name before proceeding with the configuration.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago
Walkthrough ## Walkthrough The changes introduce validation logic for user input in the configuration forms, specifically for the user's name and federation name. This includes dynamically enabling or disabling the "Next" button based on the validity of the inputs. The localization file for English language settings is updated to support these changes. ## Changes | File | Change Summary | |----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `apps/guardian-ui/src/components/setup/screens/setConfiguration/BasicSettingsForm.tsx`
`apps/guardian-ui/src/components/setup/screens/setConfiguration/FederationSettingsForm.tsx`
`apps/guardian-ui/src/components/setup/screens/setConfiguration/SetConfiguration.tsx` | Added validation logic for user and federation names, managing button state and providing immediate feedback. New state management and props introduced for button control. | | `apps/guardian-ui/src/languages/en.json` | Added new localization strings for guardian name validation and federation name context. |

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 29d6643d95294ffd044abe05a2e01662a36691c9 and e6da08e16a67360ab40755df34aa16cfabc8f901.
Files selected for processing (4) * apps/guardian-ui/src/components/setup/screens/setConfiguration/BasicSettingsForm.tsx (3 hunks) * apps/guardian-ui/src/components/setup/screens/setConfiguration/FederationSettingsForm.tsx (3 hunks) * apps/guardian-ui/src/components/setup/screens/setConfiguration/SetConfiguration.tsx (4 hunks) * apps/guardian-ui/src/languages/en.json (2 hunks)
Additional comments not posted (2)
apps/guardian-ui/src/languages/en.json (1)
`226-226`: **Description for federation name is clear and informative.** The description "Gives a name to your Federation" is straightforward and effectively communicates the purpose of the federation name field to the user.
apps/guardian-ui/src/components/setup/screens/setConfiguration/BasicSettingsForm.tsx (1)
`63-67`: **Approve dynamic rendering logic for `FormHelperText`.** The implementation of dynamic messages in `FormHelperText` based on the `myName` input is approved. This approach enhances user feedback by providing relevant messages depending on whether the input is empty.
--- 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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Kodylow commented 2 months ago

can you post pictures / videos of any of the UI changes you make?

kleyberthsantos commented 2 months ago

yes @Kodylow, it is only to require the federation name in the leader configuration. If this is not required, it can be omitted https://github.com/user-attachments/assets/c81a7489-0b49-4c10-9e06-d5c6e0fb6c4e

Kodylow commented 2 months ago

kk can you rebase then I'll test and land

kleyberthsantos commented 1 month ago

kk can you rebase then I'll test and land

yes sure

vercel[bot] commented 1 month ago

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

Name Status Preview Comments Updated (UTC)
ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 6, 2024 11:26pm
Kodylow commented 1 month ago

just tried this I don't really like it, this should be part of a larger refactor to using Toasts for all the errors and warnings instead of just leaving them on the fields/screens continuously

kleyberthsantos commented 1 month ago

cc @Kodylow thanks for your feedback. There is no need to keep working in this issue, as I´m fixing this in another one. You can proceed to close this PR 👍