new Toggle component #92
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,24 @@ | ||
| # Toggle | ||
| ### Usage | ||
|
|
||
| ```jsx | ||
| import { Toggle } from 'radiance-ui'; | ||
|
|
||
| <Toggle | ||
| checked={checked} | ||
| label="Toggle Label" | ||
| onChange={this.onChange} | ||
| /> | ||
| ``` | ||
|
|
||
| <!-- STORY --> | ||
|
|
||
| ### Proptypes | ||
| | prop | propType | required | default | description | ||
| |-----------------------|------------------|----------|-----------|------------------------------------------------------------------------------------------------------------------------------| | ||
| | checked | bool | yes | - | controls the toggle state | | ||
| | label | string | no | '' | the toggle label | | ||
| | onChange | function | yes | - | the toggle handler function, this usually toggle the checked prop value | | ||
|
|
||
| ### Notes | ||
| The `<Toggle>` component is usually wrapped in a `container` element (with a fixed `width` style for example). The toggle and label are spread in the container (`space-between`) from edge to edge. |
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
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,191 @@ | ||
| // Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
|
||
| exports[`<Toggle /> UI snapshot renders the component 1`] = ` | ||
| .emotion-2 { | ||
| position: relative; | ||
| display: -webkit-box; | ||
| display: -webkit-flex; | ||
| display: -ms-flexbox; | ||
| display: flex; | ||
| -webkit-flex-flow: row nowrap; | ||
| -ms-flex-flow: row nowrap; | ||
| flex-flow: row nowrap; | ||
| -webkit-box-pack: justify; | ||
| -webkit-justify-content: space-between; | ||
| -ms-flex-pack: justify; | ||
| justify-content: space-between; | ||
| -webkit-align-items: center; | ||
| -webkit-box-align: center; | ||
| -ms-flex-align: center; | ||
| align-items: center; | ||
| width: 100%; | ||
| padding: 1rem 0; | ||
| } | ||
|
|
||
| .emotion-2 > input { | ||
| display: none; | ||
| } | ||
|
|
||
| .emotion-0 { | ||
| color: #524D6E; | ||
| margin: 0; | ||
| font-size: 1rem; | ||
| line-height: 1.5rem; | ||
| text-align: left; | ||
| cursor: pointer; | ||
| -webkit-user-select: none; | ||
| -moz-user-select: none; | ||
| -ms-user-select: none; | ||
| user-select: none; | ||
| margin-right: 0.5rem; | ||
| } | ||
|
|
||
| <div | ||
| className="emotion-2 emotion-3" | ||
| > | ||
| <span | ||
| className="emotion-0 emotion-1" | ||
| > | ||
| Label Text | ||
| </span> | ||
| <div | ||
| onClick={[Function]} | ||
| onMouseOut={[Function]} | ||
| onMouseOver={[Function]} | ||
| style={ | ||
| Object { | ||
| "KhtmlUserSelect": "none", | ||
| "MozUserSelect": "none", | ||
| "WebkitTapHighlightColor": "transparent", | ||
| "WebkitTouchCallout": "none", | ||
| "WebkitUserSelect": "none", | ||
| "alignItems": "center", | ||
| "backgroundColor": "transparent", | ||
| "border": 0, | ||
| "cursor": "pointer", | ||
| "display": "flex", | ||
| "justifyContent": "flex-start", | ||
| "msUserSelect": "none", | ||
| "padding": 0, | ||
| "position": "relative", | ||
| "userSelect": "none", | ||
| "width": 52, | ||
| } | ||
| } | ||
| > | ||
| <div | ||
| style={ | ||
| Object { | ||
| "alignItems": "center", | ||
| "backgroundColor": "rgb(225,224,230)", | ||
| "borderRadius": 100, | ||
| "display": "flex", | ||
| "height": 24, | ||
| "justifyContent": "center", | ||
| "padding": 0, | ||
| "width": 40, | ||
| } | ||
| } | ||
| > | ||
| <div | ||
| style={ | ||
| Object { | ||
| "alignItems": "center", | ||
| "color": "#FAFAFA", | ||
| "display": "flex", | ||
| "fontFamily": "'Helvetica Neue', Helvetica, sans-serif", | ||
| "fontSize": 11, | ||
| "height": 20, | ||
| "justifyContent": "center", | ||
| "left": 4, | ||
| "lineHeight": 0, | ||
| "marginBottom": "auto", | ||
| "marginTop": "auto", | ||
| "opacity": 0, | ||
| "position": "relative", | ||
| "width": 26, | ||
| } | ||
| } | ||
| > | ||
|
|
||
| </div> | ||
| <div | ||
| style={ | ||
| Object { | ||
| "alignItems": "center", | ||
| "bottom": "0px", | ||
| "color": "rgba(255,255,255,0.6)", | ||
| "display": "flex", | ||
| "fontFamily": "'Helvetica Neue', Helvetica, sans-serif", | ||
| "fontSize": 11, | ||
| "height": 20, | ||
| "justifyContent": "center", | ||
| "lineHeight": 0, | ||
| "marginBottom": "auto", | ||
| "marginTop": "auto", | ||
| "opacity": 1, | ||
| "paddingRight": 5, | ||
| "position": "relative", | ||
| "width": 26, | ||
| } | ||
| } | ||
| > | ||
|
|
||
| </div> | ||
| </div> | ||
| <div | ||
| style={ | ||
| Object { | ||
| "alignItems": "center", | ||
| "alignSelf": "stretch", | ||
| "display": "flex", | ||
| "flex": 1, | ||
| "height": "100%", | ||
| "justifyContent": "flex-start", | ||
| "left": 0, | ||
| "position": "absolute", | ||
| "top": 0, | ||
| } | ||
| } | ||
| > | ||
| <div | ||
| style={ | ||
| Object { | ||
| "MozBoxSizing": "border-box", | ||
| "WebkitBoxSizing": "border-box", | ||
| "alignSelf": "center", | ||
| "background": "#ffffff", | ||
| "backgroundColor": "rgb(255,255,255)", | ||
| "border": "1px solid #ededf0", | ||
| "borderRadius": "50%", | ||
| "boxShadow": "none", | ||
| "boxSizing": "border-box", | ||
| "display": "flex", | ||
| "height": 22, | ||
| "left": 1, | ||
| "position": "relative", | ||
| "width": 22, | ||
| } | ||
| } | ||
| /> | ||
| </div> | ||
| <input | ||
| onClick={[Function]} | ||
| style={ | ||
| Object { | ||
| "border": 0, | ||
| "clip": "rect(0 0 0 0)", | ||
| "height": 1, | ||
| "margin": -1, | ||
| "overflow": "hidden", | ||
| "padding": 0, | ||
| "position": "absolute", | ||
| "width": 1, | ||
| } | ||
| } | ||
| type="checkbox" | ||
| value={false} | ||
| /> | ||
| </div> | ||
| </div> | ||
| `; |
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,51 @@ | ||
| import PropTypes from 'prop-types'; | ||
| import React from 'react'; | ||
| import ToggleButton from 'react-toggle-button'; | ||
|
|
||
| import { COLORS } from '../../constants'; | ||
| import { Container, Label, trackStyle, thumbStyle } from './style'; | ||
|
|
||
| const propTypes = { | ||
| checked: PropTypes.bool, | ||
| label: PropTypes.string, | ||
| onChange: PropTypes.func, | ||
| }; | ||
|
|
||
| const defaultProps = { | ||
| checked: false, | ||
| label: '', | ||
| }; | ||
|
|
||
| const Toggle = ({ checked, label, onChange }) => ( | ||
| <Container> | ||
| {label && <Label onClick={onChange}>{label}</Label>} | ||
| <ToggleButton | ||
| value={checked || false} | ||
| onToggle={onChange} | ||
| inactiveLabel="" | ||
| activeLabel="" | ||
| thumbStyle={thumbStyle} | ||
| trackStyle={trackStyle} | ||
| thumbAnimateRange={[1, 17]} | ||
| colors={{ | ||
| active: { | ||
| base: COLORS.secondary, | ||
| }, | ||
| inactive: { | ||
| base: COLORS.purple15, | ||
| }, | ||
| activeThumb: { | ||
| base: COLORS.white, | ||
| }, | ||
| inactiveThumb: { | ||
| base: COLORS.white, | ||
| }, | ||
| }} | ||
| /> | ||
| </Container> | ||
| ); | ||
|
|
||
| Toggle.propTypes = propTypes; | ||
| Toggle.defaultProps = defaultProps; | ||
|
|
||
| export default Toggle; |
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,43 @@ | ||
| import styled from '@emotion/styled'; | ||
|
|
||
| import { COLORS, SPACING } from '../../constants'; | ||
|
|
||
| export const Container = styled.div` | ||
| position: relative; | ||
| display: flex; | ||
| flex-flow: row nowrap; | ||
| justify-content: space-between; | ||
| align-items: center; | ||
| width: 100%; | ||
| padding: ${SPACING.small} 0; | ||
|
|
||
| & > input { | ||
| display: none; | ||
| } | ||
| `; | ||
|
|
||
| export const Label = styled.span` | ||
| color: ${COLORS.primaryTint1}; | ||
| margin: 0; | ||
| font-size: ${SPACING.small}; | ||
| line-height: ${SPACING.base}; | ||
| text-align: left; | ||
| cursor: pointer; | ||
| user-select: none; | ||
| margin-right: ${SPACING.xsmall}; | ||
| `; | ||
|
|
||
| export const trackStyle = { | ||
| borderRadius: 100, | ||
| height: 24, | ||
| width: 40, | ||
| }; | ||
|
|
||
| export const thumbStyle = { | ||
|
There was a problem hiding this comment. Can we add a border of There was a problem hiding this comment. And make the background color of the thumb, white. There was a problem hiding this comment. Also looks like the thumb needs to be nudged over 1px when it's toggled on and toggled off. There was a problem hiding this comment. I moved it closer to edge 1 pixel when active, moving 1 more pixel closer to each edge started to feel odd for me, take a look this is one more pixel to each side
There was a problem hiding this comment. Okay let's go with whatever is marked Current. I don't know what I was seeing |
||
| height: 22, | ||
| width: 22, | ||
| border: `1px solid ${COLORS.border}`, | ||
| boxShadow: `none`, | ||
| background: COLORS.white, | ||
| backgroundColor: COLORS.white, | ||
| }; | ||
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,45 @@ | ||
| import React from 'react'; | ||
| import { shallow, mount } from 'enzyme'; | ||
| import renderer from 'react-test-renderer'; | ||
|
|
||
| import Toggle from './index'; | ||
|
|
||
| describe('<Toggle />', () => { | ||
| const labelText = 'Label Text'; | ||
|
|
||
| describe('UI snapshot', () => { | ||
| it('renders the component', () => { | ||
| const component = renderer.create( | ||
| <Toggle checked={false} label={labelText} /> | ||
| ); | ||
|
|
||
| const tree = component.toJSON(); | ||
| expect(tree).toMatchSnapshot(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when label is undefined', () => { | ||
| test('does not render a label component', () => { | ||
| const wrapper = shallow(<Toggle checked={false} />); | ||
| expect(wrapper.html().indexOf('label') === -1).toBe(true); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when label is a string', () => { | ||
| test('renders a text component', () => { | ||
| const wrapper = shallow(<Toggle checked={false} label={labelText} />); | ||
|
|
||
| expect(wrapper.html().indexOf(labelText) > 0).toBe(true); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when checkbox is clicked', () => { | ||
| test('fires onChange function with correct argument when function exists', () => { | ||
| const spy = jest.fn(); | ||
| const wrapper = mount(<Toggle checked={false} onChange={spy} />); | ||
|
|
||
| wrapper.find('[type="checkbox"]').simulate('click'); | ||
| expect(spy).toHaveBeenCalled(); | ||
| }); | ||
| }); | ||
| }); |
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.
Can we make the track background color
purple15? That's on me. It wasn't included in the design mocks but I think it will be better. It also matches our disabled button styling.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.
done