@flux-ui/components 3.0.0-next.8 → 3.0.0

package/src/component/FluxCommandPalette.vue

@@ -0,0 +1,344 @@
+<template>
+    <Teleport to="body">
+        <div
+            v-if="isOpen || isClosing"
+            :class="[$style.commandPaletteBackdrop, isClosing && $style.isClosing]"
+            :style="zIndexBase !== null ? {zIndex: zIndexBase} : undefined"
+            @click="close"/>
+
+        <div
+            v-if="isOpen || isClosing"
+            ref="dialogRef"
+            :class="[$style.commandPaletteDialog, isClosing && $style.isClosing]"
+            :style="zIndexBase !== null ? {zIndex: zIndexBase + 1} : undefined"
+            tabindex="-1"
+            @click.self="close"
+            @keydown="onKeyDown">
+            <div
+                v-height-transition
+                :class="$style.commandPalette"
+                @mousedown.prevent>
+                <div :class="$style.commandPaletteSearch">
+                    <FluxIcon
+                        :class="$style.commandPaletteSearchIcon"
+                        name="magnifying-glass"/>
+
+                    <template v-if="activeTabSource">
+                        <button
+                            :class="$style.commandPaletteBreadcrumb"
+                            tabindex="-1"
+                            type="button"
+                            @click="clearSubActionTarget"
+                            @mousedown.prevent>
+                            {{ activeTabSource.label }}
+                        </button>
+
+                        <span :class="$style.commandPaletteBreadcrumbSeparator">/</span>
+                    </template>
+
+                    <template v-if="subActionTarget">
+                        <button
+                            :class="$style.commandPaletteBreadcrumb"
+                            tabindex="-1"
+                            type="button"
+                            @mousedown.prevent>
+                            {{ subActionTarget.label }}
+                        </button>
+
+                        <span :class="$style.commandPaletteBreadcrumbSeparator">/</span>
+                    </template>
+
+                    <input
+                        ref="inputRef"
+                        :class="$style.commandPaletteSearchInput"
+                        :placeholder="placeholder ?? 'Search...'"
+                        :value="search"
+                        type="text"
+                        @input="setSearch(($event.target as HTMLInputElement).value)"/>
+
+                    <FluxTag
+                        is-keyboard-shortcut
+                        label="Esc"/>
+                </div>
+
+                <div
+                    v-if="tabs.length > 0 && !subActionTarget"
+                    :class="$style.commandPaletteTabs">
+                    <button
+                        :class="activeTab === null ? $style.commandPaletteTabActive : $style.commandPaletteTab"
+                        tabindex="-1"
+                        type="button"
+                        @click="setActiveTab(null)"
+                        @mousedown.prevent>
+                        All
+                    </button>
+
+                    <button
+                        v-for="tab of tabs"
+                        :key="tab.key"
+                        :class="activeTab === tab.key ? $style.commandPaletteTabActive : $style.commandPaletteTab"
+                        tabindex="-1"
+                        type="button"
+                        @click="setActiveTab(tab.key)"
+                        @mousedown.prevent>
+                        <FluxIcon
+                            v-if="tab.icon"
+                            :class="$style.commandPaletteTabIcon"
+                            :name="tab.icon"/>
+
+                        {{ tab.label }}
+                    </button>
+                </div>
+
+                <FluxWindowTransition :is-back="isTransitioningBack">
+                    <div
+                        :key="activeTab"
+                        :class="$style.commandPaletteResults">
+                        <template v-if="subActionTarget">
+                            <FluxCommandPaletteItem
+                                v-for="(action, index) of subActions"
+                                :key="index"
+                                ref="itemRefs"
+                                :icon="action.icon"
+                                :is-highlighted="highlightedIndex === index"
+                                :label="action.label"
+                                @activate="activateSubAction(action)"
+                                @highlight="highlightedIndex = index"/>
+                        </template>
+
+                        <template v-else-if="groupedItems.length > 0">
+                            <template
+                                v-for="group of groupedItems"
+                                :key="group.sourceKey">
+                                <FluxCommandPaletteGroup
+                                    v-if="group.sourceLabel"
+                                    :label="group.sourceLabel"/>
+
+                                <FluxCommandPaletteItem
+                                    v-for="result of group.items"
+                                    :key="result.item.id"
+                                    ref="itemRefs"
+                                    :command="result.item.command"
+                                    :has-sub-actions="!!result.item.subActions?.length"
+                                    :icon="result.item.icon"
+                                    :is-highlighted="highlightedIndex === result.globalIndex"
+                                    :label="result.item.label"
+                                    :sub-label="result.item.subLabel"
+                                    @activate="activateItem(result.item)"
+                                    @highlight="highlightedIndex = result.globalIndex"/>
+                            </template>
+                        </template>
+
+                        <div
+                            v-else-if="isLoading"
+                            :class="$style.commandPaletteLoading">
+                            <FluxSpinner :size="22"/>
+                        </div>
+
+                        <div
+                            v-else
+                            :class="$style.commandPaletteEmpty">
+                            No results found.
+                        </div>
+                    </div>
+                </FluxWindowTransition>
+            </div>
+        </div>
+    </Teleport>
+</template>
+
+<script
+    lang="ts"
+    setup>
+    import { isSSR, useFocusTrap, vHeightTransition } from '@flux-ui/internals';
+    import type { FluxCommandSource, FluxCommandSourceItem } from '@flux-ui/types';
+    import { computed, onMounted, onUnmounted, ref, toRef, unref, useTemplateRef } from 'vue';
+    import { useCommandPalette } from '~flux/components/composable/private';
+    import { registerDialog, type FluxDialogRegistration } from '~flux/components/data';
+    import { FluxWindowTransition } from '~flux/components/transition';
+    import FluxCommandPaletteGroup from './FluxCommandPaletteGroup.vue';
+    import FluxCommandPaletteItem from './FluxCommandPaletteItem.vue';
+    import FluxIcon from './FluxIcon.vue';
+    import FluxSpinner from './FluxSpinner.vue';
+    import FluxTag from './FluxTag.vue';
+    import $style from '~flux/components/css/component/CommandPalette.module.scss';
+
+    const props = defineProps<{
+        readonly hasKeyboardShortcut?: boolean;
+        readonly placeholder?: string;
+        readonly sources: FluxCommandSource[];
+    }>();
+
+    const emit = defineEmits<{
+        select: [item: FluxCommandSourceItem];
+    }>();
+
+    const dialogRef = useTemplateRef<HTMLDivElement>('dialogRef');
+    const inputRef = useTemplateRef<HTMLInputElement>('inputRef');
+    const itemRefs = ref<InstanceType<typeof FluxCommandPaletteItem>[]>();
+
+    const isOpen = ref(false);
+    const isClosing = ref(false);
+
+    let pendingClose: (() => void) | null = null;
+
+    const dialogRegistration = ref<FluxDialogRegistration | null>(null);
+
+    const zIndexBase = computed(() => {
+        const registration = unref(dialogRegistration);
+
+        if (!registration) {
+            return null;
+        }
+
+        return 10001 + registration.getPosition() * 2;
+    });
+
+    useFocusTrap(dialogRef);
+
+    const {
+        search,
+        activeTab,
+        activeTabSource,
+        highlightedIndex,
+        isLoading,
+        isTransitioningBack,
+        subActionTarget,
+        groupedItems,
+        subActions,
+        tabs,
+        setSearch,
+        setActiveTab,
+        enterSubActions,
+        onKeyNavigate,
+        reset
+    } = useCommandPalette({
+        sources: toRef(() => props.sources),
+        itemRefs
+    });
+
+    function open(): void {
+        pendingClose?.();
+
+        if (unref(isOpen)) {
+            return;
+        }
+
+        dialogRegistration.value ??= registerDialog();
+        isOpen.value = true;
+
+        requestAnimationFrame(() => unref(inputRef)?.focus());
+    }
+
+    function close(): void {
+        if (!unref(isOpen) || unref(isClosing)) {
+            return;
+        }
+
+        const dialog = unref(dialogRef);
+
+        if (!dialog) {
+            return;
+        }
+
+        isClosing.value = true;
+
+        const finishClose = () => {
+            pendingClose = null;
+            isClosing.value = false;
+            isOpen.value = false;
+            reset();
+            dialogRegistration.value?.unregister();
+            dialogRegistration.value = null;
+        };
+
+        const onAnimationEnd = () => {
+            clearTimeout(fallbackTimeout);
+            finishClose();
+        };
+
+        const fallbackTimeout = setTimeout(() => {
+            dialog.removeEventListener('animationend', onAnimationEnd);
+            finishClose();
+        }, 250);
+
+        pendingClose = () => {
+            clearTimeout(fallbackTimeout);
+            dialog.removeEventListener('animationend', onAnimationEnd);
+            finishClose();
+        };
+
+        dialog.addEventListener('animationend', onAnimationEnd, {once: true});
+    }
+
+    function clearSubActionTarget(): void {
+        subActionTarget.value = null;
+        highlightedIndex.value = -1;
+    }
+
+    function activateItem(item: FluxCommandSourceItem): void {
+        if (unref(isClosing)) {
+            return;
+        }
+
+        if (item.subActions?.length) {
+            enterSubActions(item);
+        } else {
+            item.onActivate();
+            emit('select', item);
+            close();
+        }
+    }
+
+    function activateSubAction(action: { readonly onActivate: () => void; }): void {
+        if (unref(isClosing)) {
+            return;
+        }
+
+        action.onActivate();
+        close();
+    }
+
+    function onKeyDown(evt: KeyboardEvent): void {
+        if (unref(isClosing)) {
+            return;
+        }
+
+        onKeyNavigate(evt, close, (item) => {
+            emit('select', item);
+            close();
+        });
+    }
+
+    function onGlobalKeyDown(evt: KeyboardEvent): void {
+        if (evt.key === 'k' && (evt.metaKey || evt.ctrlKey)) {
+            evt.preventDefault();
+
+            if (unref(isOpen) && !unref(isClosing)) {
+                close();
+            } else {
+                open();
+            }
+        }
+    }
+
+    onUnmounted(() => {
+        dialogRegistration.value?.unregister();
+        dialogRegistration.value = null;
+    });
+
+    if (!isSSR && props.hasKeyboardShortcut) {
+        onMounted(() => {
+            window.addEventListener('keydown', onGlobalKeyDown);
+        });
+
+        onUnmounted(() => {
+            window.removeEventListener('keydown', onGlobalKeyDown);
+        });
+    }
+
+    defineExpose({
+        close,
+        open
+    });
+</script>

