Add FocusTrapCallout Component #7488
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "changes": [ | ||
| { | ||
| "packageName": "office-ui-fabric-react", | ||
| "comment": "Add FocusTrapCallout component", | ||
| "type": "minor" | ||
| } | ||
| ], | ||
| "packageName": "office-ui-fabric-react", | ||
| "email": "anihan@microsoft.com" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import * as React from 'react'; | ||
|
|
||
| import { Callout } from './Callout'; | ||
| import { IFocusTrapCalloutProps } from './FocusTrapCallout.types'; | ||
| import { FocusTrapZone } from '../../FocusTrapZone'; | ||
|
|
||
| /** | ||
| * A special Callout that uses FocusTrapZone to trap focus | ||
| * @param props - Props for the component | ||
| */ | ||
| export const FocusTrapCallout: React.StatelessComponent<IFocusTrapCalloutProps> = (props: IFocusTrapCalloutProps): JSX.Element => { | ||
| return ( | ||
| <Callout {...props}> | ||
| <FocusTrapZone {...props.focusTrapProps}>{props.children}</FocusTrapZone> | ||
| </Callout> | ||
| ); | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import { ICalloutProps } from './Callout.types'; | ||
| import { IFocusTrapZoneProps } from '../../FocusTrapZone'; | ||
|
|
||
| export interface IFocusTrapCalloutProps extends ICalloutProps { | ||
| /** | ||
| * Optional props to be passed on to FocusTrapZone | ||
| */ | ||
| focusTrapProps?: IFocusTrapZoneProps; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| import * as React from 'react'; | ||
| import { DefaultButton } from 'office-ui-fabric-react/lib/Button'; | ||
| import { FocusTrapCallout } from 'office-ui-fabric-react/lib/Callout'; | ||
| import { CommandBar, ICommandBarItemProps } from 'office-ui-fabric-react/lib/CommandBar'; | ||
| import './CalloutExample.scss'; | ||
|
|
||
| export interface ICalloutFocusTrapExampleProps { | ||
| items: ICommandBarItemProps[]; | ||
| } | ||
|
|
||
| export class CalloutFocusTrapExample extends React.Component< | ||
| ICalloutFocusTrapExampleProps, | ||
| { | ||
| isCalloutVisible: boolean; | ||
| } | ||
| > { | ||
| private _menuButtonElement: HTMLElement | null; | ||
|
|
||
| public constructor(props: ICalloutFocusTrapExampleProps) { | ||
| super(props); | ||
|
|
||
| this._onDismiss = this._onDismiss.bind(this); | ||
|
|
||
| this.state = { | ||
| isCalloutVisible: false | ||
| }; | ||
| } | ||
|
|
||
| public render(): JSX.Element { | ||
| const { isCalloutVisible } = this.state; | ||
|
|
||
| return ( | ||
| <div className="ms-CalloutExample"> | ||
| <div className="ms-CalloutBasicExample-buttonArea" ref={menuButton => (this._menuButtonElement = menuButton)}> | ||
| <DefaultButton onClick={this._onDismiss} text={isCalloutVisible ? 'Hide callout' : 'Show callout'} /> | ||
| </div> | ||
| {isCalloutVisible ? ( | ||
| <div> | ||
| <FocusTrapCallout | ||
| role={'alertdialog'} | ||
| ariaLabelledBy={'callout-label-2'} | ||
| className="ms-CalloutExample-callout" | ||
| gapSpace={0} | ||
| target={this._menuButtonElement} | ||
| onDismiss={this._onDismiss} | ||
| setInitialFocus={true} | ||
| > | ||
| <div className="ms-CalloutExample-header"> | ||
| <p className="ms-CalloutExample-title" id={'callout-label-2'}> | ||
| Callout title here | ||
| </p> | ||
| </div> | ||
| <div className="ms-CalloutExample-inner"> | ||
| <div className="ms-CalloutExample-content"> | ||
| <p className="ms-CalloutExample-subText"> | ||
| Message body is optional. If help documentation is available, consider adding a link to learn more at the bottom. | ||
| </p> | ||
| </div> | ||
| </div> | ||
| <CommandBar items={this.props.items} /> | ||
| </FocusTrapCallout> | ||
| </div> | ||
| ) : null} | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| private _onDismiss(ev: any): void { | ||
| this.setState({ | ||
| isCalloutVisible: !this.state.isCalloutVisible | ||
| }); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| export * from './Callout'; | ||
| export * from './Callout.types'; | ||
| export * from './FocusTrapCallout'; | ||
|
cliffkoh marked this conversation as resolved.
|
||
| export * from './FocusTrapCallout.types'; | ||
| export * from '../../common/DirectionalHint'; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`Component Examples renders Callout.FocusTrap.Example.tsx correctly 1`] = ` | ||
| <div | ||
| className="ms-CalloutExample" | ||
| > | ||
| <div | ||
| className="ms-CalloutBasicExample-buttonArea" | ||
| > | ||
| <button | ||
| className= | ||
| ms-Button | ||
| ms-Button--default | ||
| { | ||
| -moz-osx-font-smoothing: grayscale; | ||
| -webkit-font-smoothing: antialiased; | ||
| background-color: #f4f4f4; | ||
| border-radius: 0px; | ||
| border: 1px solid transparent; | ||
| box-sizing: border-box; | ||
| color: #333333; | ||
| cursor: pointer; | ||
| display: inline-block; | ||
| font-family: 'Segoe UI', 'Segoe UI Web (West European)', 'Segoe UI', -apple-system, BlinkMacSystemFont, 'Roboto', 'Helvetica Neue', sans-serif; | ||
| font-size: 14px; | ||
| font-weight: 400; | ||
| height: 32px; | ||
| min-width: 80px; | ||
| outline: transparent; | ||
| padding-bottom: 0; | ||
| padding-left: 16px; | ||
| padding-right: 16px; | ||
| padding-top: 0; | ||
| position: relative; | ||
| text-align: center; | ||
| text-decoration: none; | ||
| user-select: none; | ||
| vertical-align: top; | ||
| } | ||
| &::-moz-focus-inner { | ||
| border: 0; | ||
| } | ||
| .ms-Fabric--isFocusVisible &:focus:after { | ||
| border: 1px solid #ffffff; | ||
| bottom: 0px; | ||
| content: ""; | ||
| left: 0px; | ||
| outline: 1px solid #666666; | ||
| position: absolute; | ||
| right: 0px; | ||
| top: 0px; | ||
| z-index: 1; | ||
| } | ||
| @media screen and (-ms-high-contrast: active){.ms-Fabric--isFocusVisible &:focus:after { | ||
| border: none; | ||
| bottom: -2px; | ||
| left: -2px; | ||
| outline-color: ButtonText; | ||
| right: -2px; | ||
| top: -2px; | ||
| } | ||
| &:active > * { | ||
| left: 0px; | ||
| position: relative; | ||
| top: 0px; | ||
| } | ||
| &:hover { | ||
| background-color: #eaeaea; | ||
| color: #212121; | ||
| } | ||
| @media screen and (-ms-high-contrast: active){&:hover { | ||
| border-color: Highlight; | ||
| color: Highlight; | ||
| } | ||
| &:active { | ||
| background-color: #c8c8c8; | ||
| color: #212121; | ||
| } | ||
| data-is-focusable={true} | ||
| onClick={[Function]} | ||
| onKeyDown={[Function]} | ||
| onKeyPress={[Function]} | ||
| onKeyUp={[Function]} | ||
| onMouseDown={[Function]} | ||
| onMouseUp={[Function]} | ||
| type="button" | ||
| > | ||
| <div | ||
| className= | ||
| ms-Button-flexContainer | ||
| { | ||
| align-items: center; | ||
| display: flex; | ||
| flex-wrap: nowrap; | ||
| height: 100%; | ||
| justify-content: center; | ||
| } | ||
| > | ||
| <div | ||
| className= | ||
| ms-Button-textContainer | ||
| { | ||
| flex-grow: 1; | ||
| } | ||
| > | ||
| <div | ||
| className= | ||
| ms-Button-label | ||
| { | ||
| font-weight: 600; | ||
| line-height: 100%; | ||
| margin-bottom: 0; | ||
| margin-left: 4px; | ||
| margin-right: 4px; | ||
| margin-top: 0; | ||
| } | ||
| id="id__0" | ||
| > | ||
| Show callout | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </button> | ||
| </div> | ||
| </div> | ||
| `; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.