lucid-ui
Version:
A UI component library from AppNexus.
101 lines (99 loc) • 4.02 kB
JavaScript
import _ from 'lodash';
import React from 'react';
import PropTypes from 'react-peek/prop-types';
import { lucidClassNames } from '../../util/style-helpers';
import { findTypes, omitProps, } from '../../util/component-types';
import Point from '../Point/Point';
import Line from '../Line/Line';
import { any } from 'prop-types';
const cx = lucidClassNames.bind('&-Legend');
const POINT_SIZE = 12;
const LINE_WIDTH = 22;
const { number, string, oneOf, node, bool, func } = PropTypes;
const defaultProps = {
orient: 'vertical',
hasBorders: true,
isReversed: false,
};
const LegendItem = (_props) => null;
const handleItemClick = (index, props, event) => {
if (!props.onClick) {
return;
}
props.onClick(index, { props, event });
};
export const Legend = (props) => {
const { className, orient, hasBorders, isReversed, ...passThroughs } = props;
const isHorizontal = orient === 'horizontal';
const isVertical = orient === 'vertical';
const itemProps = _.map(findTypes(props, LegendItem), 'props');
const hasSomeLines = isVertical && _.some(itemProps, ({ hasLine }) => hasLine);
return (React.createElement("ul", Object.assign({}, omitProps(passThroughs, undefined, _.keys(Legend.propTypes)), { className: cx('&', {
'&-is-horizontal': isHorizontal,
'&-is-vertical': isVertical,
'&-has-borders': hasBorders,
'&-is-reversed': isReversed,
}, className) }), _.map(itemProps, ({ hasLine, hasPoint, pointKind = 1, color, children, className: itemClass, }, index) => (React.createElement("li", { key: index, className: cx(itemClass, '&-Item'), onClick: _.partial(handleItemClick, index, itemProps[index]) },
hasPoint || hasLine ? (React.createElement("svg", { className: cx('&-Item-indicator'), width: hasLine || hasSomeLines ? LINE_WIDTH : POINT_SIZE, height: POINT_SIZE },
hasPoint ? (React.createElement(Point, { x: hasLine || hasSomeLines ? LINE_WIDTH / 2 : POINT_SIZE / 2, y: POINT_SIZE / 2, color: color, kind: pointKind })) : null,
hasLine ? (React.createElement(Line, { d: `M0,${POINT_SIZE / 2} L${LINE_WIDTH},${POINT_SIZE / 2}`, color: color })) : null)) : null,
children)))));
};
Legend.defaultProps = defaultProps;
Legend.displayName = 'Legend';
Legend.peek = {
description: `
Contrary to the other chart primitives, this component is not rendered
in svg. In order to sanely render horizontal legends, we need to know
the width of the text elements ahead of rendering time. Since we're
using a variable width font, the only way I know of to correctly get
the width is with the DOM function \`getComputedTextLength\`. Variable
widths are much more easy to implement outside of svg.
`,
categories: ['visualizations', 'chart primitives'],
};
Legend.HEIGHT = 28; // exposed for consumer convenience
Legend.propTypes = {
Item: node `
Child element whose children represent content to be shown inside Legend.
`,
className: string `
Appended to the component-specific class names set on the root element.
`,
orient: oneOf(['horizontal', 'vertical']) `
Determine orientation of the legend.
`,
hasBorders: bool `
Show the legend borders. Turn this off if you want to put the legend in a
\`ToolTip\` for example.
`,
isReversed: bool `
Reverse the order of items in the legend.
`,
};
LegendItem.displayName = 'Legend.Item';
Legend.Item = LegendItem;
LegendItem.peek = {
description: `Renders a \`<li>\` that describes the data series.
`,
};
LegendItem.propName = 'Item';
LegendItem.propTypes = {
children: any,
};
LegendItem.propTypes = {
hasPoint: bool,
hasLine: bool,
color: string `
Strings should match an existing color class unless they start with a '#' for specific colors. E.g.:
- \`COLOR_0\`
- \`COLOR_GOOD\`
- \`'#123abc'\`
`,
pointKind: number,
onClick: func,
className: string `
Class names that are appended to the defaults.
`,
};
export default Legend;