cloudoperators / juno

Monorepo for the Juno modular frontend framework, apps, design system and component library

http://cloudoperators.github.io/juno/

Apache License 2.0

4 stars 0 forks source link

chore(ui): migrate InputGroup to Typescript #569

Closed guoda-puidokaite closed 1 week ago

guoda-puidokaite commented 2 weeks ago

Summary

Migrated the InputGroup component to TypeScript, enhancing code quality, maintainability, and scalability.
Utilised static typing to minimize runtime errors and improve the development experience.
Refactored the component for cleaner, more maintainable code.

Changes Made

TypeScript Migration:

Converted InputGroup component files to TypeScript.
Added comprehensive type annotations.
Introduced a deprecated InputGroup component for Javascript files.

Refactoring:

Made necessary adjustments to address TypeScript-detected issues.
Further refactored for cleaner and more understandable code.

Testing:

Added edge cases:
- renders without children
- renders with a mix of enabled and disabled children
- allows custom attributes to be passed to children
Removed NativeSelect component from tests and stories, as not yet converted.
Organised tests by what they check for better readability and maintenance.
Verified component behaviour using Storybook.
Updated tests to use vitest.

Documentation:

Updated Storybook documentation.

Screenshot: Deprecated .js code on the left, migrated .ts code on the right

Screenshot 2024-10-28 at 17 23 36

Release:

Generated a changeset file.

Related Issues

https://github.com/cloudoperators/juno/issues/231

Testing Instructions

Run Storybook
Run InputGroup tests

Checklist

[x] I have performed a self-review of my code.
[x] I have commented my code, particularly in hard-to-understand areas.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] New and existing unit tests pass locally with my changes.
[x] I have made corresponding changes to the documentation (if applicable).
[x] My changes generate no new warnings or errors.

changeset-bot[bot] commented 2 weeks ago

🦋 Changeset detected

Latest commit: 8b2f3a67cdf5d9cc115881a1d8758d3cb7128093

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ---------------------------------- | ----- | | @cloudoperators/juno-ui-components | Minor |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions[bot] commented 2 weeks ago

PR Preview Action v1.4.8 :---: Preview removed because the pull request was closed. 2024-11-04 08:23 UTC

barsukov commented 2 weeks ago

Ups, tests, lint and typescript has a diferent opinion haha :)

guoda-puidokaite commented 2 weeks ago

Thank You for the initial review though! Still a draft, working on the tests and story. Issue in PR description. 🤪