Sheet component for plugins
Summary:
Exposing a `<Sheet>` component to plugins. This allows plugins to create sheets, by returning something like this from their render function:
```js
return <div>
contents of my plugin
<Sheet>{() => <div>content of my sheet</div>}
</div>
```
Reviewed By: passy
Differential Revision: D13597251
fbshipit-source-id: 9da6ba6d2036243ddd2d05b73d392bf24be8d375
This commit is contained in:
committed by
Facebook Github Bot
parent
0048fc6e4a
commit
384529e97f
89
src/ui/components/Sheet.js
Normal file
89
src/ui/components/Sheet.js
Normal file
@@ -0,0 +1,89 @@
|
||||
/**
|
||||
* Copyright 2018-present Facebook.
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
* @format
|
||||
*/
|
||||
|
||||
import {Component} from 'react';
|
||||
import {createPortal} from 'react-dom';
|
||||
import {connect} from 'react-redux';
|
||||
import {setActiveSheet} from '../../reducers/application.js';
|
||||
|
||||
import type {ActiveSheet} from '../../reducers/application';
|
||||
|
||||
export const PLUGIN_SHEET_ELEMENT_ID = 'pluginSheetContents';
|
||||
|
||||
type Props = {
|
||||
/**
|
||||
* Function as child component (FaCC) to render the contents of the sheet.
|
||||
* A `onHide` function is passed as argument, that can be called to remove
|
||||
* the sheet.
|
||||
*/
|
||||
children: (onHide: () => void) => ?React.Node,
|
||||
setActiveSheet: (sheet: ActiveSheet) => any,
|
||||
activeSheet: ActiveSheet,
|
||||
};
|
||||
|
||||
type State = {
|
||||
content: ?React.Node,
|
||||
};
|
||||
|
||||
/**
|
||||
* Usage: <Sheet>{onHide => <YourSheetContent onHide={onHide} />}</Sheet>
|
||||
*/
|
||||
class Sheet extends Component<Props, State> {
|
||||
static getDerivedStateFromProps(props: Props) {
|
||||
if (props.activeSheet === 'PLUGIN_SHEET') {
|
||||
return {
|
||||
content: props.children(() => {
|
||||
props.setActiveSheet(null);
|
||||
}),
|
||||
};
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
state = {
|
||||
content: this.props.children(() => {
|
||||
this.props.setActiveSheet(null);
|
||||
}),
|
||||
};
|
||||
|
||||
componentDidMount() {
|
||||
this.showSheetIfContentsAvailable();
|
||||
}
|
||||
|
||||
componentDidUpdate(prevProps: Props, prevState: State) {
|
||||
if (prevState.content !== this.state.content) {
|
||||
this.showSheetIfContentsAvailable();
|
||||
}
|
||||
}
|
||||
|
||||
showSheetIfContentsAvailable = () => {
|
||||
if (this.state.content) {
|
||||
this.props.setActiveSheet('PLUGIN_SHEET');
|
||||
} else {
|
||||
this.props.setActiveSheet(null);
|
||||
}
|
||||
};
|
||||
|
||||
render() {
|
||||
const container = document.getElementById(PLUGIN_SHEET_ELEMENT_ID);
|
||||
if (this.state.content && container) {
|
||||
return createPortal(this.state.content, container);
|
||||
}
|
||||
if (this.state.content) {
|
||||
console.warn(
|
||||
`The <Sheet> could not be displayed, because there was not element#${PLUGIN_SHEET_ELEMENT_ID}.`,
|
||||
);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// $FlowFixMe
|
||||
export default connect(
|
||||
({application: {activeSheet}}) => ({activeSheet}),
|
||||
{setActiveSheet},
|
||||
)(Sheet);
|
||||
@@ -165,3 +165,5 @@ export {
|
||||
export {InspectorSidebar} from './components/elements-inspector/sidebar.js';
|
||||
|
||||
export {Console} from './components/console.js';
|
||||
|
||||
export {default as Sheet} from './components/Sheet.js';
|
||||
|
||||
Reference in New Issue
Block a user