megadoc-plugin-lua/ui/components/ModuleHeader.js

A Lua documentation generator plugin for megadoc.

const React = require("react");
const Heading = require('components/Heading');
const HeadingAnchor = require('components/HeadingAnchor');
const { string, object, bool, number, oneOfType } = React.PropTypes;

const ModuleHeader = React.createClass({
  propTypes: {
    doc: object,
    showSourcePaths: bool,
    anchorId: string,
    level: oneOfType([string, number]),
  },

  // shouldComponentUpdate: function(prevProps) {
  //   return prevProps.doc !== this.props.doc;
  // },

  render() {
    const { doc } = this.props;

    let type;

    if (doc.ctx.type === 'function') {
      type = 'Function';
    }
    else {
      type = 'Object';
    }

    let id = doc.id;

    if (doc.ctx.type === 'function' && doc.indexer === ':') {
      id = `${doc.receiver}:${doc.id}`;
    }

    return (
      <header className="anchorable-heading">
        <Heading
          level={this.props.level || 1}
          className="lua-module__header"
          title={this.props.showSourcePaths ? doc.filePath : undefined}
        >
          <HeadingAnchor.Anchor href={this.props.anchorId} />
          <HeadingAnchor.Link href={this.props.anchorId} />
          <HeadingAnchor.Text>
            <span className="lua-module__header-name">
              {id}
            </span>

            {' '}

            <span className="lua-module__header-type">
              <span>{type}</span>
            </span>
          </HeadingAnchor.Text>

        </Heading>
      </header>
    );
  }
});

module.exports = ModuleHeader;