chore: add documentation for svelte components

This commit is contained in:
Ilia Mashkov
2026-01-02 21:15:40 +03:00
parent bf36f8e642
commit 1bb699ea2d
6 changed files with 85 additions and 12 deletions

View File

@@ -1,4 +1,14 @@
<script lang="ts">
/**
* App Component
*
* Application entry point component. Wraps the main page route within the shared
* layout shell. This is the root component mounted by the application.
*
* Structure:
* - Layout provides sidebar, header/footer, and page container
* - Page renders the current route content
*/
import Page from '$routes/Page.svelte';
import Layout from './ui/Layout.svelte';
</script>

View File

@@ -1,8 +1,23 @@
<script lang="ts">
/**
* Layout Component
*
* Root layout wrapper that provides the application shell structure. Handles favicon,
* sidebar provider initialization, and renders child routes with consistent structure.
*
* Layout structure:
* - Header area (currently empty, reserved for future use)
* - Collapsible sidebar with main content area
* - Footer area (currently empty, reserved for future use)
*
* Uses Sidebar.Provider to enable mobile-responsive collapsible sidebar behavior
* throughout the application.
*/
import favicon from '$shared/assets/favicon.svg';
import * as Sidebar from '$shared/shadcn/ui/sidebar/index';
import { AppSidebar } from '$widgets/AppSidebar';
/** Slot content for route pages to render */
let { children } = $props();
</script>

View File

@@ -1,4 +1,13 @@
<script>
/**
* Page Component
*
* Main page route component. This is the default route that users see when
* accessing the application. Currently displays a welcome message.
*
* Note: This is a placeholder component. Replace with actual application content
* as the font comparison and filtering features are implemented.
*/
</script>
<h1>Welcome to Svelte + Vite</h1>

View File

@@ -1,4 +1,16 @@
<script lang="ts">
/**
* AppSidebar Component
*
* Main application sidebar widget. Contains filter controls and action buttons
* for font filtering operations. Organized into two sections:
*
* - Filters: Category-based filter groups (providers, subsets, categories)
* - Controls: Apply/Reset buttons for filter actions
*
* Uses Sidebar.Root from shadcn for responsive sidebar behavior including
* mobile drawer and desktop persistent sidebar modes.
*/
import * as Sidebar from '$shared/shadcn/ui/sidebar/index';
import Controls from './Controls.svelte';
import Filters from './Filters.svelte';

View File

@@ -1,4 +1,15 @@
<script lang="ts">
/**
* Controls Component
*
* Action button group for filter operations. Provides two buttons:
*
* - Reset: Clears all active filters (outline variant for secondary action)
* - Apply: Applies selected filters (primary variant for main action)
*
* Buttons are equally sized (flex-1) for balanced layout. Note:
* Functionality not yet implemented - wire up to filter stores.
*/
import { Button } from '$shared/shadcn/ui/button';
</script>

View File

@@ -1,26 +1,42 @@
<script lang="ts">
/**
* Filters Component
*
* Orchestrates all filter properties for the sidebar. Connects filter stores
* to CheckboxFilter components, organizing them by filter type:
*
* - Font provider: Google Fonts vs Fontshare
* - Font subset: Character subsets available (Latin, Latin Extended, etc.)
* - Font category: Serif, Sans-serif, Display, etc.
*
* Uses $derived for reactive access to filter states, ensuring UI updates
* when selections change through any means (sidebar, programmatically, etc.).
*/
import { categoryFilterStore } from '$features/CategoryFilter';
import { providersFilterStore } from '$features/ProvidersFilter';
import { subsetsFilterStore } from '$features/SubsetsFilter';
import CheckboxFilter from '$shared/ui/CheckboxFilter/CheckboxFilter.svelte';
const { categories: providers } = $derived($providersFilterStore);
const { categories: subsets } = $derived($subsetsFilterStore);
const { categories } = $derived($categoryFilterStore);
/** Reactive properties from providers filter store */
const { properties: providers } = $derived($providersFilterStore);
/** Reactive properties from subsets filter store */
const { properties: subsets } = $derived($subsetsFilterStore);
/** Reactive properties from categories filter store */
const { properties: categories } = $derived($categoryFilterStore);
</script>
<CheckboxFilter
filterName="Font provider"
categories={providers}
onCategoryToggle={providersFilterStore.toggleCategory}
displayedLabel="Font provider"
properties={providers}
onPropertyToggle={providersFilterStore.toggleProperty}
/>
<CheckboxFilter
filterName="Font subset"
categories={subsets}
onCategoryToggle={subsetsFilterStore.toggleCategory}
displayedLabel="Font subset"
properties={subsets}
onPropertyToggle={subsetsFilterStore.toggleProperty}
/>
<CheckboxFilter
filterName="Font category"
categories={categories}
onCategoryToggle={categoryFilterStore.toggleCategory}
displayedLabel="Font category"
properties={categories}
onPropertyToggle={categoryFilterStore.toggleProperty}
/>