@communityox/ox_lib/client/resource/interface/context.d.ts

JS/TS wrapper for ox_lib exports

import type { IconName, IconPrefix } from '@fortawesome/fontawesome-common-types';
type IconAnimation = 'spin' | 'spinPulse' | 'spinReverse' | 'pulse' | 'beat' | 'fade' | 'beatFade' | 'bounce' | 'shake';
interface ContextMenuItem {
    menu?: string;
    title?: string;
    description?: string;
    arrow?: boolean;
    image?: string;
    icon?: IconName | [IconPrefix, IconName] | string;
    iconColor?: string;
    iconAnimation?: IconAnimation;
    progress?: number;
    colorScheme?: string;
    onSelect?: (args: any) => void;
    readOnly?: boolean;
    metadata?: string[] | {
        [key: string]: any;
    } | {
        label: string;
        value: any;
        progress?: number;
        colorScheme?: string;
    }[];
    disabled?: boolean;
    event?: string;
    serverEvent?: string;
    args?: any;
}
interface ContextMenuArrayItem extends ContextMenuItem {
    title: string;
}
interface ContextMenuProps {
    id: string;
    title: string;
    menu?: string;
    onExit?: () => void;
    onBack?: () => void;
    canClose?: boolean;
    options: {
        [key: string]: ContextMenuItem;
    } | ContextMenuArrayItem[];
}
type registerContext = (context: ContextMenuProps | ContextMenuProps[]) => void;
export declare const registerContext: registerContext;
export declare const showContext: (id: string) => void;
export declare const hideContext: (onExit: boolean) => void;
export declare const getOpenContextMenu: () => string | null;
export {};