@volverjs/ui-vue 0.0.6-beta.2 → 0.0.6-beta.4

package/src/components/VvAvatarGroup/VvAvatarGroup.vue

@@ -17,7 +17,7 @@
 	})
 
 	const avatarItems = computed(() => {
-		return items.value.slice(0, toShow.value).map((item, index) => {
+		return items.value.slice(0, toShow.value).map((item) => {
 			let modifiers: string[] = []
 			let itemModifiers: string[] = []
 
@@ -35,7 +35,7 @@
 
 			return {
 				...item,
-				key: item.key || `${index}_${new Date().getTime()}`,
+				key: item.key || useUniqueId().value,
 				modifiers: [...modifiers, ...itemModifiers],
 			}
 		})

package/src/components/VvNav/VvNav.vue

@@ -0,0 +1,66 @@
+<script setup lang="ts">
+	import { VvNavProps, VvNavEvents, type NavItem } from '@/components/VvNav'
+	import VvAction from '@/components/VvAction/VvAction.vue'
+
+	const props = defineProps(VvNavProps)
+	const emit = defineEmits(VvNavEvents)
+	const { modifiers, items } = toRefs(props)
+	const activeItem: Ref<string | null> = ref(null)
+
+	// bem css classes
+	const bemCssClasses = useModifiers('vv-nav', modifiers)
+
+	const localItems = computed(() => {
+		return items.value.map((item, index) => {
+			return {
+				...item,
+				id: item.id || `nav-item_${index}`,
+			}
+		})
+	})
+
+	/**
+	 * Triggers when the item is clicked.
+	 * @private
+	 * @event click
+	 * @param [NavItem, string] item - the clicked item
+	 */
+	function onClick(item: NavItem) {
+		if (!item.disabled) {
+			emit('click', item)
+			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			activeItem.value = item.id!
+		}
+	}
+</script>
+
+<template>
+	<nav :class="bemCssClasses">
+		<ul class="vv-nav__menu" role="menu" aria-busy="true">
+			<li
+				v-for="navItem in localItems"
+				:key="navItem.id"
+				class="vv-nav__item"
+				role="presentation"
+			>
+				<VvAction
+					v-bind="{
+						disabled: navItem.disabled,
+						to: navItem.to,
+						href: navItem.href,
+						tabindex: 0,
+					}"
+					:class="{
+						current: activeItem == navItem.id,
+						disabled: navItem.disabled,
+					}"
+					class="vv-nav__item-label"
+					v-on="navItem.on || {}"
+					@click="onClick(navItem)"
+				>
+					{{ navItem.title }}
+				</VvAction>
+			</li>
+		</ul>
+	</nav>
+</template>

package/src/components/VvNav/index.ts

@@ -0,0 +1,21 @@
+import { ModifiersProps } from '@/props'
+
+export type NavItem = {
+	id?: string
+	title: string
+	to?: string | { [key: string]: unknown }
+	href?: string
+	disabled?: boolean
+	on: () => void
+}
+
+export const VvNavProps = {
+	...ModifiersProps,
+	items: {
+		type: Array<NavItem>,
+		required: true,
+		default: () => [],
+	},
+}
+
+export const VvNavEvents = ['click']

package/src/components/VvNavItemTitle/VvNavItemTitle.vue

@@ -0,0 +1,11 @@
+<script setup lang="ts">
+	defineProps({
+		title: String,
+	})
+</script>
+
+<template>
+	<span class="vv-nav__heading-label" aria-hidden="true">
+		{{ title }}
+	</span>
+</template>

package/src/components/VvNavSeparator/VvNavSeparator.ts

@@ -0,0 +1,8 @@
+export default defineComponent({
+	render() {
+		return h('li', {
+			class: 'vv-nav__divider',
+			role: 'separator',
+		})
+	},
+})

package/src/components/VvTab/VvTab.vue

@@ -0,0 +1,53 @@
+<script setup lang="ts">
+	import { VvTabProps, VvTabEvents } from '@/components/VvTab'
+	import type { NavItem } from '@/components/VvNav'
+	import VvNav from '@/components/VvNav/VvNav.vue'
+
+	const props = defineProps(VvTabProps)
+	const emit = defineEmits(VvTabEvents)
+	const { modifiers, items } = toRefs(props)
+	const activeTab: Ref<string | null> = ref(null)
+
+	// bem css classes
+	const bemCssClasses = useModifiers('vv-tab', modifiers)
+
+	const localItems = computed(() => {
+		return items.value.map((item, index) => {
+			return {
+				...item,
+				id: item.id || `tab-item_${index}`,
+			}
+		})
+	})
+
+	/**
+	 * Triggers when the item is clicked.
+	 * @private
+	 * @event click
+	 * @param [NavItem, string] item - the clicked item
+	 */
+	function onClick(item: NavItem) {
+		if (!item.disabled) {
+			emit('click', item)
+			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+			activeTab.value = item.id!
+		}
+	}
+</script>
+
+<template>
+	<div :class="bemCssClasses">
+		<VvNav :items="localItems" modifiers="tabs full" @click="onClick" />
+		<!-- #region tab content -->
+		<article
+			v-for="item in localItems"
+			:id="item.id"
+			:key="item.id"
+			:class="{ target: activeTab === item.id }"
+			class="vv-tab__panel"
+		>
+			<slot :name="`${item.id}`" />
+		</article>
+		<!-- #endregion tab content -->
+	</div>
+</template>

package/src/components/VvTab/index.ts

@@ -0,0 +1,13 @@
+import { ModifiersProps } from '@/props'
+import type { NavItem } from '../VvNav'
+
+export const VvTabProps = {
+	...ModifiersProps,
+	items: {
+		type: Array<NavItem>,
+		required: true,
+		default: () => [],
+	},
+}
+
+export const VvTabEvents = ['click']

package/src/stories/Nav/Nav.settings.ts

@@ -0,0 +1,34 @@
+import { VvNavProps } from '@/components/VvNav'
+import { ModifiersArgTypes } from '@/stories/argTypes'
+
+export const defaultArgs = {
+	...propsToObject(VvNavProps),
+	items: [
+		{
+			title: 'Item 1',
+			href: 'javascript:void(0)',
+		},
+		{
+			title: 'Item 2',
+			to: 'about',
+		},
+		{
+			title: 'Item 3',
+			to: 'contacts',
+			on: {
+				click: () => {
+					// eslint-disable-next-line no-console
+					console.log('clicked Item 3')
+				},
+			},
+		},
+	],
+	modifiers: 'sidebar',
+}
+
+export const argTypes = {
+	modifiers: {
+		...ModifiersArgTypes.modifiers,
+		options: ['sidebar', 'aside', 'tabs', 'full'],
+	},
+}

package/src/stories/Nav/Nav.stories.mdx

@@ -0,0 +1,28 @@
+import { Meta, Story, Canvas } from '@storybook/addon-docs'
+import VvNav from '@/components/VvNav/VvNav.vue'
+import { defaultArgs, argTypes } from './Nav.settings'
+import { defaultTest } from './Nav.test'
+
+<Meta
+	title="Components/Nav"
+	component={VvNav}
+	args={defaultArgs}
+	argTypes={argTypes}
+/>
+
+export const Template = (args) => ({
+	components: { VvNav },
+	setup() {
+		return { args }
+	},
+	template: /* html */ `
+		<div class="m-md w-1/5">
+			<vv-nav v-bind="args" data-testId="element" />
+		</div>`,
+})
+
+<Canvas>
+	<Story name="Default" play={defaultTest}>
+		{Template.bind()}
+	</Story>
+</Canvas>

package/src/stories/Nav/Nav.test.ts

@@ -0,0 +1,32 @@
+import type { PlayAttributes } from '@/test/types'
+import { expect } from '@/test/expect'
+import { within, userEvent } from '@storybook/testing-library'
+
+export async function defaultTest({ canvasElement, args }: PlayAttributes) {
+	const element = (await within(canvasElement).findByTestId(
+		'element',
+	)) as HTMLElement
+
+	if (!args.items || !args.items?.length) {
+		throw new Error('No items passed')
+	}
+
+	// check children number the same of items prop
+	expect(element.children?.[0].children.length).toEqual(args.items?.length)
+
+	// take firse and second elements
+	const firstEl = await element.getElementsByTagName('a')?.[0]
+	const secondEl = await element.getElementsByTagName('router-link')?.[1]
+	// check they have not current class
+	const secondElHasCurrentClass = secondEl.classList.contains('current')
+	const firstElHasCurrentClass = firstEl.classList.contains('current')
+
+	await expect(firstElHasCurrentClass).toBe(false)
+	await expect(secondElHasCurrentClass).toBe(false)
+	// click first item and check "current" css class
+	await userEvent.click(firstEl)
+	await expect(firstEl).toHaveClass('current')
+
+	// check accessibility
+	await expect(element).toHaveNoViolations()
+}

package/src/stories/Nav/NavModifiers.stories.mdx

@@ -0,0 +1,48 @@
+import { Meta, Story, Canvas } from '@storybook/addon-docs'
+import VvNav from '@/components/VvNav/VvNav.vue'
+import { defaultArgs, argTypes } from './Nav.settings'
+import { defaultTest } from './Nav.test'
+import { Template } from './Nav.stories.mdx'
+
+<Meta
+	title="Components/Nav/Modifiers"
+	component={VvNav}
+	args={defaultArgs}
+	argTypes={argTypes}
+/>
+
+<Canvas>
+	<Story name="Sidebar" play={defaultTest} args={{ modifiers: 'sidebar' }}>
+		{Template.bind({})}
+	</Story>
+</Canvas>
+
+<Canvas>
+	<Story name="Aside" play={defaultTest} args={{ modifiers: 'aside' }}>
+		{Template.bind({})}
+	</Story>
+</Canvas>
+
+<Canvas>
+	<Story
+		name="Tabs"
+		play={defaultTest}
+		args={{
+			modifiers: 'tabs',
+		}}
+	>
+		{Template.bind({})}
+	</Story>
+</Canvas>
+
+<Canvas>
+	<Story
+		name="TabsFull"
+		play={defaultTest}
+		args={{
+			modifiers: 'tabs full',
+		}}
+	>
+		{Template.bind({})}
+	</Story>
+</Canvas>

package/src/stories/Tab/Tab.settings.ts

@@ -0,0 +1,41 @@
+import { VvTabProps } from '@/components/VvTab'
+
+export const defaultArgs = {
+	...propsToObject(VvTabProps),
+	items: [
+		{
+			title: 'Item 1',
+			href: 'javascript:void(0)',
+		},
+		{
+			title: 'Item 2',
+			to: 'about',
+		},
+		{
+			id: 'tab-3',
+			title: 'Item 3',
+			to: 'contacts',
+			on: {
+				click: () => {
+					// eslint-disable-next-line no-console
+					console.log('clicked Item 3')
+				},
+			},
+		},
+	],
+}
+
+export const defaultArgTypes = {
+	tabId: {
+		description: 'Slot by tab-id',
+		control: {
+			type: 'text',
+		},
+		table: {
+			category: 'Slots',
+			type: {
+				summary: 'html',
+			},
+		},
+	},
+}

package/src/stories/Tab/Tab.stories.mdx

@@ -0,0 +1,65 @@
+import { Meta, Story, Canvas } from '@storybook/addon-docs'
+import VvTab from '@/components/VvTab/VvTab.vue'
+import { defaultArgs, defaultArgTypes } from './Tab.settings'
+import { defaultTest } from './Tab.test'
+
+<Meta
+	title="Components/Tab"
+	component={VvTab}
+	args={defaultArgs}
+	argTypes={defaultArgTypes}
+/>
+
+export const Template = (args) => ({
+	components: { VvTab },
+	setup() {
+		return { args }
+	},
+	template: /* html */ `
+		<div class="m-md w-1/2">
+			<vv-tab v-bind="args" data-testId="element">
+				<template #tab-item_0>
+					<span class="text-20 font-semibold">Tab 1</span>
+					<p>
+						Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla
+						vitae elit libero, a pharetra augue. Nullam id dolor id nibh
+						ultricies vehicula ut id elit. Morbi leo risus, porta ac
+						consectetur ac, vestibulum at eros. Praesent commodo cursus
+						magna, vel scelerisque nisl consectetur et. Donec sed odio dui.
+						Donec ullamcorper nulla non metus auctor fringilla. Nulla vitae
+						elit libero, a pharetra augue.
+					</p>
+				</template>
+				<template #tab-item_1>
+					<span class="text-20 font-semibold">Tab 2</span>
+					<p>
+						Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla
+						vitae elit libero, a pharetra augue. Nullam id dolor id nibh
+						ultricies vehicula ut id elit. Morbi leo risus, porta ac
+						consectetur ac, vestibulum at eros. Praesent commodo cursus
+						magna, vel scelerisque nisl consectetur et. Donec sed odio dui.
+						Donec ullamcorper nulla non metus auctor fringilla. Nulla vitae
+						elit libero, a pharetra augue.
+					</p>
+				</template>
+				<template #tab-3>
+					<span class="text-20 font-semibold">Tab 3</span>
+					<p>
+						Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla
+						vitae elit libero, a pharetra augue. Nullam id dolor id nibh
+						ultricies vehicula ut id elit. Morbi leo risus, porta ac
+						consectetur ac, vestibulum at eros. Praesent commodo cursus
+						magna, vel scelerisque nisl consectetur et. Donec sed odio dui.
+						Donec ullamcorper nulla non metus auctor fringilla. Nulla vitae
+						elit libero, a pharetra augue.
+					</p>
+				</template>
+			</vv-tab>
+		</div>`,
+})
+
+<Canvas>
+	<Story name="Default" play={defaultTest}>
+		{Template.bind()}
+	</Story>
+</Canvas>

package/src/stories/Tab/Tab.test.ts

@@ -0,0 +1,37 @@
+import type { PlayAttributes } from '@/test/types'
+import { expect } from '@/test/expect'
+import { within, userEvent } from '@storybook/testing-library'
+
+export async function defaultTest({ canvasElement, args }: PlayAttributes) {
+	const element = (await within(canvasElement).findByTestId(
+		'element',
+	)) as HTMLElement
+
+	if (!args.items || !args.items?.length) {
+		throw new Error('No items passed')
+	}
+
+	// check children number the same of items prop
+	const childrenEls = element.getElementsByClassName('vv-nav')[0]
+	expect(childrenEls?.children[0].children.length).toEqual(args.items?.length)
+
+	// take firse and second elements
+	const firstEl = await element.getElementsByTagName('a')?.[0]
+	const secondEl = await element.getElementsByTagName('router-link')?.[1]
+	// check they have not current class
+	const secondElHasCurrentClass = secondEl.classList.contains('current')
+	const firstElHasCurrentClass = firstEl.classList.contains('current')
+
+	await expect(firstElHasCurrentClass).toBe(false)
+	await expect(secondElHasCurrentClass).toBe(false)
+	// click first item and check "current" css class
+	await userEvent.click(firstEl)
+	await expect(firstEl).toHaveClass('current')
+
+	// check tab content to include "Tab 1"
+	const tabPanelEl = element.getElementsByClassName('vv-tab__panel')?.[0]
+	await expect(tabPanelEl.innerHTML.includes('Tab 1')).toBe(true)
+
+	// check accessibility
+	await expect(element).toHaveNoViolations()
+}