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

Added defaultOpened prop on tooltip #6466

Merged
merged 2 commits into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions packages/@mantine/core/src/components/Tooltip/Tooltip.story.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -205,3 +205,21 @@ export function Inline() {
</div>
);
}

export function DefaultOpened() {
return (
<div style={{ padding: 40 }}>
<Tooltip
position="right"
label="Tooltip visible by default"
withArrow
transitionProps={{ duration: 0 }}
color="cyan"
radius="md"
defaultOpened
>
<button type="button">target</button>
</Tooltip>
</div>
);
}
10 changes: 10 additions & 0 deletions packages/@mantine/core/src/components/Tooltip/Tooltip.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,14 @@ describe('@mantine/core/Tooltip', () => {
expect(Tooltip.Floating).toBe(TooltipFloating);
expect(Tooltip.Group).toBe(TooltipGroup);
});

it('shows tooltip by default', () => {
render(
<Tooltip label="test-tooltip" defaultOpened transitionProps={{ duration: 0 }}>
<button type="button">target</button>
</Tooltip>
);

expect(screen.getByText('test-tooltip')).toBeInTheDocument();
});
});
6 changes: 6 additions & 0 deletions packages/@mantine/core/src/components/Tooltip/Tooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ export interface TooltipProps extends TooltipBaseProps {
/** Controlled opened state */
opened?: boolean;

/** Uncontrolled tooltip initial opened state */
defaultOpened?: boolean;

/** Space between target element and tooltip in px, `5` by default */
offset?: number | FloatingAxesOffsets;

Expand Down Expand Up @@ -96,6 +99,7 @@ const defaultProps: Partial<TooltipProps> = {
refProp: 'ref',
withinPortal: true,
inline: false,
defaultOpened: false,
arrowSize: 4,
arrowOffset: 5,
arrowRadius: 0,
Expand Down Expand Up @@ -126,6 +130,7 @@ export const Tooltip = factory<TooltipFactory>((_props, ref) => {
closeDelay,
onPositionChange,
opened,
defaultOpened,
withinPortal,
radius,
color,
Expand Down Expand Up @@ -167,6 +172,7 @@ export const Tooltip = factory<TooltipFactory>((_props, ref) => {
openDelay,
onPositionChange,
opened,
defaultOpened,
events,
arrowRef,
arrowOffset,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import classes from '../Tooltip.module.css';
export interface TooltipFloatingProps extends TooltipBaseProps {
/** Offset from mouse in px, `10` by default */
offset?: number;
/** Uncontrolled tooltip initial opened state */
defaultOpened?: boolean;
}

export type TooltipFloatingFactory = Factory<{
Expand All @@ -35,6 +37,7 @@ const defaultProps: Partial<TooltipFloatingProps> = {
refProp: 'ref',
withinPortal: true,
offset: 10,
defaultOpened: false,
position: 'right',
zIndex: getDefaultZIndex('popover'),
};
Expand Down Expand Up @@ -66,6 +69,7 @@ export const TooltipFloating = factory<TooltipFloatingFactory>((_props, ref) =>
multiline,
zIndex,
disabled,
defaultOpened,
variant,
vars,
portalProps,
Expand All @@ -90,6 +94,7 @@ export const TooltipFloating = factory<TooltipFloatingFactory>((_props, ref) =>
const { handleMouseMove, x, y, opened, boundaryRef, floating, setOpened } = useFloatingTooltip({
offset: offset!,
position: position!,
defaultOpened: defaultOpened!,
});

if (!isElement(children)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ import { FloatingPosition } from '../../Floating';
interface UseFloatingTooltip {
offset: number;
position: FloatingPosition;
defaultOpened?: boolean;
}

export function useFloatingTooltip<T extends HTMLElement = any>({
offset,
position,
defaultOpened,
}: UseFloatingTooltip) {
const [opened, setOpened] = useState(false);
const [opened, setOpened] = useState(defaultOpened);
const boundaryRef = useRef<T>();
const { x, y, elements, refs, update, placement } = useFloating({
placement: position,
Expand Down
3 changes: 2 additions & 1 deletion packages/@mantine/core/src/components/Tooltip/use-tooltip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ interface UseTooltip {
openDelay?: number;
onPositionChange?: (position: FloatingPosition) => void;
opened?: boolean;
defaultOpened?: boolean;
offset: number | FloatingAxesOffsets;
arrowRef?: React.RefObject<HTMLDivElement>;
arrowOffset?: number;
Expand All @@ -39,7 +40,7 @@ interface UseTooltip {
}

export function useTooltip(settings: UseTooltip) {
const [uncontrolledOpened, setUncontrolledOpened] = useState(false);
const [uncontrolledOpened, setUncontrolledOpened] = useState(settings.defaultOpened);
const controlled = typeof settings.opened === 'boolean';
const opened = controlled ? settings.opened : uncontrolledOpened;
const withinGroup = useTooltipGroupContext();
Expand Down
Loading