OWL
data_display
Emoji Picker
Odoo 19 OWL component — Emoji Picker (core)
Live preview
Interactive
Source excerpt
web/static/src/core/emoji_picker/emoji_picker.js
import { markEventHandled } from "@web/core/utils/misc";
import {
App,
Component,
onMounted,
onPatched,
onWillPatch,
onWillStart,
onWillUnmount,
reactive,
useComponent,
useEffect,
useExternalListener,
useRef,
useState,
xml,
} from "@odoo/owl";
import { loadBundle } from "@web/core/assets";
import { _t, appTranslateFn } from "@web/core/l10n/translation";
import { usePopover } from "@web/core/popover/popover_hook";
import { fuzzyLookup } from "@web/core/utils/search";
import { useAutofocus, useService } from "@web/core/utils/hooks";
import { isMobileOS } from "@web/core/browser/feature_detection";
import { Deferred } from "../utils/concurrency";
import { Dialog } from "../dialog/dialog";
import { getTemplate } from "@web/core/templates";
/**
* @typedef Emoji
* @property {string} category
* @property {string} codepoints the emoji itself to be displayed
* @property {string[]} emoticons string substitution (eg: ":p")
* @property {string[]} keywords
* @property {string} name
* @property {string[]} shortcodes
*/
export function useEmojiPicker(...args) {
return usePicker(EmojiPicker, ...args);
}
export const loader = reactive({
loadEmoji: () => loadBundle("web.assets_emoji"),
/** @type {{ emojiValueToShortcodes: Object<string, string[]>, emojiRegex: RegExp} }} */
loaded: undefined,
});
/** @returns {Promise<{ categories: Object[], emojis: Emoji[] }>")} */
export async function loadEmoji() {
const res = { categories: [], emojis: [] };
try {
await loader.loadEmoji();
const { getCategories, getEmojis } = odoo.loader.modules.get(
"@web/core/emoji_picker/emoji_data"
);
res.categories = getCategories();
res.emojis = getEmojis();
return res;
} catch {
// Could be intentional (tour ended successfully while emoji still loading)
return res;
} finally {
if (!loader.loaded) {
const emojiValueToShortcodes = {};
for (const emoji of res.emojis) {
emojiValueToShortcodes[emoji.codepoints] = emoji.shortcodes;
}
loader.loaded = {
emojiValueToShortcodes,
emojiRegex: new RegExp(
Object.keys(emojiValueToShortcodes).length
? Object.keys(emojiValueToShortcodes)
.map((c) => c.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&"))
.sort((a, b) => b.length - a.length) // Sort to get composed emojis first
.join("|")
: /(?!)/,
"gu"
),
};
}
}
}
export const PICKER_PROPS = [
"PickerComponent?",
"close?",
"onClose?",
"onSelect",
"state?",
"storeScroll?",
"mobile?",
];
export class EmojiPicker extends Component {
static props = [...PICKER_PROPS, "class?", "initialSearchTerm?"];
static template = "web.EmojiPicker";
categories = null;
/** @type {Emoji[]|null} */
emojis = null;
shouldScrollElem = null;
lastSearchTerm;
keyboardNavigated = false;
setup() {
this.gridRef = useRef("emoji-grid");
this.navbarRef = useRef("navbar");
this.ui = useService("ui");
this.isMobileOS = isMobileOS();
this.state = useState({
activeEmojiIndex: 0,
categoryId: null,
searchTerm: this.props.initialSearchTerm ?? "",
/** @type {Emoji|undefined} */
hoveredEmoji: undefined,
});
this.frequentEmojiService = useService("web.frequent.emoji");
useAutofocus();
Registry / API
- Registry name
EmojiPicker- Category
—- Module
web- Slug
emoji-picker- Nav group
data_display