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

breaking(Progress): control progress solely with progress #1355

Merged
merged 4 commits into from
Feb 23, 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
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ import { Progress, Segment } from 'semantic-ui-react'

const ProgressExampleInverted = () => (
<Segment inverted>
<Progress percent={21} inverted label>
<Progress percent={21} inverted progress>
Uploading Files
</Progress>
<Progress percent={100} inverted label success>
<Progress percent={100} inverted progress success>
success
</Progress>
<Progress percent={100} inverted label warning>
<Progress percent={100} inverted progress warning>
warning
</Progress>
<Progress percent={100} inverted label error>
<Progress percent={100} inverted progress error>
error
</Progress>
</Segment>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ import { Progress, Segment } from 'semantic-ui-react'

const ProgressExampleInvertedColor = () => (
<Segment inverted>
<Progress percent={32} inverted color='red' label />
<Progress percent={59} inverted color='orange' label />
<Progress percent={13} inverted color='yellow' label />
<Progress percent={37} inverted color='olive' label />
<Progress percent={83} inverted color='green' label />
<Progress percent={23} inverted color='teal' label />
<Progress percent={85} inverted color='blue' label />
<Progress percent={38} inverted color='violet' label />
<Progress percent={47} inverted color='purple' label />
<Progress percent={29} inverted color='pink' label />
<Progress percent={68} inverted color='brown' label />
<Progress percent={36} inverted color='grey' label />
<Progress percent={72} inverted color='black' label />
<Progress percent={32} inverted color='red' progress />
<Progress percent={59} inverted color='orange' progress />
<Progress percent={13} inverted color='yellow' progress />
<Progress percent={37} inverted color='olive' progress />
<Progress percent={83} inverted color='green' progress />
<Progress percent={23} inverted color='teal' progress />
<Progress percent={85} inverted color='blue' progress />
<Progress percent={38} inverted color='violet' progress />
<Progress percent={47} inverted color='purple' progress />
<Progress percent={29} inverted color='pink' progress />
<Progress percent={68} inverted color='brown' progress />
<Progress percent={36} inverted color='grey' progress />
<Progress percent={72} inverted color='black' progress />
</Segment>
)

Expand Down
54 changes: 28 additions & 26 deletions src/modules/Progress/Progress.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import _ from 'lodash'
import React, { Component, PropTypes } from 'react'

import {
createShorthand,
customPropTypes,
getElementType,
getUnhandledProps,
Expand Down Expand Up @@ -51,16 +52,7 @@ class Progress extends Component {
inverted: PropTypes.bool,

/** Can be set to either to display progress as percent or ratio. */
label: customPropTypes.every([
customPropTypes.some([
customPropTypes.demand(['percent']),
customPropTypes.demand(['total', 'value']),
]),
PropTypes.oneOfType([
PropTypes.bool,
PropTypes.oneOf(['ratio', 'percent']),
]),
]),
label: customPropTypes.itemShorthand,

/** Current percent complete. */
percent: customPropTypes.every([
Expand All @@ -75,7 +67,10 @@ class Progress extends Component {
precision: PropTypes.number,

/** A progress bar can contain a text value indicating current progress. */
progress: PropTypes.bool,
progress: PropTypes.oneOfType([
PropTypes.bool,
PropTypes.oneOf(['percent', 'ratio']),
]),

/** A progress bar can vary in size. */
size: PropTypes.oneOf(_.without(SUI.SIZES, 'mini', 'huge', 'massive')),
Expand Down Expand Up @@ -139,29 +134,41 @@ class Progress extends Component {
return autoSuccess && (percent >= 100 || value >= total)
}

showProgress = () => {
const { label, precision, progress, total, value } = this.props
renderLabel = () => {
const { children, label } = this.props

if (label || progress || !_.isUndefined(precision)) return true
return !(_.every([total, value], _.isUndefined))
if (!_.isNil(children)) return <div className='label'>{children}</div>
return createShorthand('div', val => ({ children: val }), label, { className: 'label' })
}

renderProgress = percent => {
const {
precision,
progress,
total,
value,
} = this.props

if (!progress && _.isUndefined(precision)) return
return (
<div className='progress'>
{ progress !== 'ratio' ? `${percent}%` : `${value}/${total}` }
</div>
)
}

render() {
const {
active,
attached,
children,
className,
color,
disabled,
error,
indicating,
inverted,
label,
size,
success,
total,
value,
warning,
} = this.props

Expand All @@ -182,19 +189,14 @@ class Progress extends Component {
)
const rest = getUnhandledProps(Progress, this.props)
const ElementType = getElementType(Progress, this.props)

const percent = this.getPercent()

return (
<ElementType {...rest} className={classes}>
<div className='bar' style={{ width: `${percent}%` }}>
{this.showProgress() && (
<div className='progress'>
{ label !== 'ratio' ? `${percent}%` : `${value}/${total}` }
</div>
)}
{this.renderProgress(percent)}
</div>
{children && <div className='label'>{children}</div>}
{this.renderLabel()}
</ElementType>
)
}
Expand Down
4 changes: 2 additions & 2 deletions src/modules/Progress/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ interface ProgressProps {
inverted?: string;

/** Can be set to either to display progress as percent or ratio. */
label?: boolean | 'ratio' | 'percent';
label?: any;

/** Current percent complete. */
percent?: number | string;
Expand All @@ -47,7 +47,7 @@ interface ProgressProps {
precision?: number;

/** A progress bar can contain a text value indicating current progress. */
progress?: boolean;
progress?: boolean | 'percent' | 'ratio';

/** A progress bar can vary in size. */
size?: 'tiny' | 'small' | 'medium' | 'large' | 'big';
Expand Down
38 changes: 22 additions & 16 deletions test/specs/modules/Progress/Progress-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,22 +96,11 @@ describe('Progress', () => {
})

describe('label', () => {
it('displays the progress as a percentage by default', () => {
shallow(<Progress percent={20} label />)
.should.have.descendants('.progress')
.and.contain.text('20%')
})
it('displays the progress as a ratio when set to "ratio"', () => {
shallow(<Progress label='ratio' value={1} total={2} />)
it('shows the label text when provided', () => {
shallow(<Progress label='some-label' />)
.children()
.find('.progress')
.should.contain.text('1/2')
})
it('displays the progress as a percentage when set to "percent"', () => {
shallow(<Progress label='percent' value={1} total={2} />)
.children()
.find('.progress')
.should.contain.text('50%')
.find('.label')
.should.contain.text('some-label')
})
})

Expand All @@ -131,6 +120,23 @@ describe('Progress', () => {
.find('.bar')
.should.not.have.descendants('.progress')
})
it('displays the progress as a percentage by default', () => {
shallow(<Progress percent={20} progress />)
.should.have.descendants('.progress')
.and.contain.text('20%')
})
it('displays the progress as a ratio when set to "ratio"', () => {
shallow(<Progress progress='ratio' value={1} total={2} />)
.children()
.find('.progress')
.should.contain.text('1/2')
})
it('displays the progress as a percentage when set to "percent"', () => {
shallow(<Progress progress='percent' value={1} total={2} />)
.children()
.find('.progress')
.should.contain.text('50%')
})
it('shows the percent complete', () => {
shallow(<Progress percent={72} progress />)
.children()
Expand Down Expand Up @@ -191,7 +197,7 @@ describe('Progress', () => {

describe('total/value', () => {
it('calculates the percent complete', () => {
shallow(<Progress value={1} total={2} />)
shallow(<Progress value={1} total={2} progress />)
.children()
.find('.progress')
.should.contain.text('50%')
Expand Down