index.d.ts

/** Declaration file generated by dts-gen */
import * as React from "react";

/*~ You can declare types that are available via importing the module */

export interface PaginationProps {
    changePage: (page: number) => void,
    totalItems: number,
    currentPage?: number,
    pageSize?: number,
    resultsText?: boolean | JSX.Element,
    limitSelector?: boolean,
    changeLimit?: (limit: number) => void,
    goToPage?: boolean
}

interface tooltipWrapperControlledProps {
    isControlled?: boolean,
    showTooltip?: (bool: boolean) => void,
    closeTooltip?: (bool: boolean) => void,
    isVisible?: boolean
}

interface tooltipWrapperOffsetAdjustmentsProps {
    top?: number,
    right?: number,
    left?: number
}

export interface TooltipWrapperProps {
    className?: string,
    children?: JSX.Element,
    tooltipComponent?: JSX.Element,
    left?: boolean,
    wide?: boolean,
    icon?: string,
    controlledProps?: tooltipWrapperControlledProps,
    offsetAdjustments?: tooltipWrapperOffsetAdjustmentsProps,
    styles?: any
}

export interface QuarterPickerProps {
    handleSelection: (quarter: number) => void,
    selectedQuarters: Array<string>,
    disabledQuarters: Array<string>,
    selectedPeriods: Array<string>,
    disabledPeriods: Array<string>,
    periodsPerQuarter: Array<[object]>,
    isCumulative: boolean,
    showPeriods: boolean
}

interface LoadingMessageProps {
    loadingText: string
}

interface PickerPropsOptions {
    name: string | number,
    value: string | number,
    onClick: (value: string | number) => void,
    classNames?: string
}

export interface PickerProps {
    sortFn: (a:any, b:any) => Array<any>,
    icon: JSX.Element,
    selectedOption: string,
    className: string,
    id: string,
    options: PickerPropsOptions,
    dropdownDirection: string,
    isFixedWidth: boolean,
    children: Array<JSX.Element> | JSX.Element,
    backgroundColor: string
}

interface SearchBarProps {
    onSearch: (value: string) => void,
    minChars: number,
    isDisabled: boolean,
    throttleOnChange: number,
    inputTitle: string,
    placeholder: string
}

interface TabsProps {
  types: Array<[object]>,
  active: string,
  switchTab: (value: string) => void,
  tabsClassName: string,
  tablessStyle: boolean
}

interface TooltipComponentTextAlign {
    title?: string,
    text?: string
}

export interface TooltipComponentProps {
    title: string,
    children: Array<JSX.Element> | JSX.Element,
    className: string,
    textAlign: TooltipComponentTextAlign
}

interface tableCurrentSortProps {
    direction: string,
    field: string
}

export interface TableProps {
    columns: Array<Object>,
    rows: Array<Object|[]>,
    currentSort: tableCurrentSortProps,
    updateSort: (title: string, direction: string) => void,
    expandable: boolean,
    divider: string,
    classNames: string
}

export interface GenericMessageProps {
    title: string,
    description: string,
    icon: object,
    className: string
}

export interface SectionWrapperProps {
    children: JSX.Element,
    defaultExpandedState: boolean,
    overLine: string,
    controlledProps: object,
    description: JSX.Element,
    titleTooltip: object,
    descTooltip: object,
    isCollapsible: boolean,
    isComingSoon: boolean,
    classNames: string,
    id: string,
    title: string,
    icon: JSX.Element,
    className: string
}

export interface SectionHeaderProps {
    icon: JSX.Element,
    title: string,
    overLine: string,
    description: JSX.Element,
    titleTooltip: object,
    descToolTip: object
}

export interface CarouselProps {
    items: Array<JSX.Element>
}

export interface InformationBoxesProps {
  boxes: Array<Object>
}

export interface ErrorMessageProps {
    description: string
}

export interface DownloadIconButtonProps {
    onClick: () => void,
    downloadInFlight: boolean,
    hoverComponent: JSX.Element
}

interface FiscalYearOptions {
    name: string | number,
    value: string | number
}

export interface FiscalYearPickerProps {
    backgroundColor: string,
    selectedFy: number | string,
    latestFy: number,
    earliestFy: number,
    handleFyChange: (fy: string) => void,
    options: Array<FiscalYearOptions>,
    sortFn: (a: string | number, b: string | number) => number;
}
export interface ShareIconProps {
    url: string,
    classNames: string,
    onShareOptionClick: (name: string) => void,
    includeDropdownOptions: Array<string>
}

