Skip to content

Coachmark - useOffsetHeight should cause re-render on each set state to match v7 functionality #24702

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
micahgodbolt merged 4 commits into from
Sep 8, 2022
Merged

Coachmark - useOffsetHeight should cause re-render on each set state to match v7 functionality #24702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8152676
To match v7 functionality, useOffsetHeight should cause re-render on …
micahgodbolt Sep 7, 2022
5b43f20
change file
micahgodbolt Sep 8, 2022
2f9abd0
Merge branch 'master' into 23545-coachmarks
micahgodbolt Sep 8, 2022
d2d5f89
remove unnecessary changes
micahgodbolt Sep 8, 2022
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-4050c913-450b-4833-a0a1-f59e28d3777b.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "fix: Coachmarks now properly animate when used in any of the center positions",
"packageName": "@fluentui/react",
"email": "mgodbolt@microsoft.com",
"dependentChangeType": "patch"
}
8 changes: 5 additions & 3 deletions packages/react/src/components/Coachmark/PositioningContainer/PositioningContainer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,10 @@ export function useHeightOffset(
/**
* Tracks the current height offset and updates during
* the height animation when props.finalHeight is specified.
* State stored as object to ensure re-render even if the value does not change.
* See https://github.com/microsoft/fluentui/issues/23545
*/
const [heightOffset, setHeightOffset] = React.useState<number>(0);
const [heightOffset, setHeightOffset] = React.useState<{ value: number }>({ value: 0 });
const async = useAsync();
const setHeightOffsetTimer = React.useRef<number>(0);

Expand All @@ -278,7 +280,7 @@ export function useHeightOffset(
const cardCurrHeight: number = positioningContainerMainElem.offsetHeight;
const scrollDiff: number = cardScrollHeight - cardCurrHeight;

setHeightOffset(heightOffset + scrollDiff);
setHeightOffset({ value: heightOffset.value + scrollDiff });

if (positioningContainerMainElem.offsetHeight < finalHeight) {
setHeightOffsetEveryFrame();
Expand All @@ -292,7 +294,7 @@ export function useHeightOffset(
// eslint-disable-next-line react-hooks/exhaustive-deps -- should only re-run if finalHeight changes
React.useEffect(setHeightOffsetEveryFrame, [finalHeight]);

return heightOffset;
return heightOffset.value;
}

export const PositioningContainer: React.FunctionComponent<IPositioningContainerProps> = React.forwardRef<
Expand Down