This repository has been archived by the owner on Nov 6, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add a Playground for the UI Components #4301
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
e898b52
Playground // WIP
ngotchac c504ca8
Linting
ngotchac ddf11a9
Add Examples with code
ngotchac de0a780
CSS Linting
ngotchac e5c5bd6
Linting
ngotchac 3771f52
Add Connected Currency Symbol
ngotchac 5b153f9
2015-2017
jacogr 3521319
2015-2017
jacogr 0c330a9
2015-2017
jacogr 34c6a14
2015-2017
jacogr 86de6d1
2015-2017
jacogr 7e811c6
2015-2017
jacogr 20a0d4f
2015-2017
jacogr 6feb044
Merge branch 'master' into ng-playground
ngotchac 23aec8f
Added `renderSymbol` tests
ngotchac c1c406a
PR grumbles
ngotchac 4b8124b
Add Eth and Btc QRCode examples
ngotchac f493ca5
2015-2017
ngotchac ac2f15e
Add tests for playground
ngotchac 37352f7
Fixing tests
ngotchac 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
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,17 @@ | ||
// Copyright 2015-2017 Parity Technologies (UK) Ltd. | ||
// This file is part of Parity. | ||
|
||
// Parity is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
|
||
// Parity is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
|
||
// You should have received a copy of the GNU General Public License | ||
// along with Parity. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
export default from './playground'; |
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,90 @@ | ||
/* Copyright 2015-2017 Parity Technologies (UK) Ltd. | ||
/* This file is part of Parity. | ||
/* | ||
/* Parity is free software: you can redistribute it and/or modify | ||
/* it under the terms of the GNU General Public License as published by | ||
/* the Free Software Foundation, either version 3 of the License, or | ||
/* (at your option) any later version. | ||
/* | ||
/* Parity is distributed in the hope that it will be useful, | ||
/* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
/* GNU General Public License for more details. | ||
/* | ||
/* You should have received a copy of the GNU General Public License | ||
/* along with Parity. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
|
||
$codeBackground: #002b36; | ||
$codeColor: #93a1a1; | ||
|
||
.container { | ||
background-color: rgba(0, 0, 0, 0.5); | ||
position: fixed; | ||
top: 0; | ||
right: 0; | ||
bottom: 0; | ||
left: 0; | ||
padding: 1em; | ||
display: flex; | ||
flex-direction: column; | ||
|
||
.examples { | ||
flex: 1; | ||
overflow: auto; | ||
} | ||
} | ||
|
||
.title { | ||
font-size: 2.25em; | ||
margin-bottom: 1em; | ||
|
||
.select { | ||
font-size: 0.85em; | ||
font-family: monospace; | ||
display: inline-block; | ||
height: 1.5em; | ||
border: 1px solid #aaa; | ||
padding: 0 0.5em; | ||
color: #555; | ||
appearance: none; | ||
} | ||
} | ||
|
||
.exampleContainer { | ||
background-color: rgba(0, 0, 0, 0.5); | ||
padding: 1em; | ||
margin-bottom: 1em; | ||
|
||
&:last-child { | ||
margin-bottom: 0; | ||
} | ||
|
||
p { | ||
font-size: 1.25em; | ||
margin-top: 0; | ||
} | ||
} | ||
|
||
.example { | ||
display: flex; | ||
flex-direction: row; | ||
|
||
.code { | ||
flex: 1; | ||
overflow: auto; | ||
padding: 0.5em; | ||
background-color: #$codeBackground; | ||
color: $codeColor; | ||
font-size: 0.75em; | ||
|
||
code { | ||
white-space: pre; | ||
} | ||
} | ||
|
||
.component { | ||
flex: 3; | ||
padding-left: 0.5em; | ||
} | ||
} |
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,88 @@ | ||
// Copyright 2015-2017 Parity Technologies (UK) Ltd. | ||
// This file is part of Parity. | ||
|
||
// Parity is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
|
||
// Parity is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
|
||
// You should have received a copy of the GNU General Public License | ||
// along with Parity. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
import { observer } from 'mobx-react'; | ||
import React, { Component } from 'react'; | ||
|
||
import CurrencySymbol from '~/ui/CurrencySymbol/currencySymbol.example'; | ||
import QrCode from '~/ui/QrCode/qrCode.example'; | ||
import SectionList from '~/ui/SectionList/sectionList.example'; | ||
|
||
import PlaygroundStore from './store'; | ||
import styles from './playground.css'; | ||
|
||
PlaygroundStore.register(<CurrencySymbol />); | ||
PlaygroundStore.register(<QrCode />); | ||
PlaygroundStore.register(<SectionList />); | ||
|
||
@observer | ||
export default class Playground extends Component { | ||
state = { | ||
selectedIndex: 0 | ||
}; | ||
|
||
store = PlaygroundStore.get(); | ||
|
||
render () { | ||
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. I would add at least a smoketest for any new components (i.e. it does render). While this is not meant for production, good habit to form and even the basic test does pick up some issues. |
||
return ( | ||
<div className={ styles.container }> | ||
<div className={ styles.title }> | ||
<span>Playground > </span> | ||
<select | ||
className={ styles.select } | ||
onChange={ this.handleChange } | ||
> | ||
{ this.renderOptions() } | ||
</select> | ||
</div> | ||
|
||
<div className={ styles.examples }> | ||
{ this.renderComponent() } | ||
</div> | ||
</div> | ||
); | ||
} | ||
|
||
renderOptions () { | ||
const { components } = this.store; | ||
|
||
return components.map((element, index) => { | ||
const name = element.type.displayName || element.type.name; | ||
|
||
return ( | ||
<option | ||
key={ `${name}_${index}` } | ||
value={ index } | ||
> | ||
{ name } | ||
</option> | ||
); | ||
}); | ||
} | ||
|
||
renderComponent () { | ||
const { components } = this.store; | ||
const { selectedIndex } = this.state; | ||
|
||
return components[selectedIndex]; | ||
} | ||
|
||
handleChange = (event) => { | ||
const { value } = event.target; | ||
|
||
this.setState({ selectedIndex: value }); | ||
} | ||
} |
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,47 @@ | ||
// Copyright 2015-2017 Parity Technologies (UK) Ltd. | ||
// This file is part of Parity. | ||
|
||
// Parity is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
|
||
// Parity is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
|
||
// You should have received a copy of the GNU General Public License | ||
// along with Parity. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
import { shallow } from 'enzyme'; | ||
import React from 'react'; | ||
|
||
import Playground from './playground'; | ||
|
||
let component; | ||
let options; | ||
|
||
function render (props = {}) { | ||
component = shallow( | ||
<Playground /> | ||
); | ||
|
||
options = component.find('option'); | ||
|
||
return component; | ||
} | ||
|
||
describe('playground', () => { | ||
beforeEach(() => { | ||
render(); | ||
}); | ||
|
||
it('renders defaults', () => { | ||
expect(component).to.be.ok; | ||
}); | ||
|
||
it('renders multiple options', () => { | ||
expect(options.length).to.be.greaterThan(2); | ||
}); | ||
}); |
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,55 @@ | ||
// Copyright 2015-2017 Parity Technologies (UK) Ltd. | ||
// This file is part of Parity. | ||
|
||
// Parity is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
|
||
// Parity is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
|
||
// You should have received a copy of the GNU General Public License | ||
// along with Parity. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
import React, { Component, PropTypes } from 'react'; | ||
import reactElementToJSXString from 'react-element-to-jsx-string'; | ||
|
||
import styles from './playground.css'; | ||
|
||
export default class PlaygroundExample extends Component { | ||
static propTypes = { | ||
children: PropTypes.node, | ||
name: PropTypes.string | ||
}; | ||
|
||
render () { | ||
const { children, name } = this.props; | ||
|
||
return ( | ||
<div className={ styles.exampleContainer }> | ||
{ this.renderName(name) } | ||
<div className={ styles.example }> | ||
<div className={ styles.code }> | ||
<code>{ reactElementToJSXString(children) }</code> | ||
</div> | ||
<div className={ styles.component }> | ||
{ children } | ||
</div> | ||
</div> | ||
</div> | ||
); | ||
} | ||
|
||
renderName (name) { | ||
if (!name) { | ||
return null; | ||
} | ||
|
||
return ( | ||
<p>{ name }</p> | ||
); | ||
} | ||
} |
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 @@ | ||
// Copyright 2015-2017 Parity Technologies (UK) Ltd. | ||
// This file is part of Parity. | ||
|
||
// Parity is free software: you can redistribute it and/or modify | ||
// it under the terms of the GNU General Public License as published by | ||
// the Free Software Foundation, either version 3 of the License, or | ||
// (at your option) any later version. | ||
|
||
// Parity is distributed in the hope that it will be useful, | ||
// but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
// GNU General Public License for more details. | ||
|
||
// You should have received a copy of the GNU General Public License | ||
// along with Parity. If not, see <http://www.gnu.org/licenses/>. | ||
|
||
import { action, observable } from 'mobx'; | ||
|
||
let instance = null; | ||
|
||
export default class PlaygroundStore { | ||
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. As per the component comment, I would add tests for the store - for the most part they are being tested (the older ones are in the process of acquiring tests where we have not been vigilant in the past) |
||
@observable components = []; | ||
|
||
static get () { | ||
if (!instance) { | ||
instance = new PlaygroundStore(); | ||
} | ||
|
||
return instance; | ||
} | ||
|
||
static register (component) { | ||
PlaygroundStore.get().add(component); | ||
} | ||
|
||
@action | ||
add (component) { | ||
const name = component.type.displayName || component.type.name; | ||
const hasComponent = this.components.find((c) => { | ||
const cName = c.type.displayName || c.type.name; | ||
|
||
return name && cName && cName === name; | ||
}); | ||
|
||
if (hasComponent) { | ||
return; | ||
} | ||
|
||
this.components.push(component); | ||
} | ||
} |
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.
Alphabetical order for properties. (Applies to the rest of the file as well)