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

Feature/tcoz dev updated #1051

Merged
merged 15 commits into from
Feb 16, 2024
Merged

Feature/tcoz dev updated #1051

merged 15 commits into from
Feb 16, 2024

Conversation

burnettk
Copy link
Contributor

@burnettk burnettk commented Feb 15, 2024

Uses MUI tooltip, as it behaves more predictably with existing styling, and enables top-level theme config.

Top-level configuration for all MUI components can be controlled via overriding the existing theme. See index.tsx. This could be done per user for customization, etc.

Enabling JSON module imports in tsconfig.json seemed to fix the error in ReactDiagramEditor

this is basically the same as #1039, but with the documentation updates removed, since they have already been incorporated in main and subsequently updated and moved around a bit. This version also adds a SpiffTooltip component so we can switch between carbon quickly and deduplicate the arrow prop.

Summary by CodeRabbit

  • New Features
    • Introduced a new SpiffTooltip component for enhanced tooltip functionality.
    • Enhanced navigation and task interface with tooltips for an improved user experience.
    • Implemented theme customization capabilities with createTheme and ThemeProvider.
  • Refactor
    • Code cleanup in ReactDiagramEditor by removing unnecessary import.
  • Documentation
    • Updated interface documentation to include tooltip configurations.
  • Chores
    • Updated TypeScript configuration to support JSON module resolution.

tcoz and others added 12 commits February 9, 2024 09:18
Some notes for people that might want to run full-on native, with detail about how Mac hijacks port 7000 and how to get around it.
This reverts commit 096887c.
Some details for user that might be running Python3, Mac, and want to run everything locally/natively.
Uses MUI tooltip, as it behaves more predictably with existing styling, and enables top-level theme config.

Top-level configuration for all MUI components can be controlled via overriding the existing theme. See index.tsx. This could be done per user for customization, etc.

Enabling JSON module imports in tsconfig.json seemed to fix the error in ReactDiagramEditor
Copy link
Contributor

coderabbitai bot commented Feb 15, 2024

Warning

Rate Limit Exceeded

@burnettk has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 8 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 39d6adf and cdcb4f3.

Walkthrough

The updates involve enhancing user experience through tooltip integration across various components, a new tooltip component using Material-UI, and code cleanup including removal of unused imports. Additionally, updates include interface enhancements to support tooltips, theme setup adjustments with Material-UI's createTheme, and TypeScript configuration to enable JSON module resolution.

Changes

Files Change Summary
.../NavigationBar.tsx, .../ProcessInstanceListTabs.tsx, .../TaskRouteTabs.tsx Tooltip enhancements: Added SpiffTooltip import and wrapped components for tooltips. Updated titles, URLs, and descriptions.
.../ReactDiagramEditor.tsx Code cleanup: Removed spiffModdleExtension import.
.../SpiffTabs.tsx Tooltip integration: Added SpiffTooltip import and wrapped Tab component for tooltips.
.../SpiffTooltip.tsx New component: Introduced SpiffTooltip for tooltip functionality using Material-UI.
.../extension_ui_schema_interfaces.ts, .../interfaces.ts Interface update: Added tooltip field to interfaces.
.../index.tsx Theme setup: Added theme-related imports and wrapped <App /> with ThemeProvider for theme adjustments.
.../tsconfig.json TypeScript configuration update: Added "resolveJsonModule" for JSON module resolution.

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 4

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between c465efc and 39d6adf.
Files selected for processing (10)
  • spiffworkflow-frontend/src/components/NavigationBar.tsx (4 hunks)
  • spiffworkflow-frontend/src/components/ProcessInstanceListTabs.tsx (2 hunks)
  • spiffworkflow-frontend/src/components/ReactDiagramEditor.tsx (1 hunks)
  • spiffworkflow-frontend/src/components/SpiffTabs.tsx (2 hunks)
  • spiffworkflow-frontend/src/components/SpiffTooltip.tsx (1 hunks)
  • spiffworkflow-frontend/src/components/TaskRouteTabs.tsx (1 hunks)
  • spiffworkflow-frontend/src/extension_ui_schema_interfaces.ts (1 hunks)
  • spiffworkflow-frontend/src/index.tsx (1 hunks)
  • spiffworkflow-frontend/src/interfaces.ts (1 hunks)
  • spiffworkflow-frontend/tsconfig.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • spiffworkflow-frontend/src/components/ReactDiagramEditor.tsx
Additional comments: 11
spiffworkflow-frontend/src/components/TaskRouteTabs.tsx (1)
  • 12-26: Ensure that the tooltip property values are accurate and provide meaningful information to the user.
spiffworkflow-frontend/src/components/SpiffTabs.tsx (2)
  • 5-5: The import of SpiffTooltip is correctly added to support tooltip functionality for tabs.
  • 28-32: The implementation of SpiffTooltip wrapping the Tab component is correct, ensuring tooltips are displayed as intended.
spiffworkflow-frontend/src/index.tsx (3)
  • 3-3: The import of createTheme and ThemeProvider from @mui/material/styles is correctly added for theme customization.
  • 18-39: The creation of defaultTheme and overrideTheme using createTheme is correctly implemented, allowing for theme customization, especially for tooltips.
  • 44-48: Wrapping the <App /> component with nested ThemeProvider components to apply the defaultTheme and overrideTheme is correctly implemented.
spiffworkflow-frontend/src/components/ProcessInstanceListTabs.tsx (2)
  • 8-8: The import of SpiffTooltip is correctly added to support tooltip functionality for tabs.
  • 32-63: The implementation of SpiffTooltip wrapping the Tab components is correct, ensuring tooltips are displayed as intended for each tab.
spiffworkflow-frontend/src/extension_ui_schema_interfaces.ts (1)
  • 66-66: The addition of the tooltip field to the UiSchemaUxElement interface is correctly implemented, allowing for tooltip customization in the UI schema.
spiffworkflow-frontend/src/interfaces.ts (1)
  • 495-495: The addition of the tooltip field to the SpiffTab interface is correctly implemented, allowing for tooltip customization on tabs.
spiffworkflow-frontend/src/components/NavigationBar.tsx (1)
  • 225-233: The tooltip title is dynamically set based on the uxElement?.tooltip. Ensure that uxElement.tooltip is always defined to avoid displaying empty tooltips.

Verify that all uxElement objects passed to extensionHeaderMenuItemElement have a non-empty tooltip property.

@burnettk burnettk merged commit 7c8d9e2 into main Feb 16, 2024
22 checks passed
@burnettk burnettk deleted the feature/tcoz-dev-updated branch February 16, 2024 15:02
@burnettk burnettk mentioned this pull request Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants