a9bdde193d
We seemed to be using the names "film strip" and "filmstrip" (and, consequently, their source code-conscious forms such as film-strip, FilmStrip, etc.) In order to comply with our coding style which requires a consistent one name for a given abstraction, choose one name and rename the uses of the other name. Wikipedia has a definition of a "filmstrip", I couldn't find a "film strip". I guess our abstraction can be seen as what's described there. When I google "film strip", I get results about "filmstrip" at the top. That's why I chose "filmstrip". Certain uses of "film strip" such as interfaceConfig.filmStripOnly and in the external API I left untouched in an attempt to preserve compatibility. I wasn't sure whether CSS was tangled in compatibility so I made a choice and renamed there was well.
78 lines
1.9 KiB
JavaScript
78 lines
1.9 KiB
JavaScript
import React, { Component } from 'react';
|
|
|
|
declare var interfaceConfig: Object;
|
|
|
|
/**
|
|
* Implements a React Component for the frame of the overlays.
|
|
*/
|
|
export default class OverlayFrame extends Component {
|
|
/**
|
|
* OverlayFrame component's property types.
|
|
*
|
|
* @static
|
|
*/
|
|
static propTypes = {
|
|
/**
|
|
* The children components to be displayed into the overlay frame.
|
|
*/
|
|
children: React.PropTypes.node.isRequired,
|
|
|
|
/**
|
|
* Indicates the css style of the overlay. If true, then lighter;
|
|
* darker, otherwise.
|
|
*
|
|
* @type {boolean}
|
|
*/
|
|
isLightOverlay: React.PropTypes.bool
|
|
}
|
|
|
|
/**
|
|
* Initializes a new AbstractOverlay instance.
|
|
*
|
|
* @param {Object} props - The read-only properties with which the new
|
|
* instance is to be initialized.
|
|
* @public
|
|
*/
|
|
constructor(props) {
|
|
super(props);
|
|
|
|
this.state = {
|
|
/**
|
|
* Indicates whether the filmstrip only mode is enabled or not.
|
|
*
|
|
* @type {boolean}
|
|
*/
|
|
filmstripOnly: interfaceConfig.filmStripOnly
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Implements React's {@link Component#render()}.
|
|
*
|
|
* @inheritdoc
|
|
* @returns {ReactElement|null}
|
|
*/
|
|
render() {
|
|
let containerClass = this.props.isLightOverlay
|
|
? 'overlay__container-light' : 'overlay__container';
|
|
let contentClass = 'overlay__content';
|
|
|
|
if (this.state.filmstripOnly) {
|
|
containerClass += ' filmstrip-only';
|
|
contentClass += ' filmstrip-only';
|
|
}
|
|
|
|
return (
|
|
<div
|
|
className = { containerClass }
|
|
id = 'overlay'>
|
|
<div className = { contentClass }>
|
|
{
|
|
this.props.children
|
|
}
|
|
</div>
|
|
</div>
|
|
);
|
|
}
|
|
}
|