@opendatasoft/visualizations/src/components/Format/types.ts

Opendatasoft's components to easily build dashboards and visualizations.

import type { WebGlMapOptions, WebGlMapData } from 'components/Map';

export type BooleanFormatProps = {
    value: boolean;
    valueToLabel?: (v: boolean) => string;
    debugWarnings?: boolean;
};

export type DateFormatProps = {
    value: string;
    valueToLabel?: (v: string) => string;
    intl?: Intl.DateTimeFormatOptions;
    locale?: string;
    debugWarnings?: boolean;
};

export type GeoFormatProps = {
    value: WebGlMapData;
    valueToLabel?: (v: WebGlMapData) => string;
    mapOptions?: WebGlMapOptions;
    debugWarnings?: boolean;
};

export type NumberFormatProps = {
    value: number;
    valueToLabel?: (v: string) => string;
    intl?: Intl.NumberFormatOptions;
    locale?: string;
    debugWarnings?: boolean;
};

export type TextFormatProps = {
    value: string;
    valueToLabel?: (v: string) => string;
    debugWarnings?: boolean;
};

export type URLFormatProps = {
    value: string;
    valueToLabel?: (v: string) => string;
    thumbnailUrl?: string;
    target?: HTMLAnchorElement['target'];
    rel?: HTMLAnchorElement['rel'];
    debugWarnings?: boolean;
};

export type ImageFormatProps = {
    value: string;
    valueToLabel?: (v: string) => string;
    alt?: string;
    target?: HTMLAnchorElement['target'];
    rel?: HTMLAnchorElement['rel'];
    debugWarnings?: boolean;
};