Skip to content

fix(tooltip): deprecate the label property due to the description coming from the component's content #7247

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jun 30, 2023
Merged

fix(tooltip): deprecate the label property due to the description coming from the component's content #7247

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
47cb417
fix(tooltip): deprecate the label property and make it optional. #6329
driskull Jun 29, 2023
a184693
review fixes
driskull Jun 30, 2023
073f398
wording
driskull Jun 30, 2023
cd146d5
wording
driskull Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions packages/calcite-components/src/components/tooltip/tooltip.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,15 @@ describe("calcite-tooltip", () => {
});

describe("accessible when closed", () => {
accessible(`<calcite-tooltip label="test" reference-element="ref"></calcite-tooltip><div id="ref">😄</div>`);
accessible(
`<calcite-tooltip reference-element="ref">Hello World!</calcite-tooltip><div id="ref">Tooltip Reference</div>`
);
});

describe("accessible when open", () => {
accessible(`<calcite-tooltip label="test" open reference-element="ref"></calcite-tooltip><div id="ref">😄</div>`);
accessible(
`<calcite-tooltip open reference-element="ref">Hello World!</calcite-tooltip><div id="ref">Tooltip Reference</div>`
);
});

describe("honors hidden attribute", () => {
Expand Down Expand Up @@ -853,7 +857,7 @@ describe("calcite-tooltip", () => {
{
name: "shadow-component-a",
html: `<button id="tooltip-button">Data disclaimer</button>
<calcite-tooltip label="Data disclaimer" reference-element="tooltip-button">
<calcite-tooltip reference-element="tooltip-button">
<span>This data was collected over a 24 hour period</span>
</calcite-tooltip>`
},
Expand Down
2 changes: 1 addition & 1 deletion packages/calcite-components/src/components/tooltip/tooltip.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ darkModeRTL_TestOnly.parameters = { modes: modesDarkDefault };

export const rightAligned_TestOnly = (): string => html`<div style="text-align: right">
<a href="#" id="tooltip-button">Hover for Tooltip</a>
<calcite-tooltip open label="Example label" reference-element="tooltip-button">
<calcite-tooltip open reference-element="tooltip-button">
<span>Tooltip content lorem ipsum</span>
</calcite-tooltip>
</div>`;
Expand Down
8 changes: 6 additions & 2 deletions packages/calcite-components/src/components/tooltip/tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,12 @@ export class Tooltip implements FloatingUIComponent, OpenCloseComponent {
/** Closes the component when the `referenceElement` is clicked. */
@Prop({ reflect: true }) closeOnClick = false;

/** Accessible name for the component. */
@Prop() label!: string;
/**
* Accessible name for the component.
*
* @deprecated No longer necessary.
Copy link
Member

Choose a reason for hiding this comment

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

Can we add some info on this no longer being needed because the label will come from the content/setting ARIA props on it not being recommended?

Copy link
Member

Choose a reason for hiding this comment

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

From the changelog perspective, could you also revisit the PR title to include something about this?

Copy link
Member

@jcfranco jcfranco Jun 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

WDYT about:

@deprecated The component's content provides the description, so this is no longer necessary.

?

Deferring to @geospatialem for some docspertise™.

Copy link
Member Author

Choose a reason for hiding this comment

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

How about..

@deprecated This is no longer necessary because the component's content provides the description.

I like "is" better than "should" and this ordering. Should sounds less confident :D

Copy link
Member

Choose a reason for hiding this comment

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

WDYT about some context as to what the label would provide if used? Something like:

@deprecated No longer necessary. Overrides the context of the component's description, which could confuse assistive technology users.

Copy link
Member Author

Choose a reason for hiding this comment

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

sounds good to me

*/
@Prop() label: string;

/**
* Offset the position of the component away from the `referenceElement`.
Expand Down
94 changes: 27 additions & 67 deletions packages/calcite-components/src/demos/tooltip.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,179 +190,139 @@ <h1 style="margin: 0 auto; text-align: center">Tooltip</h1>

<!-- containers to hold the tooltip -->
<div>
<calcite-tooltip label="tooltip - auto" placement="auto" reference-element="tooltip-auto-ref">
<calcite-tooltip placement="auto" reference-element="tooltip-auto-ref">
<p>placement: auto</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - auto-start" placement="auto-start" reference-element="tooltip-auto-start-ref">
<calcite-tooltip placement="auto-start" reference-element="tooltip-auto-start-ref">
<p>placement: auto-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - auto-end" placement="auto-end" reference-element="tooltip-auto-end-ref">
<calcite-tooltip placement="auto-end" reference-element="tooltip-auto-end-ref">
<p>placement: auto-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - top" placement="top" reference-element="tooltip-top-ref">
<calcite-tooltip placement="top" reference-element="tooltip-top-ref">
<p>placement: top</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - bottom" placement="bottom" reference-element="tooltip-bottom-ref">
<calcite-tooltip placement="bottom" reference-element="tooltip-bottom-ref">
<p>placement: bottom</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - right" placement="right" reference-element="tooltip-right-ref">
<calcite-tooltip placement="right" reference-element="tooltip-right-ref">
<p>placement: right</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - left" placement="left" reference-element="tooltip-left-ref">
<calcite-tooltip placement="left" reference-element="tooltip-left-ref">
<p>placement: left</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - top-start" placement="top-start" reference-element="tooltip-top-start-ref">
<calcite-tooltip placement="top-start" reference-element="tooltip-top-start-ref">
<p>placement: top-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - top-end" placement="top-end" reference-element="tooltip-top-end-ref">
<calcite-tooltip placement="top-end" reference-element="tooltip-top-end-ref">
<p>placement: top-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - bottom-start"
placement="bottom-start"
reference-element="tooltip-bottom-start-ref"
>
<calcite-tooltip placement="bottom-start" reference-element="tooltip-bottom-start-ref">
<p>placement: bottom-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - bottom-end" placement="bottom-end" reference-element="tooltip-bottom-end-ref">
<calcite-tooltip placement="bottom-end" reference-element="tooltip-bottom-end-ref">
<p>placement: bottom-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - right-start"
placement="right-start"
reference-element="tooltip-right-start-ref"
>
<calcite-tooltip placement="right-start" reference-element="tooltip-right-start-ref">
<p>placement: right-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - right-end" placement="right-end" reference-element="tooltip-right-end-ref">
<calcite-tooltip placement="right-end" reference-element="tooltip-right-end-ref">
<p>placement: right-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - left-start" placement="left-start" reference-element="tooltip-left-start-ref">
<calcite-tooltip placement="left-start" reference-element="tooltip-left-start-ref">
<p>placement: left-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - left-end" placement="left-end" reference-element="tooltip-left-end-ref">
<calcite-tooltip placement="left-end" reference-element="tooltip-left-end-ref">
<p>placement: left-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - leading-start"
placement="leading-start"
reference-element="tooltip-leading-start-ref"
>
<calcite-tooltip placement="leading-start" reference-element="tooltip-leading-start-ref">
<p>placement: leading-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - leading" placement="leading" reference-element="tooltip-leading-ref">
<calcite-tooltip placement="leading" reference-element="tooltip-leading-ref">
<p>placement: leading</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - leading-end"
placement="leading-end"
reference-element="tooltip-leading-end-ref"
>
<calcite-tooltip placement="leading-end" reference-element="tooltip-leading-end-ref">
<p>placement: leading-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - trailing-end"
placement="trailing-end"
reference-element="tooltip-trailing-end-ref"
>
<calcite-tooltip placement="trailing-end" reference-element="tooltip-trailing-end-ref">
<p>placement: trailing-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip label="tooltip - trailing" placement="trailing" reference-element="tooltip-trailing-ref">
<calcite-tooltip placement="trailing" reference-element="tooltip-trailing-ref">
<p>placement: trailing</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - trailing-start"
placement="trailing-start"
reference-element="tooltip-trailing-start-ref"
>
<calcite-tooltip placement="trailing-start" reference-element="tooltip-trailing-start-ref">
<p>placement: trailing-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>

<calcite-tooltip label="tooltip - auto" placement="auto" reference-element="tooltip-auto-disabled-ref">
<calcite-tooltip placement="auto" reference-element="tooltip-auto-disabled-ref">
<p>placement: auto</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - auto-start"
placement="auto-start"
reference-element="tooltip-auto-start-disabled-ref"
>
<calcite-tooltip placement="auto-start" reference-element="tooltip-auto-start-disabled-ref">
<p>placement: auto-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - auto-end"
placement="auto-end"
reference-element="tooltip-auto-end-disabled-ref"
>
<calcite-tooltip placement="auto-end" reference-element="tooltip-auto-end-disabled-ref">
<p>placement: auto-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>

<calcite-tooltip label="tooltip - auto" placement="auto" reference-element="tooltip-auto-disabled-native-ref">
<calcite-tooltip placement="auto" reference-element="tooltip-auto-disabled-native-ref">
<p>placement: auto</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - auto-start"
placement="auto-start"
reference-element="tooltip-auto-start-disabled-native-ref"
>
<calcite-tooltip placement="auto-start" reference-element="tooltip-auto-start-disabled-native-ref">
<p>placement: auto-start</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
</calcite-tooltip>
<calcite-tooltip
label="tooltip - auto-end"
placement="auto-end"
reference-element="tooltip-auto-end-disabled-native-ref"
>
<calcite-tooltip placement="auto-end" reference-element="tooltip-auto-end-disabled-native-ref">
<p>placement: auto-end</p>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua.
Expand Down