| 1 | import * as React from 'react';
|
| 2 | import { IStyle, ITheme } from '../../Styling';
|
| 3 | import { IRefObject, IStyleFunctionOrObject } from '../../Utilities';
|
| 4 | import { DocumentCardTitleBase } from './DocumentCardTitle.base';
|
| 5 | /**
|
| 6 | * {@docCategory DocumentCard}
|
| 7 | */
|
| 8 | export interface IDocumentCardTitle {
|
| 9 | }
|
| 10 | /**
|
| 11 | * {@docCategory DocumentCard}
|
| 12 | */
|
| 13 | export interface IDocumentCardTitleProps extends React.ClassAttributes<DocumentCardTitleBase> {
|
| 14 | /**
|
| 15 | * Gets the component ref.
|
| 16 | */
|
| 17 | componentRef?: IRefObject<IDocumentCardTitle>;
|
| 18 | /**
|
| 19 | * Title text.
|
| 20 | * If the card represents more than one document, this should be the title of one document and a "+X" string.
|
| 21 | * For example, a collection of four documents would have a string of "Document.docx +3".
|
| 22 | */
|
| 23 | title: string;
|
| 24 | /**
|
| 25 | * Whether we truncate the title to fit within the box. May have a performance impact.
|
| 26 | * @defaultvalue true
|
| 27 | */
|
| 28 | shouldTruncate?: boolean;
|
| 29 | /**
|
| 30 | * Whether show as title as secondary title style such as smaller font and lighter color.
|
| 31 | * @defaultvalue false
|
| 32 | */
|
| 33 | showAsSecondaryTitle?: boolean;
|
| 34 | /**
|
| 35 | * Call to provide customized styling that will layer on top of the variant rules
|
| 36 | */
|
| 37 | styles?: IStyleFunctionOrObject<IDocumentCardTitleStyleProps, IDocumentCardTitleStyles>;
|
| 38 | /**
|
| 39 | * Theme provided by HOC.
|
| 40 | */
|
| 41 | theme?: ITheme;
|
| 42 | /**
|
| 43 | * Optional override class name
|
| 44 | */
|
| 45 | className?: string;
|
| 46 | }
|
| 47 | /**
|
| 48 | * {@docCategory DocumentCard}
|
| 49 | */
|
| 50 | export interface IDocumentCardTitleStyleProps {
|
| 51 | /**
|
| 52 | * Accept theme prop.
|
| 53 | */
|
| 54 | theme: ITheme;
|
| 55 | /**
|
| 56 | * Optional override class name
|
| 57 | */
|
| 58 | className?: string;
|
| 59 | /**
|
| 60 | * Is this a secondary title?
|
| 61 | */
|
| 62 | showAsSecondaryTitle?: boolean;
|
| 63 | }
|
| 64 | /**
|
| 65 | * {@docCategory DocumentCard}
|
| 66 | */
|
| 67 | export interface IDocumentCardTitleStyles {
|
| 68 | root: IStyle;
|
| 69 | }
|