Skip to content

[ContextualMenu] Fixes useTargetWidth property #3943

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
martellaj merged 5 commits into from
Feb 16, 2018
Merged

[ContextualMenu] Fixes useTargetWidth property #3943

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
50528e0
Fixes useTargetWidth usage for ContextualMenu
martellaj Feb 11, 2018
1e6a98c
Adds change file
martellaj Feb 11, 2018
442c9c0
Gets targetWidth asynchronously
martellaj Feb 12, 2018
f3cdb18
Revert "Gets targetWidth asynchronously"
martellaj Feb 14, 2018
d667782
Accounts for border width
martellaj Feb 15, 2018
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
11 changes: 11 additions & 0 deletions common/changes/office-ui-fabric-react/joem-fix-callout-targetwidth_2018-02-11-00-32.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "office-ui-fabric-react",
"comment": "Fixes useTargetWidth prop for ContextualMenu",
"type": "patch"
}
],
"packageName": "office-ui-fabric-react",
"email": "joem@microsoft.com"
}
29 changes: 24 additions & 5 deletions packages/office-ui-fabric-react/src/components/ContextualMenu/ContextualMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export interface IContextualMenuState {
slideDirectionalClassName?: string;
subMenuId?: string;
submenuDirection?: DirectionalHint;
targetWidth?: number;
}

export function hasSubmenu(item: IContextualMenuItem) {
Expand Down Expand Up @@ -153,13 +154,15 @@ export class ContextualMenu extends BaseComponent<IContextualMenuProps, IContext
if (newProps.target !== this.props.target) {
let newTarget = newProps.target;
this._setTargetWindowAndElement(newTarget!);
this._setTargetWidthAsync();
}
}

// Invoked once, both on the client and server, immediately before the initial rendering occurs.
public componentWillMount() {
let target = this.props.target;
this._setTargetWindowAndElement(target!);
this._setTargetWidthAsync();
this._previousActiveElement = this._targetWindow ? this._targetWindow.document.activeElement as HTMLElement : null;
}

Expand Down Expand Up @@ -246,15 +249,14 @@ export class ContextualMenu extends BaseComponent<IContextualMenuProps, IContext
*/
let contextMenuStyle;
let targetAsHtmlElement = this._target as HTMLElement;
if ((useTargetWidth || useTargetAsMinWidth) && targetAsHtmlElement && targetAsHtmlElement.offsetWidth) {
let targetWidth = targetAsHtmlElement.offsetWidth;
if ((useTargetWidth || useTargetAsMinWidth) && targetAsHtmlElement) {
if (useTargetWidth) {
contextMenuStyle = {
width: targetWidth
width: this.state.targetWidth
};
} else if (useTargetAsMinWidth) {
contextMenuStyle = {
minWidth: targetWidth
minWidth: this.state.targetWidth
};
}
}
Expand All @@ -271,7 +273,7 @@ export class ContextualMenu extends BaseComponent<IContextualMenuProps, IContext
}
return (
<Callout
{...calloutProps}
{ ...calloutProps }
target={ useTargetPoint ? targetPoint : target }
isBeakVisible={ isBeakVisible }
beakWidth={ beakWidth }
Expand Down Expand Up @@ -330,6 +332,23 @@ export class ContextualMenu extends BaseComponent<IContextualMenuProps, IContext
}
}

private _setTargetWidthAsync() {

@martellaj martellaj Feb 12, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@joschect Here's the attempt at asynchronously getting the target's width. Let me know what you think.

const targetAsHtmlElement = this._target as HTMLElement;

// If component doesn't care about target's width, then this is a no-op.
if ((!this.props.useTargetWidth && !this.props.useTargetAsMinWidth) || !targetAsHtmlElement) {
return;
}

this._async.requestAnimationFrame(() => {
const targetBoundingRect = targetAsHtmlElement.getBoundingClientRect();

this.setState({
targetWidth: targetBoundingRect.width - 2 /* Need to account for border width */

@manishgarg1 manishgarg1 Feb 12, 2018

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

targetWidth [](start = 8, length = 11)

Since this async, how do we make sure this value is set when the render API is called?

@martellaj martellaj Feb 12, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It gets called in componentWillMount, so the value should be available in the render function. We'll have this issue either way since @joschect said even reading offsetWidth should be moved to an async function. Can someone more familiar with this pattern in OUFR help solve the problem? Do you have any suggestions, @manishgarg1?

@martellaj martellaj Feb 12, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Or if you have a better way to solve it, feel free to take it over. The issue has been open since November with no activity and we need a fix. Thanks!

@joschect joschect Feb 12, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's okay if the value is not set at first render, although it may cause apparent resizing. You would need to provide a default value though.

});
});
}

private _onRenderSubMenu(subMenuProps: IContextualMenuProps) {
return <ContextualMenu { ...subMenuProps } />;
}
Expand Down