@abhivarde/svelte-drawer 0.0.1

package/README.md

@@ -0,0 +1,124 @@
+# Svelte Drawer
+
+A drawer component for Svelte 5, inspired by [Vaul](https://github.com/emilkowalski/vaul).
+
+## Features
+
+- ✅ Smooth animations using Svelte 5's Spring motion
+- ✅ Multiple directions (bottom, top, left, right)
+- ✅ Nested drawers support
+- ✅ Scrollable content
+- ✅ Fully accessible with keyboard navigation
+- ✅ TypeScript support
+- ✅ Customizable styling with Tailwind CSS
+
+## Installation
+
+```bash
+npm install @abhivarde/svelte-drawer
+```
+
+## Usage
+
+### Basic Example
+
+```svelte
+<script>
+	import { Drawer, DrawerOverlay, DrawerContent } from '@abhivarde/svelte-drawer';
+
+	let open = $state(false);
+</script>
+
+<button onclick={() => open = true}>
+	Open Drawer
+</button>
+
+<Drawer bind:open>
+	<DrawerOverlay class="fixed inset-0 bg-black/40" />
+	<DrawerContent class="fixed bottom-0 left-0 right-0 bg-white rounded-t-lg p-4">
+		<h2>Drawer Content</h2>
+		<p>This is a drawer component.</p>
+		<button onclick={() => open = false}>Close</button>
+	</DrawerContent>
+</Drawer>
+```
+
+### Side Drawer
+
+```svelte
+<script>
+	import { Drawer, DrawerOverlay, DrawerContent } from '@abhivarde/svelte-drawer';
+
+	let open = $state(false);
+</script>
+
+<Drawer bind:open direction="right">
+	<DrawerOverlay class="fixed inset-0 bg-black/40" />
+	<DrawerContent class="fixed right-0 top-0 bottom-0 w-80 bg-white p-4">
+		<h2>Side Drawer</h2>
+		<button onclick={() => open = false}>Close</button>
+	</DrawerContent>
+</Drawer>
+```
+
+### Controlled Drawer
+
+```svelte
+<script>
+	import { Drawer, DrawerOverlay, DrawerContent } from '@abhivarde/svelte-drawer';
+
+	let open = $state(false);
+
+	function handleOpenChange(isOpen) {
+		console.log('Drawer is now:', isOpen ? 'open' : 'closed');
+		open = isOpen;
+	}
+</script>
+
+<Drawer bind:open onOpenChange={handleOpenChange}>
+	<DrawerOverlay class="fixed inset-0 bg-black/40" />
+	<DrawerContent class="fixed bottom-0 left-0 right-0 bg-white rounded-t-lg p-4">
+		<h2>Controlled Drawer</h2>
+	</DrawerContent>
+</Drawer>
+```
+
+## API Reference
+
+### Drawer
+
+Main wrapper component that manages drawer state and animations.
+
+**Props:**
+
+- `open` (boolean, bindable) - Controls the open/closed state
+- `onOpenChange` (function, optional) - Callback when open state changes
+- `direction` ('bottom' | 'top' | 'left' | 'right', default: 'bottom') - Direction from which drawer slides
+
+### DrawerOverlay
+
+Overlay component that appears behind the drawer.
+
+**Props:**
+
+- `class` (string, optional) - CSS classes for styling
+
+### DrawerContent
+
+Content container for the drawer.
+
+**Props:**
+
+- `class` (string, optional) - CSS classes for styling
+
+## Demo
+
+Visit [drawer.abhivarde.in](https://drawer.abhivarde.in) to see live examples.
+
+## License
+
+MIT
+
+## Credits
+
+Inspired by [Vaul](https://github.com/emilkowalski/vaul) by Emil Kowalski.

package/dist/assets/favicon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="107" height="128" viewBox="0 0 107 128"><title>svelte-logo</title><path d="M94.157 22.819c-10.4-14.885-30.94-19.297-45.792-9.835L22.282 29.608A29.92 29.92 0 0 0 8.764 49.65a31.5 31.5 0 0 0 3.108 20.231 30 30 0 0 0-4.477 11.183 31.9 31.9 0 0 0 5.448 24.116c10.402 14.887 30.942 19.297 45.791 9.835l26.083-16.624A29.92 29.92 0 0 0 98.235 78.35a31.53 31.53 0 0 0-3.105-20.232 30 30 0 0 0 4.474-11.182 31.88 31.88 0 0 0-5.447-24.116" style="fill:#ff3e00"/><path d="M45.817 106.582a20.72 20.72 0 0 1-22.237-8.243 19.17 19.17 0 0 1-3.277-14.503 18 18 0 0 1 .624-2.435l.49-1.498 1.337.981a33.6 33.6 0 0 0 10.203 5.098l.97.294-.09.968a5.85 5.85 0 0 0 1.052 3.878 6.24 6.24 0 0 0 6.695 2.485 5.8 5.8 0 0 0 1.603-.704L69.27 76.28a5.43 5.43 0 0 0 2.45-3.631 5.8 5.8 0 0 0-.987-4.371 6.24 6.24 0 0 0-6.698-2.487 5.7 5.7 0 0 0-1.6.704l-9.953 6.345a19 19 0 0 1-5.296 2.326 20.72 20.72 0 0 1-22.237-8.243 19.17 19.17 0 0 1-3.277-14.502 17.99 17.99 0 0 1 8.13-12.052l26.081-16.623a19 19 0 0 1 5.3-2.329 20.72 20.72 0 0 1 22.237 8.243 19.17 19.17 0 0 1 3.277 14.503 18 18 0 0 1-.624 2.435l-.49 1.498-1.337-.98a33.6 33.6 0 0 0-10.203-5.1l-.97-.294.09-.968a5.86 5.86 0 0 0-1.052-3.878 6.24 6.24 0 0 0-6.696-2.485 5.8 5.8 0 0 0-1.602.704L37.73 51.72a5.42 5.42 0 0 0-2.449 3.63 5.79 5.79 0 0 0 .986 4.372 6.24 6.24 0 0 0 6.698 2.486 5.8 5.8 0 0 0 1.602-.704l9.952-6.342a19 19 0 0 1 5.295-2.328 20.72 20.72 0 0 1 22.237 8.242 19.17 19.17 0 0 1 3.277 14.503 18 18 0 0 1-8.13 12.053l-26.081 16.622a19 19 0 0 1-5.3 2.328" style="fill:#fff"/></svg>

package/dist/components/Drawer.svelte

@@ -0,0 +1,42 @@
+<script>
+	import { Spring } from 'svelte/motion';
+	import { setContext } from 'svelte';
+	
+	let {
+		open = $bindable(false),
+		onOpenChange = undefined,
+		direction = 'bottom',
+		children
+	} = $props();
+	
+	let overlayOpacity = new Spring(0, { stiffness: 0.32, damping: 0.72 });
+	let drawerPosition = new Spring(100, { stiffness: 0.32, damping: 0.72 });
+	
+	$effect(() => {
+		if (open) {
+			overlayOpacity.target = 1;
+			drawerPosition.target = 0;
+		} else {
+			overlayOpacity.target = 0;
+			drawerPosition.target = 100;
+		}
+	});
+	
+	function closeDrawer() {
+		open = false;
+		if (onOpenChange) {
+			onOpenChange(false);
+		}
+	}
+	
+	// Provide context to child components
+	setContext('drawer', {
+		get open() { return open; },
+		get overlayOpacity() { return overlayOpacity; },
+		get drawerPosition() { return drawerPosition; },
+		get direction() { return direction; },
+		closeDrawer
+	});
+</script>
+
+{@render children()}

package/dist/components/Drawer.svelte.d.ts

@@ -0,0 +1,17 @@
+export default Drawer;
+type Drawer = {
+    $on?(type: string, callback: (e: any) => void): () => void;
+    $set?(props: Partial<$$ComponentProps>): void;
+};
+declare const Drawer: import("svelte").Component<{
+    open?: boolean;
+    onOpenChange?: any;
+    direction?: string;
+    children: any;
+}, {}, "open">;
+type $$ComponentProps = {
+    open?: boolean;
+    onOpenChange?: any;
+    direction?: string;
+    children: any;
+};

package/dist/components/DrawerContent.svelte

@@ -0,0 +1,37 @@
+<script>
+	import { getContext } from 'svelte';
+	
+	let {
+		class: className = '',
+		children,
+		...restProps
+	} = $props();
+	
+	const drawer = getContext('drawer');
+	
+	function getTransform() {
+		const pos = drawer.drawerPosition.current;
+		switch (drawer.direction) {
+			case 'bottom':
+				return `translateY(${pos}%)`;
+			case 'top':
+				return `translateY(-${pos}%)`;
+			case 'left':
+				return `translateX(-${pos}%)`;
+			case 'right':
+				return `translateX(${pos}%)`;
+			default:
+				return `translateY(${pos}%)`;
+		}
+	}
+</script>
+
+{#if drawer.open}
+	<div
+		class={className}
+		style="transform: {getTransform()}; z-index: 50;"
+		{...restProps}
+	>
+		{@render children()}
+	</div>
+{/if}

package/dist/components/DrawerContent.svelte.d.ts

@@ -0,0 +1,13 @@
+export default DrawerContent;
+type DrawerContent = {
+    $on?(type: string, callback: (e: any) => void): () => void;
+    $set?(props: Partial<$$ComponentProps>): void;
+};
+declare const DrawerContent: import("svelte").Component<{
+    class?: string;
+    children: any;
+} & Record<string, any>, {}, "">;
+type $$ComponentProps = {
+    class?: string;
+    children: any;
+} & Record<string, any>;

package/dist/components/DrawerOverlay.svelte

@@ -0,0 +1,33 @@
+<script>
+	import { getContext } from 'svelte';
+	
+	let {
+		class: className = '',
+		...restProps
+	} = $props();
+	
+	const drawer = getContext('drawer');
+	
+	/**
+	 * @param {KeyboardEvent} e
+	 */
+	function handleKeydown(e) {
+		if (e.key === 'Enter' || e.key === ' ') {
+			e.preventDefault();
+			drawer.closeDrawer();
+		}
+	}
+</script>
+
+{#if drawer.open}
+	<div
+		class="fixed inset-0 bg-black/40 cursor-pointer {className}"
+		style="opacity: {drawer.overlayOpacity.current}; z-index: 40;"
+		onclick={drawer.closeDrawer}
+		onkeydown={handleKeydown}
+		role="button"
+		tabindex="0"
+		aria-label="Close drawer"
+		{...restProps}
+	></div>
+{/if}

package/dist/components/DrawerOverlay.svelte.d.ts

@@ -0,0 +1,11 @@
+export default DrawerOverlay;
+type DrawerOverlay = {
+    $on?(type: string, callback: (e: any) => void): () => void;
+    $set?(props: Partial<$$ComponentProps>): void;
+};
+declare const DrawerOverlay: import("svelte").Component<{
+    class?: string;
+} & Record<string, any>, {}, "">;
+type $$ComponentProps = {
+    class?: string;
+} & Record<string, any>;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { default as Drawer } from "./components/Drawer.svelte";
+export { default as DrawerOverlay } from "./components/DrawerOverlay.svelte";
+export { default as DrawerContent } from "./components/DrawerContent.svelte";
+export * from "./types";

package/dist/index.js

@@ -0,0 +1,4 @@
+export { default as Drawer } from "./components/Drawer.svelte";
+export { default as DrawerOverlay } from "./components/DrawerOverlay.svelte";
+export { default as DrawerContent } from "./components/DrawerContent.svelte";
+export * from "./types";

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+export interface DrawerProps {
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    direction?: "bottom" | "top" | "left" | "right";
+}
+export interface DrawerContentProps {
+    class?: string;
+}
+export interface DrawerOverlayProps {
+    class?: string;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@abhivarde/svelte-drawer",
+  "version": "0.0.1",
+  "description": "A drawer component for Svelte 5, inspired by Vaul",
+  "author": "Abhi Varde",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "dev": "vite dev",
+    "build": "vite build && npm run package",
+    "preview": "vite preview",
+    "package": "svelte-kit sync && svelte-package && publint",
+    "prepublishOnly": "npm run package",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+    "test": "npm run test:integration && npm run test:unit",
+    "lint": "prettier --check . && eslint .",
+    "format": "prettier --write ."
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "svelte": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
+  ],
+  "peerDependencies": {
+    "svelte": "^5.0.0"
+  },
+  "devDependencies": {
+    "@sveltejs/adapter-auto": "^7.0.0",
+    "@sveltejs/kit": "^2.49.1",
+    "@sveltejs/package": "^2.5.7",
+    "@sveltejs/vite-plugin-svelte": "^6.2.1",
+    "publint": "^0.2.12",
+    "svelte": "^5.45.6",
+    "svelte-check": "^4.3.4",
+    "typescript": "^5.9.3",
+    "vite": "^7.2.6"
+  },
+  "svelte": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "keywords": [
+    "svelte",
+    "svelte5",
+    "drawer",
+    "dialog",
+    "modal",
+    "sheet",
+    "component",
+    "ui"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AbhiVarde/svelte-drawer"
+  },
+  "bugs": {
+    "url": "https://github.com/AbhiVarde/svelte-drawer/issues"
+  },
+  "homepage": "https://drawer.abhivarde.in"
+}