package/src/component/FluxCommandPaletteGroup.vue

@@ -0,0 +1,23 @@
+<template>
+    <div :class="$style.commandPaletteGroup">
+        <FluxIcon
+            v-if="icon"
+            :class="$style.commandPaletteGroupIcon"
+            :name="icon"/>
+
+        <span>{{ label }}</span>
+    </div>
+</template>
+
+<script
+    lang="ts"
+    setup>
+    import type { FluxIconName } from '@flux-ui/types';
+    import FluxIcon from './FluxIcon.vue';
+    import $style from '~flux/components/css/component/CommandPalette.module.scss';
+
+    defineProps<{
+        readonly icon?: FluxIconName;
+        readonly label: string;
+    }>();
+</script>

package/src/component/FluxCommandPaletteItem.vue

@@ -0,0 +1,60 @@
+<template>
+    <button
+        :class="isHighlighted ? $style.commandPaletteItemHighlighted : $style.commandPaletteItem"
+        tabindex="-1"
+        type="button"
+        @click="$emit('activate')"
+        @mousedown.prevent
+        @mouseenter="$emit('highlight')">
+        <div
+            v-if="icon"
+            :class="$style.commandPaletteItemIcon">
+            <FluxIcon :name="icon"/>
+        </div>
+
+        <div :class="$style.commandPaletteItemContent">
+            <div :class="$style.commandPaletteItemLabel">
+                {{ label }}
+            </div>
+
+            <div
+                v-if="subLabel"
+                :class="$style.commandPaletteItemSubLabel">
+                {{ subLabel }}
+            </div>
+        </div>
+
+        <FluxTag
+            v-if="command"
+            is-keyboard-shortcut
+            :label="command"/>
+
+        <FluxIcon
+            v-if="hasSubActions"
+            :class="$style.commandPaletteItemSubActionIndicator"
+            name="chevron-right"/>
+    </button>
+</template>
+
+<script
+    lang="ts"
+    setup>
+    import type { FluxIconName } from '@flux-ui/types';
+    import FluxIcon from './FluxIcon.vue';
+    import FluxTag from './FluxTag.vue';
+    import $style from '~flux/components/css/component/CommandPalette.module.scss';
+
+    defineEmits<{
+        activate: [];
+        highlight: [];
+    }>();
+
+    defineProps<{
+        readonly command?: string;
+        readonly hasSubActions?: boolean;
+        readonly icon?: FluxIconName;
+        readonly isHighlighted?: boolean;
+        readonly label: string;
+        readonly subLabel?: string;
+    }>();
+</script>

