diff options
| author | Andrej Mihajlov <and@codeispoetry.ru> | 2017-03-10 19:25:19 +0000 |
|---|---|---|
| committer | Andrej Mihajlov <and@codeispoetry.ru> | 2017-03-10 19:25:19 +0000 |
| commit | d8ea9e952083e6d4d905a13729a9f8525abeb286 (patch) | |
| tree | d26a4c1a0df1b6529ed27dfbbd40c9751bbbc74d /app/components/HeaderBar.js | |
| parent | ab936cc298a81dbf0ef13e53bd03cff7f2324d13 (diff) | |
| download | mullvadvpn-d8ea9e952083e6d4d905a13729a9f8525abeb286.tar.xz mullvadvpn-d8ea9e952083e6d4d905a13729a9f8525abeb286.zip | |
Improve docs coverage. Add external docs for React.Component and Redux.Store
Diffstat (limited to 'app/components/HeaderBar.js')
| -rw-r--r-- | app/components/HeaderBar.js | 28 |
1 files changed, 27 insertions, 1 deletions
diff --git a/app/components/HeaderBar.js b/app/components/HeaderBar.js index f3dfa88e53..c7ac30d01f 100644 --- a/app/components/HeaderBar.js +++ b/app/components/HeaderBar.js @@ -2,11 +2,34 @@ import React, { Component, PropTypes } from 'react'; import { If, Then } from 'react-if'; import Enum from '../lib/enum'; +/** + * Header bar component + * + * @export + * @class HeaderBar + * @extends {Component} + */ export default class HeaderBar extends Component { - /** Bar style */ + /** + * Bar style + * @type {Style} + * @property {string} default - default + * @property {string} defaultDark - default dark blue + * @property {string} error - red + * @property {string} success - green + * @static + * + * @memberOf HeaderBar + */ static Style = new Enum('default', 'defaultDark', 'error', 'success'); + /** + * Prop types + * @static + * + * @memberOf HeaderBar + */ static propTypes = { style: PropTypes.string, hidden: PropTypes.bool, @@ -14,6 +37,9 @@ export default class HeaderBar extends Component { onSettings: PropTypes.func }; + /** + * @override + */ render() { const style = this.props.style; let containerClass = ['headerbar']; |
