Skip to content

SpinButton: Add getClassNames prop to allow complete customization of the component #3753

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
jspurlin merged 2 commits into from
Feb 13, 2018
Merged

SpinButton: Add getClassNames prop to allow complete customization of the component #3753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dd2d8b
SpinButton: Add getClassNames prop to allow complete customization of…
kysedate Jan 20, 2018
2289c22
rush change
kysedate Jan 20, 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/master_2018-01-20-01-21.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": "SpinButton: Add getClassNAmes prop to allow complete customization of the component",
Copy link
Member

@dzearing dzearing Jan 20, 2018

Choose a reason for hiding this comment

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

rather nervous of this change. A better approach would be to avoid the getClassNames approach and use the 6.0 getStyles functional approach. We found that getClassNames required us to come up with every possible permutation of areas and states, whereas a function of state can produce a given set of area classes.

See the ghdocs/styling.md file for more description.

Copy link
Member

@christiango christiango Jan 20, 2018

Choose a reason for hiding this comment

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

@dzearing this is another case where we need something that lets us completely override the styling in the 5.0 timeframe for Office Online.

Copy link
Member

@christiango christiango Jan 20, 2018

Choose a reason for hiding this comment

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

Should we just move it to getStyles in the 5.0 branch?

"type": "patch"
}
],
"packageName": "office-ui-fabric-react",
"email": "[email protected]"
}
21 changes: 14 additions & 7 deletions packages/office-ui-fabric-react/src/components/SpinButton/SpinButton.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,13 +141,20 @@ export class SpinButton extends BaseComponent<ISpinButtonProps, ISpinButtonState
keyboardSpinDirection
} = this.state;

const classNames = getClassNames(
getStyles(theme!, customStyles),
!!disabled,
!!isFocused,
keyboardSpinDirection,
labelPosition
);
const classNames = this.props.getClassNames ?
this.props.getClassNames(
theme!,
!!disabled,
!!isFocused,
keyboardSpinDirection,
labelPosition
) : getClassNames(
getStyles(theme!, customStyles),
!!disabled,
!!isFocused,
keyboardSpinDirection,
labelPosition
);

return (
<div className={ classNames.root }>
Expand Down
14 changes: 14 additions & 0 deletions packages/office-ui-fabric-react/src/components/SpinButton/SpinButton.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import * as React from 'react';
import { Position } from '../../utilities/positioning';
import { IIconProps } from '../../Icon';
import { ITheme, IStyle } from '../../Styling';
import { ISpinButtonClassNames } from './SpinButton.classNames';
import { KeyboardSpinDirection } from './SpinButton';
import { IButtonStyles } from '../../Button';

export interface ISpinButton {
Expand Down Expand Up @@ -133,6 +135,18 @@ export interface ISpinButtonProps {
*/
styles?: Partial<ISpinButtonStyles>;

/**
* Custom function for providing the classNames for the spinbutton. Can be used to provide
* all styles for the component instead of applying them on top of the default styles.
*/
getClassNames?: (
theme: ITheme,
disabled: boolean,
isFocused: boolean,
keyboardSpinDirection: KeyboardSpinDirection,
labelPosition?: Position
) => ISpinButtonClassNames;

/**
* Custom styles for the upArrow button.
*
Expand Down