Skip to content

Shimmer: change prop use of subcomponents Line, Circle and Gap. #5739

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
Vitalius1 merged 6 commits into from
Jul 31, 2018
Merged

Shimmer: change prop use of subcomponents Line, Circle and Gap. #5739

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4d1b8ad
Adds deprecation message and renames constant 'styles' to 'borderStyl…
Jul 31, 2018
7752fff
Change the use of 'borderStyle' prop on shimmer subcomponents in favo…
Jul 31, 2018
eae6b23
Change log.
Jul 31, 2018
0f11abf
Remove unnecessary style.
Jul 31, 2018
5cb227a
Rename a constant in styles of Shimmer subcomponents for improved sem…
Jul 31, 2018
6425453
Adds documentation to subcomponents interfaces.
Jul 31, 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/v-vibr-ShimmerPropDeprecation_2018-07-31-18-23.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": "Deprecating 'borderStyle' prop of Shimmer subcomponents Line, Circle, Gap in favor of leveraging mergeStyles API.",
"type": "patch"
}
],
"packageName": "office-ui-fabric-react",
"email": "v-vibr@microsoft.com"
}
6 changes: 3 additions & 3 deletions packages/office-ui-fabric-react/src/components/Shimmer/ShimmerCircle/ShimmerCircle.styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ export function getStyles(props: IShimmerCircleStyleProps): IShimmerCircleStyles
const { palette } = theme;
const classNames = getGlobalClassNames(GlobalClassNames, theme);

const styles: IRawStyle = !!borderStyle ? borderStyle : {};
const borderStyles: IRawStyle = !!borderStyle ? borderStyle : {};

return {
root: [
classNames.root,
styles,
{
width: `${height}px`,
height: `${height}px`,
Expand All @@ -31,7 +30,8 @@ export function getStyles(props: IShimmerCircleStyleProps): IShimmerCircleStyles
borderColor: 'Window'
}
}
}
},
borderStyles
],
svg: [
classNames.svg,
Expand Down
11 changes: 6 additions & 5 deletions packages/office-ui-fabric-react/src/components/Shimmer/ShimmerCircle/ShimmerCircle.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ export interface IShimmerCircleProps extends React.AllHTMLAttributes<HTMLElement
*/
height?: number;

/**
* Used to
*/
borderStyle?: IRawStyle;

/**
* Theme provided by High-Order Component.
*/
Expand All @@ -34,6 +29,12 @@ export interface IShimmerCircleProps extends React.AllHTMLAttributes<HTMLElement
* Call to provide customized styling that will layer on top of the variant rules.
*/
styles?: IStyleFunctionOrObject<IShimmerCircleStyleProps, IShimmerCircleStyles>;

/**
* Use to set custom styling of the shimmerCircle borders.
* @deprecated Use 'styles' prop to leverage mergeStyle API.
*/
borderStyle?: IRawStyle;
}

export interface IShimmerCircleStyleProps {
Expand Down
22 changes: 14 additions & 8 deletions ...ui-fabric-react/src/components/Shimmer/ShimmerElementsGroup/ShimmerElementsGroup.base.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ import {
import { IRawStyle } from '../../../Styling';
import { ShimmerElementType, ShimmerElementsDefaultHeights, IShimmerElement } from '../Shimmer.types';
import { ShimmerLine } from '../ShimmerLine/ShimmerLine';
import { IShimmerLineStyles } from '../ShimmerLine/ShimmerLine.types';
import { ShimmerGap } from '../ShimmerGap/ShimmerGap';
import { IShimmerGapStyles } from '../ShimmerGap/ShimmerGap.types';
import { ShimmerCircle } from '../ShimmerCircle/ShimmerCircle';
import { IShimmerCircleStyles } from '../ShimmerCircle/ShimmerCircle.types';

const getClassNames = classNamesFunction<IShimmerElementsGroupStyleProps, IShimmerElementsGroupStyles>();

Expand Down Expand Up @@ -49,24 +52,25 @@ export class ShimmerElementsGroupBase extends BaseComponent<IShimmerElementsGrou
const { type, ...filteredElem } = elem;
switch (elem.type) {
case ShimmerElementType.circle:
return (
<ShimmerCircle key={index} {...filteredElem} borderStyle={this._getBorderStyles(elem, rowHeight)} />
);
return <ShimmerCircle key={index} {...filteredElem} styles={this._getBorderStyles(elem, rowHeight)} />;
case ShimmerElementType.gap:
return <ShimmerGap key={index} {...filteredElem} borderStyle={this._getBorderStyles(elem, rowHeight)} />;
return <ShimmerGap key={index} {...filteredElem} styles={this._getBorderStyles(elem, rowHeight)} />;
case ShimmerElementType.line:
return <ShimmerLine key={index} {...filteredElem} borderStyle={this._getBorderStyles(elem, rowHeight)} />;
return <ShimmerLine key={index} {...filteredElem} styles={this._getBorderStyles(elem, rowHeight)} />;
}
}
)
) : (
<ShimmerLine height={ShimmerElementsDefaultHeights.line} />
<ShimmerLine height={ShimmerElementsDefaultHeights.line} styles={{ root: [{ borderWidth: '0px' }] }} />
);

