@teamsnap/teamsnap-ui
Version:
a CSS component library for TeamSnap
56 lines (55 loc) • 2.08 kB
TypeScript
/**
* @name SummaryList
*
* @description
* A component to render a 'dot' separated list of items. See the Teamsnap patterns library for more information.
* https://teamsnap-ui-patterns.netlify.com/patterns/components/summary-list.html
*
* @example
* <SummaryList
* heading='Example Header'
* items={[
* { description: 'Item One', value: '$75.00' },
* { description: 'Item Two', value: '$100.00', isFooterRow: true },
* ]}
* footer={ {description: 'Balance', '$175.00'} }/>
*/
import * as React from "react";
import * as PropTypes from "prop-types";
declare class SummaryList extends React.PureComponent<PropTypes.InferProps<typeof SummaryList.propTypes>, any> {
static propTypes: {
items: PropTypes.Validator<PropTypes.InferProps<{
description: PropTypes.Validator<PropTypes.ReactNodeLike>;
value: PropTypes.Validator<PropTypes.ReactNodeLike>;
key: PropTypes.Requireable<string>;
mods: PropTypes.Requireable<string>;
style: PropTypes.Requireable<object>;
}>[]>;
heading: PropTypes.Requireable<string>;
subHeading: PropTypes.Requireable<string>;
footer: PropTypes.Requireable<PropTypes.InferProps<{
description: PropTypes.Requireable<string | PropTypes.ReactElementLike>;
value: PropTypes.Requireable<string | PropTypes.ReactElementLike>;
}>>;
className: PropTypes.Requireable<string>;
mods: PropTypes.Requireable<string>;
style: PropTypes.Requireable<object>;
hasBorder: PropTypes.Requireable<boolean>;
otherProps: PropTypes.Requireable<object>;
};
static defaultProps: {
heading: any;
subHeading: any;
footer: any;
className: string;
mods: any;
style: {};
hasBorder: boolean;
otherProps: {};
};
renderColumn: (value: any) => JSX.Element;
renderHeading: () => JSX.Element;
renderItem: (item: any) => JSX.Element;
render(): JSX.Element;
}
export default SummaryList;