export interface PageHeaderProps {
    title: string,
    overLine: string,
    stickyBreakPoint: number,
    toolBar: Array<JSX.Element>
}

export interface FlexGridContainerProps {
    children: JSX.Element,
    className: string
}

export interface FlexGridRowProps {
    children: JSX.Element,
    className: string,
    hasGutter: boolean,
    gutterSize: "sm" | "lg"
}

export interface FlexGridColProps {
    children: JSX.Element,
    className: string,
    desktop: number | "auto" | "fill" | object,
    tablet: number | "auto" | "fill" | object,
    mobile: number | "auto" | "fill" | object,
    width: number | "auto" | "fill" | object
}

export interface CardContainerProps {
    children: JSX.Element,
    className: string | object,
    variant: "elevated" | "outline",
    size: "sm" | "md" | "lg",
    fill: string,
    height: string | number
}

export interface FlexGridColProps {
    children: JSX.Element,
    className: string,
    desktop: number | "auto" | "fill" | object,
    tablet: number | "auto" | "fill" | object,
    mobile: number | "auto" | "fill" | object,
    width: number | "auto" | "fill" | object
}

export interface ButtonProps {
    buttonSize: "large" | "medium" | "small" | "lg" | "md" | "sm",
    backgroundColor: "light" | "dark",
    buttonType: "primary" | "primaryIcon" | "secondary" | "secondaryIcon" | "tertiary" | "tertiaryIcon" | "text" | "stacked" | "icon" | "inline" | "intext",
    copy: string,
    image: JSX.Element,
    textAlignment: "left" | "center",
    imageAlignment: "left" | "right",
    additionalClassnames: string,
    onClick: () => void,
    onKeyUp: () => void,
    buttonTitle: string,
    disabled: boolean,
    maxWidth: string,
    to: string
}

/*~ If this module has methods, declare them as functions like so.
 */
export class Pagination extends React.Component<PaginationProps>{}
export class TooltipWrapper extends React.Component<TooltipWrapperProps>{}
export class QuarterPicker extends React.Component<QuarterPickerProps>{}
export function Picker(props: PickerProps): JSX.Element;
export function SearchBar(props: SearchBarProps): JSX.Element;
export function Tabs(props: TabsProps): JSX.Element;
export function TooltipComponent(props: TooltipComponentProps): JSX.Element;
export function Table(props: TableProps): JSX.Element;
export function GenericMessage(props: GenericMessageProps): JSX.Element;
export function LoadingMessage(props: LoadingMessageProps): JSX.Element;
export function ErrorMessage(props: ErrorMessageProps): JSX.Element;
export function SectionWrapper(props: SectionWrapperProps): JSX.Element;
export function SectionHeader(props: SectionHeaderProps): JSX.Element;
export function PageHeader(props: PageHeaderProps): JSX.Element;
export function FlexGridContainer(props: FlexGridContainerProps): JSX.Element;
export function FlexGridRow(props: FlexGridRowProps): JSX.Element;
export function FlexGridCol(props: FlexGridColProps): JSX.Element;
export function DownloadIconButton(props: DownloadIconButtonProps): JSX.Element;
export function FiscalYearPicker(props: FiscalYearPickerProps): JSX.Element;
export function ShareIcon(props: ShareIconProps): JSX.Element;
export function CardContainer(props: CardContainerProps): JSX.Element;
export function Button(props: ButtonProps): JSX.Element;
export function useCumulativeQuarterPicker(initialState: Array<string>): [Array<string>, () => void]
export function useDynamicStickyClass(ref: object, fixedStickyBreakPoint: number): [boolean, number, () => void, () => void, () => void]
/*~ If there are types, properties, or methods inside dotted names
 *~ of the module, declare them inside a "namespace".
 */
// export namespace Helpers {
//     /*~ For example, given this definition, someone could write:
//      *~   import { subProp } from "yourModule";
//      *~   subProp.foo();
//      *~ or
//      *~   import * as yourMod from "yourModule";
//      *~   yourMod.subProp.foo();
//      */
//     namespace MoneyFormatter {
//         function foo(): void;
//     }
// }