Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Add a Playground for the UI Components #4301

Merged
merged 20 commits into from
Jan 26, 2017
Merged
1 change: 1 addition & 0 deletions js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@
"react-copy-to-clipboard": "4.2.3",
"react-dom": "15.4.1",
"react-dropzone": "3.7.3",
"react-element-to-jsx-string": "6.0.0",
"react-intl": "2.1.5",
"react-portal": "3.0.0",
"react-redux": "4.4.6",
Expand Down
17 changes: 17 additions & 0 deletions js/src/playground/index.js
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';
90 changes: 90 additions & 0 deletions js/src/playground/playground.css
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;
Copy link
Contributor

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)


.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;
}
}
88 changes: 88 additions & 0 deletions js/src/playground/playground.js
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 () {
Copy link
Contributor

Choose a reason for hiding this comment

The 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 });
}
}
47 changes: 47 additions & 0 deletions js/src/playground/playground.spec.js
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);
});
});
55 changes: 55 additions & 0 deletions js/src/playground/playgroundExample.js
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>
);
}
}
51 changes: 51 additions & 0 deletions js/src/playground/store.js
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 {
Copy link
Contributor

Choose a reason for hiding this comment

The 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);
}
}
Loading