ynput / ynput/ayon-core

Enhancement: Allow OptionalPyblishPluginMixin to apply a tooltip to the checkbox

Open
#809 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
71
Forks
91
Avg merge
1d 23h
Merged PRs (30d)
47

Description

Is there an existing issue for this?
  • I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?

The OptionalPyblishPluginMixin makes it more trivial to implement optional checkboxes in the new publisher UI however, it'll always show the plug-in label as the checkbox label and generates no tooltip which can make it quite unclear what the checkbox does.

How would you imagine the implementation of the feature?

Implement the following methods on the mixin:

def get_optional_label(self):
    return self.label

def get_optional_tooltip(self):
    return None

These could then be overridden by child classes to e.g. provide a custom tooltip or label for the optional checkbox.

Are there any labels you wish to add?
  • I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:

The other approach would be to not use the OptionalPyblishPluginMixin and then generate the attribute definitions manually so you can set the labels and tooltips as wanted.

Additional context:

No response

[cuID:OP-6799]

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating OptionalPyblishPluginMixin and inspect how the new publisher UI reads its checkbox label and tooltip. Verify the mixin exposes the requested default behavior and that child classes can provide custom values for both fields.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.