This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 219
Create OrderSelect and Label components #905
Merged
Merged
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
aa1c300
Create Label and OrderSelect components
Aljullu e14f574
Update review list item so it uses 'classnames'
Aljullu a457fa1
Split review order select styles from generic component
Aljullu 0751dbf
Update snapshots
Aljullu d398806
Refactor Label so we don't need to check Symbol
Aljullu b7ed466
Add description to Label and OrderSelect components
Aljullu 850dc62
Use prop-types instead of prop-types-elementtype
Aljullu 1fcd28a
Simplify Label propTypes
Aljullu 672a99c
Update package-lock
Aljullu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import PropTypes from 'prop-types'; | ||
import elementType from 'prop-types-elementtype'; | ||
import { Fragment } from 'react'; | ||
import classNames from 'classnames'; | ||
|
||
const Label = ( { label, screenReaderLabel, wrapperElement: Wrapper, wrapperProps } ) => { | ||
if ( label && screenReaderLabel && label !== screenReaderLabel ) { | ||
return ( | ||
<Wrapper { ...wrapperProps }> | ||
<span aria-hidden> | ||
{ label } | ||
</span> | ||
<span className="screen-reader-text"> | ||
{ screenReaderLabel } | ||
</span> | ||
</Wrapper> | ||
); | ||
} | ||
|
||
if ( ! label && screenReaderLabel ) { | ||
if ( typeof Wrapper === 'symbol' && Symbol.keyFor( Wrapper ) === 'react.fragment' ) { | ||
Wrapper = 'span'; | ||
} | ||
wrapperProps = { | ||
...wrapperProps, | ||
className: classNames( wrapperProps.className, 'screen-reader-text' ), | ||
}; | ||
|
||
return ( | ||
<Wrapper { ...wrapperProps }> | ||
{ screenReaderLabel } | ||
</Wrapper> | ||
); | ||
} | ||
|
||
return ( | ||
<Wrapper { ...wrapperProps }> | ||
{ label } | ||
</Wrapper> | ||
); | ||
}; | ||
|
||
Label.propTypes = { | ||
label: PropTypes.string, | ||
screenReaderLabel: PropTypes.string, | ||
wrapperElement: PropTypes.oneOfType( [ | ||
PropTypes.string, | ||
elementType, | ||
] ), | ||
wrapperProps: PropTypes.object, | ||
}; | ||
|
||
Label.defaultProps = { | ||
wrapperElement: Fragment, | ||
wrapperProps: {}, | ||
}; | ||
|
||
export default Label; |
62 changes: 62 additions & 0 deletions
62
assets/js/base/components/label/test/__snapshots__/index.js.snap
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`Label with wrapperElement should render both label and screen reader label 1`] = ` | ||
<label | ||
className="foo-bar" | ||
data-foo="bar" | ||
> | ||
<span | ||
aria-hidden={true} | ||
> | ||
Lorem | ||
</span> | ||
<span | ||
className="screen-reader-text" | ||
> | ||
Ipsum | ||
</span> | ||
</label> | ||
`; | ||
|
||
exports[`Label with wrapperElement should render only the label 1`] = ` | ||
<label | ||
className="foo-bar" | ||
data-foo="bar" | ||
> | ||
Lorem | ||
</label> | ||
`; | ||
|
||
exports[`Label with wrapperElement should render only the scree reader label 1`] = ` | ||
<label | ||
className="foo-bar screen-reader-text" | ||
data-foo="bar" | ||
> | ||
Ipsum | ||
</label> | ||
`; | ||
|
||
exports[`Label without wrapperElement should render both label and screen reader label 1`] = ` | ||
Array [ | ||
<span | ||
aria-hidden={true} | ||
> | ||
Lorem | ||
</span>, | ||
<span | ||
className="screen-reader-text" | ||
> | ||
Ipsum | ||
</span>, | ||
] | ||
`; | ||
|
||
exports[`Label without wrapperElement should render only the label 1`] = `"Lorem"`; | ||
|
||
exports[`Label without wrapperElement should render only the scree reader label 1`] = ` | ||
<span | ||
className="screen-reader-text" | ||
> | ||
Ipsum | ||
</span> | ||
`; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import TestRenderer from 'react-test-renderer'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import Label from '../'; | ||
|
||
describe( 'Label', () => { | ||
describe( 'without wrapperElement', () => { | ||
test( 'should render both label and screen reader label', () => { | ||
const component = TestRenderer.create( | ||
<Label label="Lorem" screenReaderLabel="Ipsum" /> | ||
); | ||
|
||
expect( component.toJSON() ).toMatchSnapshot(); | ||
} ); | ||
|
||
test( 'should render only the label', () => { | ||
const component = TestRenderer.create( | ||
<Label label="Lorem" /> | ||
); | ||
|
||
expect( component.toJSON() ).toMatchSnapshot(); | ||
} ); | ||
|
||
test( 'should render only the screen reader label', () => { | ||
const component = TestRenderer.create( | ||
<Label screenReaderLabel="Ipsum" /> | ||
); | ||
|
||
expect( component.toJSON() ).toMatchSnapshot(); | ||
} ); | ||
} ); | ||
|
||
describe( 'with wrapperElement', () => { | ||
test( 'should render both label and screen reader label', () => { | ||
const component = TestRenderer.create( | ||
<Label | ||
label="Lorem" | ||
screenReaderLabel="Ipsum" | ||
wrapperElement="label" | ||
wrapperProps={ { | ||
className: 'foo-bar', | ||
'data-foo': 'bar', | ||
} } | ||
/> | ||
); | ||
|
||
expect( component.toJSON() ).toMatchSnapshot(); | ||
} ); | ||
|
||
test( 'should render only the label', () => { | ||
const component = TestRenderer.create( | ||
<Label | ||
label="Lorem" | ||
wrapperElement="label" | ||
wrapperProps={ { | ||
className: 'foo-bar', | ||
'data-foo': 'bar', | ||
} } | ||
/> | ||
); | ||
|
||
expect( component.toJSON() ).toMatchSnapshot(); | ||
} ); | ||
|
||
test( 'should render only the screen reader label', () => { | ||
const component = TestRenderer.create( | ||
<Label | ||
screenReaderLabel="Ipsum" | ||
wrapperElement="label" | ||
wrapperProps={ { | ||
className: 'foo-bar', | ||
'data-foo': 'bar', | ||
} } | ||
/> | ||
); | ||
|
||
expect( component.toJSON() ).toMatchSnapshot(); | ||
} ); | ||
} ); | ||
} ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/** | ||
* External dependencies | ||
*/ | ||
import PropTypes from 'prop-types'; | ||
import classNames from 'classnames'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import Label from '../label'; | ||
import './style.scss'; | ||
|
||
const OrderSelect = ( { className, componentId, defaultValue, label, onChange, options, screenReaderLabel, readOnly, value } ) => { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is OrderSelect? I think it would be helpful to include some doc block here explaining what the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in b7ed466. |
||
const selectId = `wc-block-order-select__select-${ componentId }`; | ||
|
||
return ( | ||
<p className={ classNames( 'wc-block-order-select', className ) }> | ||
<Label | ||
label={ label } | ||
screenReaderLabel={ screenReaderLabel } | ||
wrapperElement="label" | ||
wrapperProps={ { | ||
className: 'wc-block-order-select__label', | ||
htmlFor: selectId, | ||
} } | ||
/> | ||
<select // eslint-disable-line jsx-a11y/no-onchange | ||
id={ selectId } | ||
className="wc-block-order-select__select" | ||
defaultValue={ defaultValue } | ||
onChange={ onChange } | ||
readOnly={ readOnly } | ||
value={ value } | ||
> | ||
{ options.map( ( option ) => ( | ||
<option key={ option.key } value={ option.key }> | ||
{ option.label } | ||
</option> | ||
) ) } | ||
</select> | ||
</p> | ||
); | ||
}; | ||
|
||
OrderSelect.propTypes = { | ||
componentId: PropTypes.number.isRequired, | ||
defaultValue: PropTypes.string, | ||
label: PropTypes.string, | ||
onChange: PropTypes.func, | ||
options: PropTypes.arrayOf( PropTypes.shape( { | ||
key: PropTypes.string.isRequired, | ||
label: PropTypes.string.isRequired, | ||
} ) ), | ||
readOnly: PropTypes.bool, | ||
screenReaderLabel: PropTypes.string, | ||
value: PropTypes.string, | ||
}; | ||
|
||
export default OrderSelect; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
.wc-block-order-select { | ||
margin-bottom: $gap-small; | ||
} | ||
|
||
.wc-block-order-select__label { | ||
margin-right: $gap-small; | ||
display: inline-block; | ||
font-weight: normal; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure doing this typeof check for 'symbol' will work in IE11 even with polyfill (should be verified). Instead you could probably do something like:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Checking the type didn't seem to work, but I refactored the component so we don't need to check for
Symbol
anymore: d398806. Tested and it works fine on IE11. 👍