Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert EditFieldModal.jsx to tsx #3865

Merged
merged 4 commits into from
Nov 21, 2024
Merged

Convert EditFieldModal.jsx to tsx #3865

merged 4 commits into from
Nov 21, 2024

Conversation

joel-jeremy
Copy link
Contributor

No description provided.

@actual-github-bot actual-github-bot bot changed the title Convert EditFieldModal.jsx to tsx [WIP] Convert EditFieldModal.jsx to tsx Nov 20, 2024
Copy link

netlify bot commented Nov 20, 2024

Deploy Preview for actualbudget ready!

Name Link
🔨 Latest commit a7ac6f1
🔍 Latest deploy log https://app.netlify.com/sites/actualbudget/deploys/673e7e341b5557000861f837
😎 Deploy Preview https://deploy-preview-3865.demo.actualbudget.org
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@joel-jeremy joel-jeremy changed the title [WIP] Convert EditFieldModal.jsx to tsx Convert EditFieldModal.jsx to tsx Nov 20, 2024
Copy link
Contributor

github-actions bot commented Nov 20, 2024

Bundle Stats — desktop-client

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
10 5.42 MB → 5.42 MB (-139 B) -0.00%
Changeset
File Δ Size
src/components/modals/EditFieldModal.tsx 🆕 +7.47 kB 0 B → 7.47 kB
src/components/modals/EditFieldModal.jsx 🔥 -7.61 kB (-100%) 7.61 kB → 0 B
View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

Asset File Size % Changed
static/js/index.js 3.44 MB → 3.44 MB (-139 B) -0.00%

Unchanged

Asset File Size % Changed
static/js/indexeddb-main-thread-worker-e59fee74.js 13.5 kB 0%
static/js/workbox-window.prod.es5.js 5.69 kB 0%
static/js/resize-observer.js 18.37 kB 0%
static/js/BackgroundImage.js 122.29 kB 0%
static/js/useAccountPreviewTransactions.js 1.63 kB 0%
static/js/narrow.js 82.72 kB 0%
static/js/AppliedFilters.js 21.32 kB 0%
static/js/wide.js 241.19 kB 0%
static/js/ReportRouter.js 1.49 MB 0%

Copy link
Contributor

github-actions bot commented Nov 20, 2024

Bundle Stats — loot-core

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count Total bundle size % Changed
1 1.32 MB 0%

Changeset

No files were changed

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset File Size % Changed
kcab.worker.js 1.32 MB 0%

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The pull request modifies the EditFieldModal component in EditFieldModal.tsx by enhancing type safety and refactoring input element handling. A new type NoteAmendMode is introduced, allowing the onSubmit function to accept an optional mode parameter with specific string literals ('replace', 'prepend', 'append'). The EditFieldModalProps type is defined to specify the props structure, which includes name, onSubmit, and onClose. The component now uses the useRef hook to manage a reference to the input element, replacing the previous method of accessing the DOM with document.getElementById. The onSelectNote and onSelect functions have updated type annotations for their parameters, ensuring compliance with expected types. State management for noteAmend is updated to explicitly indicate it can only be one of the specified string literals. The inputStyle variable is explicitly typed as CSSProperties, aligning with the new import of CSSProperties. Overall, these changes improve type safety and code clarity.

Possibly related PRs

Suggested labels

:sparkles: Merged

Suggested reviewers

  • matt-fidd
  • MikesGlitch

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/desktop-client/src/components/modals/EditFieldModal.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eslint-plugin".