package/src/component/FluxComment.vue

@@ -38,10 +38,10 @@
     import type { FluxIconName } from '@flux-ui/types';
     import { clsx } from 'clsx';
     import type { DateTime } from 'luxon';
-    import { computed } from 'vue';
-    import { useTranslate } from '$flux/composable/private';
+    import { computed, onBeforeUnmount, onMounted, ref, type VNode } from 'vue';
+    import { useTranslate } from '~flux/components/composable/private';
     import FluxAvatar from './FluxAvatar.vue';
-    import $style from '$flux/css/component/Comment.module.scss';
+    import $style from '~flux/components/css/component/Comment.module.scss';
 
     const {
         avatarFallback = 'colorized',
@@ -60,12 +60,31 @@
     }>();
 
     defineSlots<{
-        default(): any;
+        default(): VNode[];
     }>();
 
     const translate = useTranslate();
 
-    const isJustNowVisible = computed(() => postedOn && Math.abs(postedOn.diffNow().as('seconds')) < 15);
+    const timeTick = ref(0);
+    let timeTickInterval: ReturnType<typeof setInterval> | undefined;
+
+    onMounted(() => {
+        timeTickInterval = setInterval(() => {
+            timeTick.value++;
+        }, 30000);
+    });
+
+    onBeforeUnmount(() => {
+        clearInterval(timeTickInterval);
+    });
+
+    const isJustNowVisible = computed(() => {
+        void timeTick.value;
+        return postedOn && Math.abs(postedOn.diffNow().as('seconds')) < 15;
+    });
     const iso = computed(() => postedOn?.toISO() ?? null);
