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

css grid based GridView #4394

Merged
merged 1 commit into from
May 24, 2024
Merged

css grid based GridView #4394

merged 1 commit into from
May 24, 2024

Conversation

imanjra
Copy link
Contributor

@imanjra imanjra commented May 13, 2024

What changes are proposed in this pull request?

  • Add types
  • Use CSS grid for GridView instead of flexbox

How is this patch tested? If it is not, please explain why.

Improve layout flexibility and ease of use with GridView

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • Refactor

    • Improved grid layout handling in the GridView component for better orientation support.
    • Switched from using Grid to Box for layout components, enhancing flexibility and consistency.
  • New Features

    • Introduced new utility functions for improved component property management and error handling.
  • Documentation

    • Added comprehensive TypeScript type definitions for schema-related functionalities to improve code clarity and maintenance.

Copy link
Contributor

coderabbitai bot commented May 13, 2024

Walkthrough

The recent changes to the SchemaIO plugin primarily focus on refactoring and enhancing the grid layout functionality. Key updates include transitioning from Grid to Box for layout components, improving type annotations, and introducing new utility functions and type definitions. These modifications aim to streamline the codebase, enhance type safety, and improve layout flexibility based on orientation.

Changes

Files Change Summary
app/packages/core/src/plugins/SchemaIO/components/GridView.tsx Refactored imports, updated type annotations, modified layout direction logic, and switched from Grid to Box for layout.
app/packages/core/src/plugins/SchemaIO/utils/index.ts Added type annotations, updated function signatures, introduced new utility functions, and reorganized imports.
app/packages/core/src/plugins/SchemaIO/utils/layout.ts Adjusted function parameters to be optional and improved handling of undefined values in destructuring assignments.
app/packages/core/src/plugins/SchemaIO/utils/types.ts Introduced TypeScript type definitions for schema-related functionality.

In the land of code, where schemas grow,
A rabbit hops with a joyful glow. 🐇
From Grid to Box, a change so neat,
Type safety and layout, a coder's treat.
With types defined and functions clear,
The future of SchemaIO is here! 🌟


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

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

@imanjra imanjra marked this pull request as ready for review May 23, 2024 15:29
@imanjra imanjra requested a review from ritch May 23, 2024 15:30
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

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1d634f5 and 95f70d5.
Files selected for processing (4)
  • app/packages/core/src/plugins/SchemaIO/components/GridView.tsx (2 hunks)
  • app/packages/core/src/plugins/SchemaIO/utils/index.ts (2 hunks)
  • app/packages/core/src/plugins/SchemaIO/utils/layout.ts (2 hunks)
  • app/packages/core/src/plugins/SchemaIO/utils/types.ts (1 hunks)
Files not reviewed due to errors (3)
  • app/packages/core/src/plugins/SchemaIO/utils/layout.ts (no review received)
  • app/packages/core/src/plugins/SchemaIO/utils/index.ts (no review received)
  • app/packages/core/src/plugins/SchemaIO/components/GridView.tsx (no review received)
Additional Context Used
Path-based Instructions (4)
app/packages/core/src/plugins/SchemaIO/utils/types.ts (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

app/packages/core/src/plugins/SchemaIO/utils/layout.ts (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

app/packages/core/src/plugins/SchemaIO/utils/index.ts (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

app/packages/core/src/plugins/SchemaIO/components/GridView.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

Additional comments not posted (6)
app/packages/core/src/plugins/SchemaIO/utils/types.ts (6)

1-4: The BaseSchemaType is well-defined and adheres to TypeScript best practices.


6-8: The ArraySchemaType correctly extends BaseSchemaType to include an items property, suitable for schema descriptions.


10-12: The ObjectSchemaType is effectively designed to allow nested schema definitions through its properties attribute.


14-14: SchemaType is correctly defined as a union of base, array, and object schema types, facilitating polymorphic behavior.


16-29: ViewPropsType is thoroughly defined, covering all necessary aspects for view handling with appropriate use of optional and conditional types.


31-33: CustomComponentsType is appropriately defined for indexing React components by name.

Copy link
Contributor

@ritch ritch left a comment

Choose a reason for hiding this comment

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

return types.Property(panel, view=types.GridView(height=100, align_x="center", align_y="center"))

Works like a charm!

@imanjra imanjra merged commit ce7caa1 into py-panels-develop May 24, 2024
6 checks passed
@imanjra imanjra deleted the grid-layout-x1 branch May 24, 2024 00:38
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

2 participants