UNPKG

@eccenca/gui-elements

Version:

GUI elements based on other libraries, usable in React application, written in Typescript.

30 lines (29 loc) 1.19 kB
import React from "react"; import { CardProps } from "../Card/Card"; export interface OverviewItemProps extends React.HTMLAttributes<HTMLDivElement> { /** * Displays the element using reduced height and less white space inside. */ densityHigh?: boolean; /** * Add a bit white space around the element. */ hasSpacing?: boolean; /** * Uses a `Card` element to wrap the `OverviewItem` inside. * It is always used with `isOnlyLayout` set to `true`. * Should be used together with `hasSpacing`. */ hasCardWrapper?: boolean; /** * Forwarding basic `Card` properties to the wrapper element. * Only used if `hasCardWrapper` is set to `true`. */ cardProps?: Omit<CardProps, "children" | "isOnlyLayout" | "fullHeight" | "whitespaceAmount" | "compact">; } /** * This element can include all basic information and actions to give an overview about the item. * Mainly used in items list or to create basic widgets. */ export declare const OverviewItem: ({ children, className, densityHigh, hasSpacing, hasCardWrapper, cardProps, ...otherProps }: OverviewItemProps) => React.JSX.Element; export default OverviewItem;