-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add a Playground for the UI Components #4301
Changes from 6 commits
e898b52
c504ca8
ddf11a9
de0a780
e5c5bd6
3771f52
5b153f9
3521319
0c330a9
34c6a14
86de6d1
7e811c6
20a0d4f
6feb044
23aec8f
c1c406a
4b8124b
f493ca5
ac2f15e
37352f7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// Copyright 2015, 2016 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'; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
/* Copyright 2015, 2016 Parity Technologies (UK) Ltd. | ||
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.
|
||
/* 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/>. | ||
*/ | ||
|
||
.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; | ||
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. Alphabetical order for properties. (Applies to the rest of the file as well) |
||
|
||
.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: #002b36; | ||
color: #93a1a1; | ||
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. Since this is a new file, I would define the colors as variables on top of the file for easier extraction, i.e.
|
||
font-size: 0.75em; | ||
|
||
code { | ||
white-space: pre; | ||
} | ||
} | ||
|
||
.component { | ||
flex: 3; | ||
padding-left: 0.5em; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// Copyright 2015, 2016 Parity Technologies (UK) Ltd. | ||
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.
|
||
// 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 PlaygroundStore from './store'; | ||
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. Move these 2 beneath the ui-wide imports.
|
||
import styles from './playground.css'; | ||
|
||
import CurrencySymbol from '~/ui/CurrencySymbol/currencySymbol.example'; | ||
import QrCode from '~/ui/QrCode/qrCode.example'; | ||
import SectionList from '~/ui/SectionList/sectionList.example'; | ||
|
||
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 }); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
// Copyright 2015, 2016 Parity Technologies (UK) Ltd. | ||
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.
|
||
// 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> | ||
); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
// Copyright 2015, 2016 Parity Technologies (UK) Ltd. | ||
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.
|
||
// 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); | ||
} | ||
} |
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.
2015-2017
(as per updates)