superset/superset-frontend/src/components/Hotkeys.jsx
David Aaron Suddjian 2913063924 SIP-32: Moving frontend code to the base of the repo (#9098)
* move assets out, get webpack dev working

* update docs to reference superset-frontend

* draw the rest of the owl

* fix docs

* fix webpack script

* rats

* correct docs

* fix tox dox
2020-02-09 17:53:56 -08:00

88 lines
2.4 KiB
JavaScript

/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import React from 'react';
import PropTypes from 'prop-types';
import Mousetrap from 'mousetrap';
import { OverlayTrigger, Popover } from 'react-bootstrap';
const propTypes = {
hotkeys: PropTypes.arrayOf(
PropTypes.shape({
key: PropTypes.string.isRequired,
descr: PropTypes.string.isRequired,
func: PropTypes.func,
}),
).isRequired,
header: PropTypes.string,
placement: PropTypes.string,
};
const defaultProps = {
hotkeys: [],
};
export default class Hotkeys extends React.PureComponent {
componentDidMount() {
this.props.hotkeys.forEach(keyConfig => {
if (keyConfig.func) {
Mousetrap.bind([keyConfig.key], keyConfig.func);
}
});
}
renderPopover() {
const { header, hotkeys } = this.props;
return (
<Popover id="hotkey-popover" title={header} style={{ width: '300px' }}>
<table className="table table-condensed">
<thead>
<tr>
<th>Key</th>
<th>Action</th>
</tr>
</thead>
<tbody>
{hotkeys.map(({ key, descr }) => (
<tr key={key}>
<td>
<code>{key}</code>
</td>
<td>{descr}</td>
</tr>
))}
</tbody>
</table>
</Popover>
);
}
render() {
return (
<OverlayTrigger
overlay={this.renderPopover()}
trigger={['hover', 'focus']}
placement={this.props.placement || 'top'}
>
<i className="fa fa-keyboard-o fa-lg" />
</OverlayTrigger>
);
}
}
Hotkeys.propTypes = propTypes;
Hotkeys.defaultProps = defaultProps;