aboutsummaryrefslogtreecommitdiff
path: root/types/ext/popup-menu.d.ts
blob: c12a200e73ea64bfd9d195a6e11ac29a9f3cd679 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import type {PopupMenu} from '../../ext/js/dom/popup-menu';
import type {EventNames, EventArgument as BaseEventArgument} from './core';

export type Events = {
    close: {
        menu: PopupMenu;
        item: HTMLElement | null;
        action: string | null;
        cause: CloseReason;
        altKey: boolean;
        ctrlKey: boolean;
        metaKey: boolean;
        shiftKey: boolean;
    };
};

export type EventArgument<TName extends EventNames<Events>> = BaseEventArgument<Events, TName>;

export type CloseReason = 'close' | 'outside' | 'item' | 'resize';

export type MenuOpenEventDetails = {
    menu: PopupMenu;
};

export type MenuOpenEvent = CustomEvent<MenuOpenEventDetails>;

export type MenuCloseEvent = CustomEvent<EventArgument<'close'>>;