(The package "eslint-plugin-eslint-plugin" was not found when loaded as a Node module from the directory "/packages/eslint-plugin-actual".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eslint-plugin@latest --save-dev

The plugin "eslint-plugin-eslint-plugin" was referenced from the config file in "packages/eslint-plugin-actual/.eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a10fe1d and a7ac6f1.

📒 Files selected for processing (1)
  • packages/desktop-client/src/components/modals/EditFieldModal.tsx (6 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/desktop-client/src/components/modals/EditFieldModal.tsx

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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
packages/desktop-client/src/components/modals/EditFieldModal.tsx (2)

1-1: Optimize React imports

Consider using named imports directly instead of the default React import to align with modern React practices.

-import React, { type CSSProperties, useRef, useState } from 'react';
+import { type CSSProperties, useRef, useState } from 'react';
🧰 Tools
🪛 GitHub Check: lint

[warning] 1-1:
Imports "React" are only used as type


42-42: Consider using a more specific type for the input ref

While HTMLInputElement is correct, consider creating a type that includes only the methods and properties you actually use (focus) for better type safety.

-const noteInputRef = useRef<HTMLInputElement | null>(null);
+type InputRefType = {
+  focus: () => void;
+};
+const noteInputRef = useRef<InputRefType | null>(null);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f523d25 and 9e80204.

⛔ Files ignored due to path filters (1)
  • upcoming-release-notes/3865.md is excluded by !**/*.md
📒 Files selected for processing (1)
  • packages/desktop-client/src/components/modals/EditFieldModal.tsx (6 hunks)
🧰 Additional context used
🪛 GitHub Check: lint
packages/desktop-client/src/components/modals/EditFieldModal.tsx

[warning] 1-1:
Imports "React" are only used as type


[warning] 66-66:
Using default React import is discouraged, please use named exports directly instead

🔇 Additional comments (3)
packages/desktop-client/src/components/modals/EditFieldModal.tsx (3)

26-34: LGTM! Well-structured type definition

The EditFieldModalProps type is well-defined with clear type annotations for all props, including the union type for the mode parameter.


207-213: LGTM! Proper ref and event handling

The Input component implementation with ref forwarding and event handling is well done.


Line range hint 1-275: Overall excellent TypeScript conversion

The conversion to TypeScript has been done thoroughly with proper type annotations, maintaining the original functionality while adding type safety. The component structure, prop types, and event handlers are well-typed and follow TypeScript best practices.

🧰 Tools
🪛 GitHub Check: lint

[warning] 66-66:
Using default React import is discouraged, please use named exports directly instead

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
packages/desktop-client/src/components/modals/EditFieldModal.tsx (2)

1-1: Use named imports from React

Consider using named imports directly from React instead of the default import.

-import React, { type CSSProperties, useRef, useState } from 'react';
+import { type CSSProperties, useRef, useState, type ReactNode } from 'react';
🧰 Tools
🪛 GitHub Check: lint

[warning] 1-1:
Imports "React" are only used as type


140-140: Consider extracting duplicated button styles

The button styles and focus logic are duplicated across three buttons. Consider extracting this into a reusable component or shared styles.

// Example shared component:
type NoteButtonProps = {
  mode: NoteAmendMode;
  currentMode: NoteAmendMode;
  label: string;
  onPress: () => void;
};

const NoteButton: React.FC<NoteButtonProps> = ({ mode, currentMode, label, onPress }) => (
  <Button
    style={{
      padding: '5px 10px',
      width: '33.33%',
      backgroundColor: theme.menuBackground,
      marginRight: 5,
      fontSize: 'inherit',
      ...(currentMode === mode
        ? {
            backgroundColor: theme.buttonPrimaryBackground,
            color: theme.buttonPrimaryText,
            ':hover': {
              backgroundColor: theme.buttonPrimaryBackgroundHover,
              color: theme.buttonPrimaryTextHover,
            },
          }
        : {
            backgroundColor: theme.buttonNormalBackground,
            color: theme.buttonNormalText,
            ':hover': {
              backgroundColor: theme.buttonNormalBackgroundHover,
              color: theme.buttonNormalTextHover,
            },
          }),
    }}
    onPress={onPress}
  >
    {label}
  </Button>
);

Also applies to: 171-171, 202-202

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9e80204 and a10fe1d.

📒 Files selected for processing (1)
  • packages/desktop-client/src/components/modals/EditFieldModal.tsx (6 hunks)
🧰 Additional context used
🪛 GitHub Check: lint
packages/desktop-client/src/components/modals/EditFieldModal.tsx

[warning] 1-1:
Imports "React" are only used as type


[warning] 46-46:
Replace ⏎····value:·string,⏎····mode?:·NoteAmendMode,⏎·· with value:·string,·mode?:·NoteAmendMode


[warning] 68-68:
Using default React import is discouraged, please use named exports directly instead


[warning] 75-75:
Replace ⏎····'replace',⏎·· with 'replace'

🔇 Additional comments (4)
packages/desktop-client/src/components/modals/EditFieldModal.tsx (4)

26-36: LGTM! Well-structured type definitions

The type definitions for NoteAmendMode and EditFieldModalProps are well-structured and provide good type safety.


38-44: LGTM! Clean TypeScript implementation

The component props destructuring and hook initialization are well-typed and properly implemented.


46-64: LGTM! Type-safe event handlers

The event handlers are well-typed and properly handle different input types.

🧰 Tools
🪛 GitHub Check: lint

[warning] 46-46:
Replace ⏎····value:·string,⏎····mode?:·NoteAmendMode,⏎·· with value:·string,·mode?:·NoteAmendMode


Line range hint 67-277: LGTM! Well-structured modal implementation

The modal implementation is well-organized with proper TypeScript types and responsive handling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants