njamed-dictionary-maker v4.0.0

About Njamed Dictionary Maker

Njamed Dictionary Maker is one big component that makes a dictionary. It takes three props:

data: Dictionary | null;
theme: Theme | null;
appConfig: AppConfig | null;

These are defined as follows:

export type Dictionary = {
  entities: {
    SeeAlso: SeeAlsoDictionary;
    HeadwordAudio: HeadwordAudioDictionary;
    Video: VideoDictionary;
    ExampleAudio: ExampleAudioDictionary;
    Paradigm: ParadigmDictionary;
    SemanticDomain: SemanticDomainDictionary;
    Image: ImageDictionary;
    Phrase: PhraseDictionary;
    Sense: SenseDictionary;
    SubEntry: SubEntryDictionary;
    Entry: EntryDictionary;
    AboutSection: AboutSectionDictionary;
  };
  collections: Collection[];
};
export type DictionaryKey = keyof Dictionary["entities"];

export type Theme = {
  palette: {
    primary: string;
    secondary: string;
    tertiary: string;
    accent: string;
    accentText: string;
    green: string;
    brown: string;
    paper: string;
    text: string;
    lightText: string;
    background: string;
    border: string;
    error: string;
    success: string;
    warning: string;
    info: string;
  };
  typography: {
    text1: string;
    text2: string;
    displayFontFamily: string;
  };
};

export type AppConfig = {
  title: string;
  subtitle: string;
  audioCloudSrc: string; // e.g. https://res.cloudinary.com/dykmwkpgw/video/upload/dictionary-name/
  imgCloudSrc: string; // e.g. https://res.cloudinary.com/dykmwkpgw/image/upload/dictionary-name/
  appIconSrc: string; // e.g. https://res.cloudinary.com/dykmwkpgw/image/upload/v1711414367/m2896qvzbcioesyxfvow.svg
  icons: { [key: string]: string };
};