ChemPal Documentation - v1.7.0
    Preparing search index...

    Interface AppContextProps

    AppContextProps interface for application context

    interface AppContextProps {
        userSettings: UserSettings;
        setUserSettings: (settings: UserSettings) => void;
        advancedMode: boolean;
        setAdvancedMode: (enabled: boolean) => void;
        searchResults: Product[];
        setSearchResults: (results: Product[]) => void;
        setPanel?: (panel: number) => void;
        setDrawerTab: (tab: number) => void;
        toggleDrawer: (tab?: number) => void;
        drawerTab?: number;
        selectedSuppliers?: (
            | "SupplierAladdinSci"
            | "SupplierAlboChemicals"
            | "SupplierAlchemieLabs"
            | "SupplierAllianceChemical"
            | "SupplierAmarisChemicalSolutions"
            | "SupplierAmbeed"
            | "SupplierAsesChem"
            | "SupplierBioFuranChem"
            | "SupplierBVV"
            | "SupplierCarolina"
            | "SupplierCarolinaChemical"
            | "SupplierChemsavers"
            | "SupplierConsolidatedChemical"
            | "SupplierDailyBioUSA"
            | "SupplierFtfScientific"
            | "SupplierGoldAndSilverTesting"
            | "SupplierHimedia"
            | "SupplierInnovatingScience"
            | "SupplierLaballey"
            | "SupplierLabChem"
            | "SupplierLaboratoriumDiscounter"
            | "SupplierLeroChem"
            | "SupplierLibertySci"
            | "SupplierLiMac"
            | "SupplierLoudwolf"
            | "SupplierMacklin"
            | "SupplierOnyxmet"
            | "SupplierOrbitNaturalProductDerivatives"
            | "SupplierS3Chemicals"
            | "SupplierScienceLab"
            | "SupplierSynthetika"
            | "SupplierTheLabStockroom"
            | "SupplierVWR"
            | "SupplierWarchem"
        )[];
        setSelectedSuppliers: (
            suppliers: (
                | "SupplierAladdinSci"
                | "SupplierAlboChemicals"
                | "SupplierAlchemieLabs"
                | "SupplierAllianceChemical"
                | "SupplierAmarisChemicalSolutions"
                | "SupplierAmbeed"
                | "SupplierAsesChem"
                | "SupplierBioFuranChem"
                | "SupplierBVV"
                | "SupplierCarolina"
                | "SupplierCarolinaChemical"
                | "SupplierChemsavers"
                | "SupplierConsolidatedChemical"
                | "SupplierDailyBioUSA"
                | "SupplierFtfScientific"
                | "SupplierGoldAndSilverTesting"
                | "SupplierHimedia"
                | "SupplierInnovatingScience"
                | "SupplierLaballey"
                | "SupplierLabChem"
                | "SupplierLaboratoriumDiscounter"
                | "SupplierLeroChem"
                | "SupplierLibertySci"
                | "SupplierLiMac"
                | "SupplierLoudwolf"
                | "SupplierMacklin"
                | "SupplierOnyxmet"
                | "SupplierOrbitNaturalProductDerivatives"
                | "SupplierS3Chemicals"
                | "SupplierScienceLab"
                | "SupplierSynthetika"
                | "SupplierTheLabStockroom"
                | "SupplierVWR"
                | "SupplierWarchem"
            )[],
        ) => void;
        pendingSearchQuery: null
        | string;
        setPendingSearchQuery: (query: null | string) => void;
        searchFilters: SearchFilters;
        setSearchFilters: (filters: SearchFilters) => void;
        bookmarksFolderId?: null | string;
        setBookmarksFolderId: (id: null | string) => void;
    }
    Index

    Properties

    userSettings: UserSettings

    Application settings

    setUserSettings: (settings: UserSettings) => void

    Function to update settings

    advancedMode: boolean

    Session-only advanced mode, unlocked by the Konami hotkey. Reveals developer-only settings; deliberately not persisted, so it resets on reload.

    setAdvancedMode: (enabled: boolean) => void
    searchResults: Product[]

    Search results

    setSearchResults: (results: Product[]) => void

    Function to update search results

    setPanel?: (panel: number) => void

    Function to update panel

    setDrawerTab: (tab: number) => void

    Function to update drawer tab

    toggleDrawer: (tab?: number) => void

    Function to toggle drawer. Opens to the given tab (defaults to the search tab) when closed.

    drawerTab?: number

    Drawer state management - -1 = closed, 0 = search tab, 1 = history tab, 2 = settings tab

    selectedSuppliers?: (
        | "SupplierAladdinSci"
        | "SupplierAlboChemicals"
        | "SupplierAlchemieLabs"
        | "SupplierAllianceChemical"
        | "SupplierAmarisChemicalSolutions"
        | "SupplierAmbeed"
        | "SupplierAsesChem"
        | "SupplierBioFuranChem"
        | "SupplierBVV"
        | "SupplierCarolina"
        | "SupplierCarolinaChemical"
        | "SupplierChemsavers"
        | "SupplierConsolidatedChemical"
        | "SupplierDailyBioUSA"
        | "SupplierFtfScientific"
        | "SupplierGoldAndSilverTesting"
        | "SupplierHimedia"
        | "SupplierInnovatingScience"
        | "SupplierLaballey"
        | "SupplierLabChem"
        | "SupplierLaboratoriumDiscounter"
        | "SupplierLeroChem"
        | "SupplierLibertySci"
        | "SupplierLiMac"
        | "SupplierLoudwolf"
        | "SupplierMacklin"
        | "SupplierOnyxmet"
        | "SupplierOrbitNaturalProductDerivatives"
        | "SupplierS3Chemicals"
        | "SupplierScienceLab"
        | "SupplierSynthetika"
        | "SupplierTheLabStockroom"
        | "SupplierVWR"
        | "SupplierWarchem"
    )[]

    Selected Suppliers

    setSelectedSuppliers: (
        suppliers: (
            | "SupplierAladdinSci"
            | "SupplierAlboChemicals"
            | "SupplierAlchemieLabs"
            | "SupplierAllianceChemical"
            | "SupplierAmarisChemicalSolutions"
            | "SupplierAmbeed"
            | "SupplierAsesChem"
            | "SupplierBioFuranChem"
            | "SupplierBVV"
            | "SupplierCarolina"
            | "SupplierCarolinaChemical"
            | "SupplierChemsavers"
            | "SupplierConsolidatedChemical"
            | "SupplierDailyBioUSA"
            | "SupplierFtfScientific"
            | "SupplierGoldAndSilverTesting"
            | "SupplierHimedia"
            | "SupplierInnovatingScience"
            | "SupplierLaballey"
            | "SupplierLabChem"
            | "SupplierLaboratoriumDiscounter"
            | "SupplierLeroChem"
            | "SupplierLibertySci"
            | "SupplierLiMac"
            | "SupplierLoudwolf"
            | "SupplierMacklin"
            | "SupplierOnyxmet"
            | "SupplierOrbitNaturalProductDerivatives"
            | "SupplierS3Chemicals"
            | "SupplierScienceLab"
            | "SupplierSynthetika"
            | "SupplierTheLabStockroom"
            | "SupplierVWR"
            | "SupplierWarchem"
        )[],
    ) => void

    Function to update selected suppliers

    pendingSearchQuery: null | string

    Pending search query set from history panel (consumed by ResultsTable)

    setPendingSearchQuery: (query: null | string) => void

    Function to set a pending search query

    searchFilters: SearchFilters

    Pre-search filters from the drawer

    setSearchFilters: (filters: SearchFilters) => void

    Function to update pre-search filters

    bookmarksFolderId?: null | string

    ID of the ChemPal Favorites bookmarks folder (null if not yet resolved)

    setBookmarksFolderId: (id: null | string) => void

    Function to store the bookmarks folder ID