@mikezimm/npmfunctions/src/RelatedItems/IRelatedItemsProps.ts

Functions used in my SPFx webparts

import { WebPartContext, } from "@microsoft/sp-webpart-base";
import { IReadonlyTheme } from '@microsoft/sp-component-base';
import * as React from 'react';
import { IAnyContent } from './IRelatedItemsState';


export interface IRelatedFetchInfo {
  [key: string]: string | boolean | string[] | undefined;
  web: string;
  listTitle: string;
  restFilter: string;
  itemsAreFiles: boolean; // Used to include ServerRedirectedEmbedUrl in fetch for alt-click
  linkProp: string; // aka FileLeaf to open file name, if empty, will just show the value
  displayProp: string;
  canvasLinks?: boolean;
  canvasImgs?: boolean;
  ignoreDefaultImages?: boolean;  //https://github.com/mikezimm/PageInfo/issues/79 - Empty 'Default' images from Hero web part.

  textFilter?: string;  //Filter other related props
  textFilterProps?: string[];

}

export type IRelatedKey = 'related1' | 'related2' | 'pageLinks';

export interface IRelatedItemsProps {
  [key: string]: string | boolean | WebPartContext | IAnyContent[] |IRelatedFetchInfo | IReadonlyTheme | React.CSSProperties |undefined;
  context?: WebPartContext;
  parentKey: IRelatedKey;
  heading: string;
  showItems: boolean;
  isExpanded: boolean;
  fetchInfo: IRelatedFetchInfo;

  items?: IAnyContent[];

  linkSearchBox?: boolean;  //For future use - possibly to searching of Links or Link Urls
  linkFilter?: string;  //Filter links or images by text

  themeVariant: IReadonlyTheme | undefined;

  itemsStyle: React.CSSProperties;
}