-    const relative = computed(() => postedOn?.toRelative() ?? null);
+    const relative = computed(() => {
+        void timeTick.value;
+        return postedOn?.toRelative() ?? null;
+    });
 </script>

package/src/component/FluxConfirm.vue

@@ -1,14 +1,9 @@
 <template>
-    <FluxPane>
-        <FluxPaneHeader
-            :icon="confirm.icon"
-            :title="confirm.title"/>
-
-        <FluxPaneBody v-html="confirm.message"/>
-
-        <FluxPaneFooter>
-            <FluxSpacer/>
-
+    <DialogLayout
+        :icon="confirm.icon"
+        :message="confirm.message"
+        :title="confirm.title">
+        <template #footer>
             <FluxSecondaryButton
                 :label="translate('flux.cancel')"
                 @click="confirm.onCancel()"/>
@@ -17,22 +12,18 @@
                 icon-leading="circle-check"
                 :label="translate('flux.ok')"
                 @click="confirm.onConfirm()"/>
-        </FluxPaneFooter>
-    </FluxPane>
+        </template>
+    </DialogLayout>
 </template>
 
 <script
     lang="ts"
     setup>
     import type { FluxConfirmObject } from '@flux-ui/types';
-    import { useTranslate } from '$flux/composable/private';
-    import FluxPane from './FluxPane.vue';
-    import FluxPaneBody from './FluxPaneBody.vue';
-    import FluxPaneFooter from './FluxPaneFooter.vue';
-    import FluxPaneHeader from './FluxPaneHeader.vue';
+    import { useTranslate } from '~flux/components/composable/private';
     import FluxPrimaryButton from './FluxPrimaryButton.vue';
     import FluxSecondaryButton from './FluxSecondaryButton.vue';
-    import FluxSpacer from './FluxSpacer.vue';
+    import { DialogLayout } from './primitive';
 
     defineProps<{
         readonly confirm: FluxConfirmObject;

package/src/component/FluxContainer.vue

@@ -1,23 +1,26 @@
 <template>
-    <div
+    <Component
+        :is="tag ?? 'div'"
         :class="$style.container"
         :style="{'--gutter': `${gutter}px`}">
         <slot/>
-    </div>
+    </Component>
 </template>
 
 <script
     lang="ts"
     setup>
-    import $style from '$flux/css/component/Layout.module.scss';
+    import type { VNode } from 'vue';
+    import $style from '~flux/components/css/component/Layout.module.scss';
 
     const {
-        gutter = 30
+        gutter = 18
     } = defineProps<{
         readonly gutter?: number;
+        readonly tag?: keyof HTMLElementTagNameMap;
     }>();
 
     defineSlots<{
-        default(): any;
+        default(): VNode[];
     }>();
 </script>