return renderedElements;
};

private _getBorderStyles = (elem: IShimmerElement, rowHeight?: number): IRawStyle | undefined => {
private _getBorderStyles = (
elem: IShimmerElement,
rowHeight?: number
): IShimmerCircleStyles | IShimmerGapStyles | IShimmerLineStyles => {
const elemHeight: number | undefined = elem.height;
const dif: number = rowHeight && elemHeight ? rowHeight - elemHeight : 0;

Expand All @@ -89,7 +93,9 @@ export class ShimmerElementsGroupBase extends BaseComponent<IShimmerElementsGrou
};
}

return borderStyle;
return {
root: [{ ...borderStyle }]
};
};

/**
Expand Down
6 changes: 3 additions & 3 deletions packages/office-ui-fabric-react/src/components/Shimmer/ShimmerGap/ShimmerGap.styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@ export function getStyles(props: IShimmerGapStyleProps): IShimmerGapStyles {
const { palette } = theme;
const classNames = getGlobalClassNames(GlobalClassNames, theme);

@cliffkoh cliffkoh Jul 31, 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.

classNames [](start = 8, length = 10)

nit: rename these to globalClassNames so it is clearer e.g. in line 18


const styles: IRawStyle = !!borderStyle ? borderStyle : {};
const borderStyles: IRawStyle = !!borderStyle ? borderStyle : {};

return {
root: [
classNames.root,
styles,
{
backgroundColor: palette.white,
height: `${height}px`,
Expand All @@ -30,7 +29,8 @@ export function getStyles(props: IShimmerGapStyleProps): IShimmerGapStyles {
borderColor: 'Window'
}
}
}
},
borderStyles
]
};
}
11 changes: 6 additions & 5 deletions packages/office-ui-fabric-react/src/components/Shimmer/ShimmerGap/ShimmerGap.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@ export interface IShimmerGapProps extends React.AllHTMLAttributes<HTMLElement> {
*/
width?: number | string;

/**
* Sets custom styling of the gap.
*/
borderStyle?: IRawStyle;

/**
* Theme provided by High-Order Component.
*/
Expand All @@ -40,6 +35,12 @@ export interface IShimmerGapProps extends React.AllHTMLAttributes<HTMLElement> {
* Call to provide customized styling that will layer on top of the variant rules.
*/
styles?: IStyleFunctionOrObject<IShimmerGapStyleProps, IShimmerGapStyles>;

/**
* Use to set custom styling of the shimmerGap borders.
* @deprecated Use 'styles' prop to leverage mergeStyle API.
*/
borderStyle?: IRawStyle;
}

export interface IShimmerGapStyleProps {
Expand Down
6 changes: 3 additions & 3 deletions packages/office-ui-fabric-react/src/components/Shimmer/ShimmerLine/ShimmerLine.styles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export function getStyles(props: IShimmerLineStyleProps): IShimmerLineStyles {
const { palette } = theme;
const classNames = getGlobalClassNames(GlobalClassNames, theme);

const styles: IRawStyle = !!borderStyle ? borderStyle : { borderWidth: '0px' };
const borderStyles: IRawStyle = !!borderStyle ? borderStyle : {};

const sharedCornerStyles: IRawStyle = {
position: 'absolute',
Expand All @@ -25,7 +25,6 @@ export function getStyles(props: IShimmerLineStyleProps): IShimmerLineStyles {
return {
root: [
classNames.root,
styles,
{
height: `${height}px`,
boxSizing: 'content-box',
Expand All @@ -43,7 +42,8 @@ export function getStyles(props: IShimmerLineStyleProps): IShimmerLineStyles {
}
}
}
}
},
borderStyles
],
topLeftCorner: [
classNames.topLeftCorner,
Expand Down
11 changes: 6 additions & 5 deletions packages/office-ui-fabric-react/src/components/Shimmer/ShimmerLine/ShimmerLine.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@ export interface IShimmerLineProps extends React.AllHTMLAttributes<HTMLElement>
*/
width?: number | string;

/**
* Sets custom styling of the rectangle.
*/
borderStyle?: IRawStyle;

/**
* Theme provided by High-Order Component.
*/
Expand All @@ -40,6 +35,12 @@ export interface IShimmerLineProps extends React.AllHTMLAttributes<HTMLElement>
* Call to provide customized styling that will layer on top of the variant rules.
*/
styles?: IStyleFunctionOrObject<IShimmerLineStyleProps, IShimmerLineStyles>;

/**
* Use to set custom styling of the shimmerLine borders.
* @deprecated Use 'styles' prop to leverage mergeStyle API.
*/
borderStyle?: IRawStyle;
}

export interface IShimmerLineStyleProps {
Expand Down