xframes-project / xframes

GPU-accelerated GUI development for Node.js and the browser
https://xframes.dev
MIT License
7 stars 0 forks source link

Added basic image component #48

Closed andreamancuso closed 3 months ago

andreamancuso commented 3 months ago

image

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes enhance the Dear ImGui project by introducing an Image widget to facilitate image rendering in a React-Imgui context. This addition includes new source files, a React component, and updates to support elements in both CMake configurations and TypeScript definitions, significantly enriching the library's capabilities for creating dynamic interfaces. The modifications aim to improve image handling and expand the range of components available to developers.

Changes

Files Change Summary
.../CMakeLists.txt Added src/widget/image.cpp for Emscripten build, enhancing image handling.
.../include/widget/image.h Introduced Image class with properties and methods for rendering images and handling dimensions.
.../src/reactimgui.cpp, .../src/widget/image.cpp Updated ReactImgui to include Image widget and implemented rendering functionality for the new class.
.../ts/src/lib/components/ImGuiDemo/ImGuiDemo.tsx Added <ReactImgui.Image> component to improve demo representation.
.../ts/src/lib/components/ReactImgui/Image.tsx Implemented Image component using forwardRef, allowing rendering with props.
.../ts/src/lib/components/ReactImgui/components.tsx Exported Image component in the components object.
.../ts/src/lib/components/ReactImgui/types.ts Enhanced type definitions for WidgetPropsMap, adding properties for the Image widget.
.../ts/src/lib/react-native/ReactNativePrivateInterface.js Added url property to enhance configuration options in the exported object.
.../ts/src/lib/react-native/nativeFabricUiManager.ts Updated the class to manage the Image component, extending native capabilities.
.../ts/src/lib/widgetRegistrationService.ts Introduced reloadImage(id: string) method to allow reloading images based on their IDs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ReactImgui
    participant Image
    participant API

    User->>ReactImgui: Request to render Image
    ReactImgui->>Image: Create Image instance
    Image->>API: Fetch image based on URL
    API-->>Image: Return image data
    Image->>ReactImgui: Image data ready for rendering
    ReactImgui->>User: Display Image

Poem

🐇 In the realm of code, a new image blooms,
With colors bright, dispelling all glooms.
A widget so fine, to render and play,
In the world of ImGui, it brightens the day!
Hoppin' along, with pixels aglow,
A celebration of change, let's all give a show! 🎉


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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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.