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

fix(Tag): Mark tag as interactive when onClick is set #7073

Merged
merged 5 commits into from
Nov 15, 2024

Conversation

jscheiny
Copy link
Contributor

Ensures that when onClick is passed, the interactive prop is set so we get the best possible accessibility story.

@changelog-app
Copy link

changelog-app bot commented Nov 15, 2024

Generate changelog in packages/core/changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
    and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the
    operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
    performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

fix(Tag): Mark tag as interactive when onClick is set

Check the box to generate changelog(s)

  • Generate changelog entry

@@ -99,8 +99,9 @@ export const Tag: React.FC<TagProps> = React.forwardRef((props, ref) => {
} = props;

const isRemovable = Utils.isFunction(onRemove);
const isInterative = interactive || htmlProps.onClick != null;
Copy link
Contributor

Choose a reason for hiding this comment

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

It might be useful to allow someone to still explicitly set interactive: false even when they provide an onClick handler, in case that's behavior they're already relying on for some reason.

To do that, should we change this to interactive ?? htmlProps.onClick != null and remove the default = false on line 89 above?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah good call

Copy link
Contributor

Choose a reason for hiding this comment

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

should this interactive ?? htmlProps.onClick != null defaulting behavior happen in useInteractiveAttributes? right now I think every consumer of this hook would need to do something similar

and maybe it should be a disabled option instead? if a component is using this hook I think we should infer it's interactive based on being provided an onClick, then disabled can be offered as a feature so a consumer doesn't have to do something like conditionally provide onClick

it seems like we ended up with interactive as an option to this hook since the Tag originally had it, but now we're walking back on interactive needing to be set to get the interactive attributes

@jscheiny jscheiny marked this pull request as ready for review November 15, 2024 19:50
@svc-palantir-github
Copy link

Fixes

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

ericjeney
ericjeney previously approved these changes Nov 15, 2024
Copy link
Contributor

@ericjeney ericjeney left a comment

Choose a reason for hiding this comment

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

Can you update the comment about the default value in the docs as well? Otherwise LGTM.

@@ -57,6 +57,20 @@ describe("<Tag>", () => {
assert.isTrue(handleRemove.calledOnce);
});

it("should be interactive when onClick is provided", () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for adding tests!

@policy-bot policy-bot bot dismissed ericjeney’s stale review November 15, 2024 20:30

Invalidated by push of fe6ea5a

@svc-palantir-github
Copy link

update docs

Build artifact links for this commit: documentation | landing | table | demo

This is an automated comment from the deploy-preview CircleCI job.

@jscheiny jscheiny merged commit 1e6aef2 into develop Nov 15, 2024
11 of 14 checks passed
@jscheiny jscheiny deleted the js/tag-onclick-interactive branch November 15, 2024 21:06
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.

4 participants