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.

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

fix: Button's tooltipText needs to show on hover #1817

Merged
merged 5 commits into from
Jul 7, 2023
Merged

fix: Button's tooltipText needs to show on hover #1817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90e90f5
fix: not showing Button's tooltipText when the prop is passed
KevinGhadyani-Okta Jun 2, 2023
79a6332
fix: minor ordering of properties in Tooltip stories
KevinGhadyani-Okta Jun 5, 2023
8339db1
Merge remote-tracking branch 'origin/develop' into kg/OKTA-612378
KevinGhadyani-Okta Jun 23, 2023
c2af151
Merge branch 'develop' into kg/OKTA-612378
KevinGhadyani-Okta Jul 7, 2023
b788ead
fix: some Tooltip position stories use Tag, not Button
KevinGhadyani-Okta Jul 7, 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
14 changes: 7 additions & 7 deletions packages/odyssey-react-mui/src/Button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

import { Button as MuiButton } from "@mui/material";
import type { ButtonProps as MuiButtonProps } from "@mui/material";
import { memo, ReactElement, useContext, useMemo } from "react";
import { memo, ReactElement, useCallback, useContext } from "react";

import { Icon } from "./Icon";
import { MuiPropsContext } from "./MuiPropsContext";
Expand Down Expand Up @@ -62,8 +62,8 @@ const Button = ({
}: ButtonProps) => {
const muiProps = useContext(MuiPropsContext);

const button = useMemo(
() => (
const renderButton = useCallback(
(muiProps) => (
<MuiButton
{...muiProps}
aria-label={ariaLabel}
Expand All @@ -86,7 +86,6 @@ const Button = ({
id,
isDisabled,
isFullWidth,
muiProps,
onClick,
size,
startIcon,
Expand All @@ -101,11 +100,12 @@ const Button = ({
return (
<>
{tooltipText && (
<Tooltip ariaType="description" text={tooltipText}>
{button}
<Tooltip ariaType="description" placement="top" text={tooltipText}>
<MuiPropsContext.Consumer>{renderButton}</MuiPropsContext.Consumer>
</Tooltip>
)}
{!tooltipText && button}

{!tooltipText && renderButton(muiProps)}
</>
);
};
Expand Down
37 changes: 22 additions & 15 deletions packages/odyssey-react-mui/src/Tag.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,41 @@
* See the License for the specific language governing permissions and limitations under the License.
*/

import { Chip, ChipProps } from "@mui/material";
import { memo, ReactElement, useContext } from "react";
import { Chip as MuiChip, ChipProps as MuiChipProps } from "@mui/material";
import { memo, ReactElement, useCallback, useContext } from "react";
import { TagListContext } from "./TagListContext";
import { Icon } from "./Icon";
import { MuiPropsContext } from "./MuiPropsContext";

export type TagProps = {
icon?: ReactElement<typeof Icon>;
isDisabled?: boolean;
label: string;
onClick?: ChipProps["onClick"];
onRemove?: ChipProps["onDelete"];
onClick?: MuiChipProps["onClick"];
onRemove?: MuiChipProps["onDelete"];
};

const Tag = ({ icon, isDisabled, label, onClick, onRemove }: TagProps) => {
const { chipElementType } = useContext(TagListContext);

return (
<Chip
clickable={onClick ? true : false}
component={chipElementType}
disabled={isDisabled}
aria-disabled={isDisabled}
icon={icon}
label={label}
onClick={onClick}
onDelete={onRemove}
/>
const renderTag = useCallback(
(muiProps) => (
<MuiChip
{...muiProps}
aria-disabled={isDisabled}
clickable={onClick ? true : false}
component={chipElementType}
disabled={isDisabled}
icon={icon}
label={label}
onClick={onClick}
onDelete={onRemove}
/>
),
[chipElementType, icon, isDisabled, label, onClick, onRemove]
);

return <MuiPropsContext.Consumer>{renderTag}</MuiPropsContext.Consumer>;
};

const MemoizedTag = memo(Tag);
Expand Down
16 changes: 10 additions & 6 deletions packages/odyssey-storybook/src/components/odyssey-mui/Tooltip/Tooltip.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import { Meta, StoryObj } from "@storybook/react";
import {
Button,
DownloadIcon,
Tag,
Tooltip,
TooltipProps,
} from "@okta/odyssey-react-mui";
Expand Down Expand Up @@ -145,16 +146,19 @@ export const Placement: StoryObj<TooltipProps> = {
return (
<>
<Tooltip text="Top" placement="top" ariaType="label">
<Button variant="primary" text="Top" />
<Tag label="Bow" />
</Tooltip>
<Tooltip text="Right" placement="right" ariaType="label">
<Button variant="primary" text="Right" />

<Tooltip text="Left" placement="left" ariaType="label">
<Tag label="Stern" />
</Tooltip>

<Tooltip text="Bottom" placement="bottom" ariaType="label">
<Button variant="primary" text="Bottom" />
<Tag label="Port" />
</Tooltip>
<Tooltip text="Left" placement="left" ariaType="label">
<Button variant="primary" text="Left" />

<Tooltip text="Right" placement="right" ariaType="label">
<Tag label="Starboard" />
</Tooltip>
</>
);
Expand Down