1
Fork 0
mirror of https://github.com/pds-nest/nest.git synced 2024-11-22 13:04:19 +00:00

📔 Decorate the Summary component

This commit is contained in:
Stefano Pigozzi 2021-05-11 18:27:11 +02:00
parent aa8a138990
commit adba8507cf
Signed by untrusted user who does not match committer: steffo
GPG key ID: 6965406171929D01

View file

@ -4,6 +4,21 @@ import classNames from "classnames"
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome" import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
/**
* A long line displaying the summary of a certain entity, such as a repository or an user.
*
* @param title - The title of the summary.
* @param subtitle - The subtitle of the summary.
* @param upperLabel - The label for the upper value.
* @param upperValue - The upper value.
* @param lowerLabel - The label for the lower value.
* @param lowerValue - The lower value.
* @param buttons - Buttons to add to the right of the summary.
* @param className - Additional class(es) to add to the summary.
* @param props - Additional props to pass to the summary.
* @returns {JSX.Element}
* @constructor
*/
export default function Summary( export default function Summary(
{ title, subtitle, upperLabel, upperValue, lowerLabel, lowerValue, buttons, className, ...props }, { title, subtitle, upperLabel, upperValue, lowerLabel, lowerValue, buttons, className, ...props },
) { ) {