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

Fabric component: revert class change and make it backwards compatible #4671

Merged
merged 3 commits into from
Apr 25, 2018
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "@uifabric/utilities",
"comment": "Adding `isDirectionalKeyCode` helper.",
"type": "minor"
}
],
"packageName": "@uifabric/utilities",
"email": "dzearing@microsoft.com"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"changes": [
{
"packageName": "office-ui-fabric-react",
"comment": "Fabric: the isFocusVisible class is no added to the Fabric component again, to preserve backwards compatibility. Also fixing index file to export the types.",
"type": "minor"
}
],
"packageName": "office-ui-fabric-react",
"email": "dzearing@microsoft.com"
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ export const getStyles = (props: IFabricStyleProps): IFabricStyles => {
const {
theme,
className,
isFocusVisible
} = props;

return {
root: [
'ms-Fabric',
isFocusVisible && 'is-focusVisible',
theme.fonts.medium,
{
color: theme.palette.neutralPrimary,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import * as renderer from 'react-test-renderer';
import { Fabric } from './Fabric';

describe('Fabric', () => {
it('renders correctly', () => {
const component = renderer.create(
<Fabric>test</Fabric>
);
const tree = component.toJSON();
expect(tree).toMatchSnapshot();
});

});
Original file line number Diff line number Diff line change
@@ -1,27 +1,63 @@
import * as React from 'react';
import {
BaseComponent,
createRef,
customizable,
getNativeProps,
divProperties,
classNamesFunction
classNamesFunction,
getWindow,
isDirectionalKeyCode
} from '../../Utilities';
import { getStyles } from './Fabric.styles';
import { IFabricProps, IFabricStyleProps, IFabricStyles } from './Fabric.types';

const getClassNames = classNamesFunction<IFabricStyleProps, IFabricStyles>();

@customizable('Fabric', ['theme'])
export class Fabric extends BaseComponent<IFabricProps, {}> {
export class Fabric extends BaseComponent<IFabricProps, {
isFocusVisible: boolean;
}> {
private _rootElement = createRef<HTMLDivElement>();

constructor(props: IFabricProps) {
super(props);
this.state = { isFocusVisible: false };
}

public render() {
const classNames = getClassNames(getStyles, this.props as IFabricStyleProps);
const classNames = getClassNames(getStyles,
{
...this.props as IFabricStyleProps,
...this.state
});
const divProps = getNativeProps(this.props, divProperties);

return (
<div
{ ...divProps }
className={ classNames.root }
ref={ this._rootElement }
/>
);
}

public componentDidMount(): void {
const win = getWindow(this._rootElement.value);

if (win) {
this._events.on(win, 'mousedown', this._onMouseDown, true);
this._events.on(win, 'keydown', this._onKeyDown, true);
}
}

private _onMouseDown = (ev: MouseEvent): void => {
this.setState({ isFocusVisible: false });
}

private _onKeyDown = (ev: KeyboardEvent): void => {
if (isDirectionalKeyCode(ev.which)) {
this.setState({ isFocusVisible: true });
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface IFabricProps extends React.HTMLAttributes<HTMLDivElement> {

export interface IFabricStyleProps extends IFabricProps {
theme: ITheme;
isFocusVisible: boolean;
}

export interface IFabricStyles {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`Fabric renders correctly 1`] = `
<div
className=
ms-Fabric
{
-moz-osx-font-smoothing: grayscale;
-webkit-font-smoothing: antialiased;
color: #333333;
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;
}
& button {
font-family: inherit;
}
& input {
font-family: inherit;
}
& textarea {
font-family: inherit;
}
button {
overflow: visible;
}
>
test
</div>
`;
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from './Fabric';
export * from './Fabric.types';
3 changes: 2 additions & 1 deletion packages/utilities/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export * from './hoist';
export * from './hoistStatics';
export * from './initializeFocusRects';
export * from './initials';
export * from './keyboard';
export * from './language';
export * from './math';
export * from './memoize';
Expand All @@ -42,4 +43,4 @@ export * from './rtl';
export * from './scroll';
export * from './string';
export * from './styled';
export * from './warn';
export * from './warn';
19 changes: 3 additions & 16 deletions packages/utilities/src/initializeFocusRects.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,7 @@
import { getWindow } from './dom';
import { KeyCodes } from './KeyCodes';
import { KeyboardEvent } from '../../../common/temp/node_modules/@types/react';
import { isDirectionalKeyCode } from './keyboard';

export const IsFocusVisibleClassName = 'ms-Fabric--isFocusVisible';
const DirectionalKeyCodes = [
KeyCodes.up,
KeyCodes.down,
KeyCodes.left,
KeyCodes.right,
KeyCodes.home,
KeyCodes.end,
KeyCodes.tab,
KeyCodes.pageUp,
KeyCodes.pageDown
];

/**
* Initializes the logic which:
Expand Down Expand Up @@ -51,14 +39,13 @@ function _onMouseDown(ev: MouseEvent): void {
}
}

function _onKeyDown(ev: KeyboardEvent<Element>): void {
function _onKeyDown(ev: KeyboardEvent): void {
const win = getWindow(ev.target as Element);

if (win) {
const { classList } = win.document.body;
const isDirectionalKeyCode = DirectionalKeyCodes.indexOf(ev.which) > -1;

if (isDirectionalKeyCode && !classList.contains(IsFocusVisibleClassName)) {
if (isDirectionalKeyCode(ev.which) && !classList.contains(IsFocusVisibleClassName)) {
classList.add(IsFocusVisibleClassName);
}
}
Expand Down
9 changes: 9 additions & 0 deletions packages/utilities/src/keyboard.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { isDirectionalKeyCode } from './keyboard';
import { KeyCodes } from './KeyCodes';

describe('isDirectionalKeyCode', () => {
it('can return the expected value', () => {
isDirectionalKeyCode(KeyCodes.up);
isDirectionalKeyCode(KeyCodes.enter);
});
});
20 changes: 20 additions & 0 deletions packages/utilities/src/keyboard.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { KeyCodes } from './KeyCodes';

const DirectionalKeyCodes: { [key: number]: number } = {
[KeyCodes.up]: 1,
[KeyCodes.down]: 1,
[KeyCodes.left]: 1,
[KeyCodes.right]: 1,
[KeyCodes.home]: 1,
[KeyCodes.end]: 1,
[KeyCodes.tab]: 1,
[KeyCodes.pageUp]: 1,
[KeyCodes.pageDown]: 1
};

/**
* Returns true if the keycode is a directional keyboard key.
*/
export function isDirectionalKeyCode(which: number): boolean {
return !!DirectionalKeyCodes[which];
}