n8n/packages/design-system/src/components/N8nUserStack/UserStack.vue
Milorad FIlipović 77bc8ecd4b
feat(editor): Show avatars for users currently working on the same workflow (#7763)
This PR introduces the following changes:
- New Vue stores: `collaborationStore` and `pushConnectionStore`
- Front-end push connection handling overhaul: Keep only a singe
connection open and handle it from the new store
- Add user avatars in the editor header when there are multiple users
working on the same workflow
- Sending a heartbeat event to back-end service periodically to confirm
user is still active

- Back-end overhauls (authored by @tomi):
  - Implementing a cleanup procedure that removes inactive users
  - Refactoring collaboration service current implementation

---------

Co-authored-by: Tomi Turtiainen <10324676+tomi@users.noreply.github.com>
2023-11-23 10:14:34 +01:00

188 lines
4.3 KiB
Vue

<script lang="ts" setup>
import type { IUser, UserStackGroups } from '@/types';
import N8nAvatar from '../N8nAvatar';
import N8nUserInfo from '../N8nUserInfo';
import type { PropType } from 'vue';
import { computed } from 'vue';
const props = defineProps({
users: {
type: Object as PropType<UserStackGroups>,
required: true,
},
currentUserEmail: {
type: String,
required: false,
default: '',
},
maxAvatars: {
type: Number,
default: 2,
validator: (value: number) => value > 0,
},
dropdownTrigger: {
type: String,
default: 'hover',
validator: (value: string) => ['hover', 'click'].includes(value),
},
});
const nonEmptyGroups = computed(() => {
const users: UserStackGroups = {};
for (const groupName in props.users) {
if (props.users[groupName].length > 0) {
users[groupName] = props.users[groupName];
}
}
return users;
});
const groupCount = computed(() => {
return Object.keys(nonEmptyGroups.value).length;
});
const flatUserList = computed(() => {
const users: IUser[] = [];
for (const groupName in props.users) {
users.push(...props.users[groupName]);
}
return users;
});
const visibleAvatarCount = computed(() => {
return flatUserList.value.length >= props.maxAvatars
? props.maxAvatars
: flatUserList.value.length;
});
const hiddenUsersCount = computed(() => {
return flatUserList.value.length - visibleAvatarCount.value;
});
const menuHeight = computed(() => {
return groupCount.value > 1 ? 220 : 190;
});
</script>
<template>
<div class="user-stack" data-test-id="user-stack-container">
<el-dropdown
:trigger="$props.dropdownTrigger"
:max-height="menuHeight"
popper-class="user-stack-popper"
>
<div :class="$style.avatars" data-test-id="user-stack-avatars">
<n8n-avatar
v-for="user in flatUserList.slice(0, visibleAvatarCount)"
:key="user.id"
:firstName="user.firstName"
:lastName="user.lastName"
:class="$style.avatar"
:data-test-id="`user-stack-avatar-${user.id}`"
size="small"
/>
<div v-if="hiddenUsersCount > 0" :class="$style.hiddenBadge">+{{ hiddenUsersCount }}</div>
</div>
<template #dropdown>
<el-dropdown-menu class="user-stack-list" data-test-id="user-stack-list">
<div v-for="(groupUsers, index) in nonEmptyGroups" :key="index">
<div :class="$style.groupContainer">
<el-dropdown-item>
<header v-if="groupCount > 1" :class="$style.groupName">{{ index }}</header>
</el-dropdown-item>
<div :class="$style.groupUsers">
<el-dropdown-item
v-for="user in groupUsers"
:key="user.id"
:data-test-id="`user-stack-info-${user.id}`"
>
<n8n-user-info
v-bind="user"
:isCurrentUser="user.email === props.currentUserEmail"
/>
</el-dropdown-item>
</div>
</div>
</div>
</el-dropdown-menu>
</template>
</el-dropdown>
</div>
</template>
<style lang="scss" module>
.avatars {
display: flex;
cursor: pointer;
}
.avatar {
margin-right: calc(-1 * var(--spacing-3xs));
user-select: none;
}
.hiddenBadge {
display: flex;
justify-content: center;
align-items: center;
width: 28px;
height: 28px;
color: var(--color-text-base);
background-color: var(--color-background-xlight);
font-weight: var(--font-weight-bold);
font-size: var(--font-size-3xs);
z-index: 999;
border: var(--border-width-base) var(--border-style-base) var(--color-info-tint-1);
border-radius: 50%;
}
.groupContainer {
display: flex;
flex-direction: column;
& + & {
margin-top: var(--spacing-3xs);
}
}
.groupName {
font-size: var(--font-size-3xs);
color: var(--color-text-light);
text-transform: uppercase;
font-weight: var(--font-weight-bold);
margin-bottom: var(--spacing-4xs);
}
.groupUsers {
display: flex;
flex-direction: column;
gap: var(--spacing-2xs);
}
</style>
<style lang="scss">
ul.user-stack-list {
border: none;
display: flex;
flex-direction: column;
gap: var(--spacing-s);
padding-bottom: var(--spacing-2xs);
.el-dropdown-menu__item {
line-height: var(--font-line-height-regular);
}
li:hover {
color: currentColor !important;
}
}
.user-stack-popper {
border: 1px solid var(--border-color-light);
border-radius: var(--border-radius-base);
padding: var(--spacing-5xs) 0;
box-shadow: 0px 2px 8px 0px #441c171a;
background-color: var(--color-background-xlight);
}
</style>