voxel51 / fiftyone

The open-source tool for building high-quality datasets and computer vision models
https://fiftyone.ai
Apache License 2.0
8.66k stars 548 forks source link

fix ctx.panel.close and add ctx.panel.set_title #4488

Closed imanjra closed 3 months ago

imanjra commented 3 months ago

What changes are proposed in this pull request?

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

Using python panel operator:

class LayoutPanel(foo.Panel):
    @property
    def config(self):
        return foo.PanelOperatorConfig(
            name="python_panel_02_layout",
            label="PythonPanel0.2: Layout",
            allow_multiple=True,
            icon="auto_awesome_mosaic",
        )

    def on_load(self, ctx):
        pass

    def close(self, ctx):
        ctx.panel.close()

    def shuffle_title(self, ctx):
        random_number = str(random.randint(1, 100))
        ctx.panel.set_title(f"Title {random_number}")

    def render(self, ctx):
        panel = types.Object()
        panel.btn("close", label="Close", on_click=self.close)
        panel.btn("shuffle_title", label="Shuffle Title", on_click=self.shuffle_title)
        return types.Property(
            panel, view=types.GridView(width=100, height=100, orientation="vertical")
        )

Release Notes

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

Part of a larger feature

What areas of FiftyOne does this PR affect?

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes introduce a new SetPanelTitle operator to set panel titles dynamically, enhance existing methods by removing unnecessary parameters, and add flexibility to the setPanelTitle function by including an optional id parameter. These updates streamline the code and expand functionality for managing panel operations.

Changes

File Change Summary
app/packages/operators/src/built-in-operators.ts Added usePanelTitle import, modified execute and useHooks methods, added SetPanelTitle class, registered operator.
app/packages/spaces/src/hooks.ts Updated setPanelTitle function to accept an optional id parameter.
fiftyone/operators/operations.py Enhanced close_panel method with id parameter, added set_panel_title method.
fiftyone/operators/panel.py Modified close method to include id parameter, added set_title method.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Panel
    participant Operator
    participant Hooks

    User->>Operator: Call SetPanelTitle
    Operator->>Hooks: usePanelTitle(id)
    Hooks-->>Operator: Return title setter
    Operator->>Panel: Set title using setter
    Panel-->>User: Title updated

Poem

In fields of code where rabbits play,
A title set, a bright new day.
Panels gleam with names so fine,
Thanks to hooks and operators' design.
Flexibility now in our hand,
With every change, our app will stand.
🐇✨


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