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

Allow stepper to be used as a controlled component #688

Merged
merged 2 commits into from
Jun 10, 2017
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
8 changes: 8 additions & 0 deletions source/ArrowKeyStepper/ArrowKeyStepper.example.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,11 @@
.Radio {
margin-left: 0.5rem;
}

.checkboxLabel {
display: flex;
align-items: center;
}
.checkbox {
margin-right: 5px;
}
40 changes: 38 additions & 2 deletions source/ArrowKeyStepper/ArrowKeyStepper.example.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,21 @@ export default class ArrowKeyStepperExample extends PureComponent {
super(props)

this.state = {
mode: 'edges'
mode: 'edges',
isClickable: true,
scrollToColumn: 0,
scrollToRow: 0
}

this._getColumnWidth = this._getColumnWidth.bind(this)
this._getRowHeight = this._getRowHeight.bind(this)
this._cellRenderer = this._cellRenderer.bind(this)
this._selectCell = this._selectCell.bind(this)
this._onClickableChange = this._onClickableChange.bind(this)
}

render () {
const { mode } = this.state
const { mode, isClickable, scrollToColumn, scrollToRow } = this.state

return (
<ContentBox>
Expand Down Expand Up @@ -66,10 +71,28 @@ export default class ArrowKeyStepperExample extends PureComponent {
</label>
</ContentBoxParagraph>

<ContentBoxParagraph>
<label className={styles.checkboxLabel}>
<input
aria-label='Enable click selection? (resets selection)'
className={styles.checkbox}
type='checkbox'
checked={isClickable}
onChange={this._onClickableChange}
/>
Enable click selection? (resets selection)
</label>
</ContentBoxParagraph>

<ArrowKeyStepper
columnCount={100}
key={isClickable}
isControlled={isClickable}
onScrollToChange={isClickable ? this._selectCell : undefined}
mode={mode}
rowCount={100}
scrollToColumn={scrollToColumn}
scrollToRow={scrollToRow}
>
{({ onSectionRendered, scrollToColumn, scrollToRow }) => (
<div>
Expand Down Expand Up @@ -118,10 +141,23 @@ export default class ArrowKeyStepperExample extends PureComponent {
<div
className={className}
key={key}
onClick={this.state.isClickable && (() => this._selectCell({ scrollToColumn: columnIndex, scrollToRow: rowIndex }))}
style={style}
>
{`r:${rowIndex}, c:${columnIndex}`}
</div>
)
}

_selectCell ({ scrollToColumn, scrollToRow }) {
this.setState({ scrollToColumn, scrollToRow })
}

_onClickableChange (event) {
this.setState({
isClickable: event.target.checked,
scrollToColumn: 0,
scrollToRow: 0
})
}
}
41 changes: 41 additions & 0 deletions source/ArrowKeyStepper/ArrowKeyStepper.jest.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,47 @@ describe('ArrowKeyStepper', () => {
assertCurrentScrollTo(node, 0, 0)
})

it('should call :onScrollToChange for key down', () => {
let numCalls = 0
let scrollToColumn
let scrollToRow
const onScrollToChange = params => {
scrollToColumn = params.scrollToColumn
scrollToRow = params.scrollToRow
numCalls++
}
const { node } = renderHelper({
isControlled: true,
onScrollToChange
})

Simulate.keyDown(node, {key: 'ArrowDown'})
expect(numCalls).toEqual(1)
expect(scrollToColumn).toEqual(0)
expect(scrollToRow).toEqual(1)
})

it('should not call :onScrollToChange for prop update', () => {
let numCalls = 0
const onScrollToChange = params => {
numCalls++
}
const { node } = renderHelper({
onScrollToChange,
scrollToColumn: 0,
scrollToRow: 0
})

renderHelper({
isControlled: true,
onScrollToChange,
node,
scrollToColumn: 0,
scrollToRow: 1
})
expect(numCalls).toEqual(0)
})

describe('mode === "edges"', () => {
it('should update :scrollToColumn and :scrollToRow relative to the most recent :onSectionRendered event', () => {
const { node, onSectionRendered } = renderHelper()
Expand Down
27 changes: 23 additions & 4 deletions source/ArrowKeyStepper/ArrowKeyStepper.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import React, { PureComponent } from 'react'
export default class ArrowKeyStepper extends PureComponent {
static defaultProps = {
disabled: false,
isControlled: false,
mode: 'edges',
scrollToColumn: 0,
scrollToRow: 0
Expand All @@ -18,7 +19,9 @@ export default class ArrowKeyStepper extends PureComponent {
className: PropTypes.string,
columnCount: PropTypes.number.isRequired,
disabled: PropTypes.bool.isRequired,
isControlled: PropTypes.bool.isRequired,
mode: PropTypes.oneOf(['cells', 'edges']),
onScrollToChange: PropTypes.func,
rowCount: PropTypes.number.isRequired,
scrollToColumn: PropTypes.number.isRequired,
scrollToRow: PropTypes.number.isRequired
Expand All @@ -42,6 +45,10 @@ export default class ArrowKeyStepper extends PureComponent {
}

componentWillReceiveProps (nextProps) {
if (this.props.isControlled) {
return
}

const { scrollToColumn, scrollToRow } = nextProps

const {
Expand Down Expand Up @@ -76,7 +83,7 @@ export default class ArrowKeyStepper extends PureComponent {

render () {
const { className, children } = this.props
const { scrollToColumn, scrollToRow } = this.state
const { scrollToColumn, scrollToRow } = this._getScrollState()

return (
<div
Expand All @@ -102,9 +109,9 @@ export default class ArrowKeyStepper extends PureComponent {
const {
scrollToColumn: scrollToColumnPrevious,
scrollToRow: scrollToRowPrevious
} = this.state
} = this._getScrollState()

let { scrollToColumn, scrollToRow } = this.state
let { scrollToColumn, scrollToRow } = this._getScrollState()

// The above cases all prevent default event event behavior.
// This is to keep the grid from scrolling after the snap-to update.
Expand Down Expand Up @@ -137,7 +144,7 @@ export default class ArrowKeyStepper extends PureComponent {
) {
event.preventDefault()

this.setState({ scrollToColumn, scrollToRow })
this._updateScrollState({ scrollToColumn, scrollToRow })
}
}

Expand All @@ -147,4 +154,16 @@ export default class ArrowKeyStepper extends PureComponent {
this._rowStartIndex = rowStartIndex
this._rowStopIndex = rowStopIndex
}

_getScrollState () {
return this.props.isControlled ? this.props : this.state
}

_updateScrollState ({ scrollToColumn, scrollToRow }) {
if (this.props.isControlled) {
this.props.onScrollToChange({ scrollToColumn, scrollToRow })
} else {
this.setState({ scrollToColumn, scrollToRow })
}
}
}
2 changes: 1 addition & 1 deletion source/AutoSizer/AutoSizer.example.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export default class AutoSizerExample extends PureComponent {
aria-label='Hide description (to show resize)?'
className={styles.checkbox}
type='checkbox'
value={hideDescription}
checked={hideDescription}
onChange={event => this.setState({ hideDescription: event.target.checked })}
/>
Hide description (to show resize)?
Expand Down