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

feat(SFINT-3300): Improve ToggleActionButton option names #78

Merged
merged 3 commits into from
Jul 7, 2020

Conversation

lbergeron
Copy link
Collaborator

Some of the ToggleActionButton options were confusing because their value was kind of the inverse of the option name. For example, the activatedTooltip option could have a value like Deactivate feature xyz.

These options were renamed like this:

activatedTooltip   --> deactivateTooltip
activatedIcon      --> deactivateIcon
deactivatedTooltip --> activateTooltip
deactivatedIcon    --> activateIcon

This way the option values would read like this:

activateTooltip: 'Activate feature xyz'
deactivateTooltip: 'Deactivate feature xyz'

Copy link
Collaborator

@louis-bompart louis-bompart left a comment

Choose a reason for hiding this comment

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

LGTM, but I think we can do without the legacy support

* ```
*/
activatedTooltip: ComponentOptions.buildStringOption(),
activateTooltip: ComponentOptions.buildStringOption({ alias: 'deactivatedTooltip' }),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we really want to bother with the alias?
I'd be fine with breaking, JSUI-extension is still sub 0 so, sem-ver wise, everyone that uses it should know that it's at their own risks.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

:D I almost sent the PR without the backward compatibility support. But, I wasn't happy about consciously introducing a breaking change that could easily be handled.

@lbergeron lbergeron merged commit 9a11f1d into coveo:master Jul 7, 2020
@lbergeron lbergeron deleted the feature/SFINT-3300 branch July 7, 2020 12:16
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