frontend-component

Frontend Component Rules

File Organization

• Frontend code lives in frontend/src/.
• Test code lives in frontend/tests/.
• Generated backend API code is in frontend/src/generated/backend.

Core Technologies

• Vue 3 with TypeScript.
• DaisyUI + Tailwind for styling: unprefixed Tailwind utilities (flex, text-primary, …) and daisy--prefixed DaisyUI component classes (daisy-btn, daisy-card, …).
• Vitest for testing with Playwright browser mode.
• Biome for linting and formatting.

Icons

• Prefer Lucide for normal UI icons via @lucide/vue (import { IconName } from "@lucide/vue"). Import only the icons each file needs; rely on currentColor so icons follow text/theme color.
• @lucide/vue defaults to 24x24 via the size prop. Use :size="..." and/or Tailwind w-*, h-*, or size-* on icons.

Naming Conventions

• Component files should use PascalCase, for example NoteShow.vue or GlobalBar.vue.
• Test files should match component names with a .spec.ts suffix.
• Use .vue for components and .ts for TypeScript files.

Component Structure

<script setup lang="ts">
import { computed, onMounted, ref } from "vue"

const props = defineProps<{
  value: string
}>()
const emit = defineEmits<{
  (e: "update:value", value: string): void
}>()

const loading = ref(false)
const displayValue = computed(() => props.value.toUpperCase())

const handleClick = () => {
  emit("update:value", "new value")
}

onMounted(() => {
  // ...
})
</script>

<template>
  <div class="daisy-component">
    <!-- template content -->
  </div>
</template>

<style scoped lang="scss">
// scoped styles
</style>

Modals And Dialogs

• Use Modal from @/components/commons/Modal.vue for modal overlays. It wraps a native <dialog> teleported to body and centralizes stacking, ESC, backdrop click, and route-change close. The dim background is the native ::backdrop pseudo-element.
• Put panel content in #body, optionally #header. Listen for @close_request to hide the modal, such as parent v-if or clearing model state. The overlay X is optional via showCloseButton on Modal.
• Use v-if on Modal when the dialog opens, or keep Modal mounted and drive visibility from props; wire close_request and cancel buttons to the same close handler.
• Layout variants: alignTop pins the panel to the top of the viewport, sidebar="left" | "right" renders a full-height side panel. Use isPopup for nested popups via usePopups so they do not participate in the ESC modal stack.
• In tests, the dialog renders inside document.body. Query the DOM via document.querySelector("dialog"), .close-button, .modal-container, .modal-sidebar, or .modal-mask, not the dialog's internal layout wrapper.