2 Commits

Author SHA1 Message Date
Elijah Duffy
bac5218466 1.1.0 2026-03-10 17:26:10 -07:00
Elijah Duffy
465cfe2c14 combobox: use popover attachment to manage positioning 2026-03-10 17:25:46 -07:00
4 changed files with 21 additions and 88 deletions

View File

@@ -4,7 +4,7 @@
"type": "git", "type": "git",
"url": "https://gitea.auvem.com/svelte-toolkit/sui.git" "url": "https://gitea.auvem.com/svelte-toolkit/sui.git"
}, },
"version": "1.1.1", "version": "1.1.0",
"scripts": { "scripts": {
"dev": "vite dev", "dev": "vite dev",
"build": "vite build && pnpm run prepack", "build": "vite build && pnpm run prepack",

View File

@@ -247,6 +247,7 @@
highlighted = value; // reset highlighted item to current value highlighted = value; // reset highlighted item to current value
} }
console.log('combobox open', isOpen);
onopenchange?.(isOpen); onopenchange?.(isOpen);
} }
}); });

View File

@@ -5,8 +5,6 @@
export interface DialogAPI { export interface DialogAPI {
/** shows an error message at the top of the dialog */ /** shows an error message at the top of the dialog */
error: (message: RawError | null) => void; error: (message: RawError | null) => void;
/** Returns if the dialog is displaying an error */
hasError: () => boolean;
/** closes the dialog */ /** closes the dialog */
close: () => void; close: () => void;
/** opens the dialog */ /** opens the dialog */
@@ -41,8 +39,6 @@
* changes made via this API will NOT propagate to consuming components. * changes made via this API will NOT propagate to consuming components.
*/ */
title: (title: string) => void; title: (title: string) => void;
/** Focuses the dialog */
focus: () => void;
} }
type DialogControlButton = { type DialogControlButton = {
@@ -83,9 +79,6 @@
}; };
export { dialogCancelButton, dialogOkButton, dialogCloseButton }; export { dialogCancelButton, dialogOkButton, dialogCloseButton };
/** stack of currently open dialogs by identifier */
let dialogStack: DialogAPI[] = $state([]);
</script> </script>
<script lang="ts"> <script lang="ts">
@@ -98,7 +91,7 @@
import { X } from 'phosphor-svelte'; import { X } from 'phosphor-svelte';
import { ErrorMessage, type RawError } from './error'; import { ErrorMessage, type RawError } from './error';
import ErrorBox from './ErrorBox.svelte'; import ErrorBox from './ErrorBox.svelte';
import { generateIdentifier, mergeOverrideObject } from './util'; import { mergeOverrideObject } from './util';
interface Props { interface Props {
/** Bindable open state of the dialog */ /** Bindable open state of the dialog */
@@ -119,18 +112,10 @@
controlsAlign?: 'start' | 'center' | 'end'; controlsAlign?: 'start' | 'center' | 'end';
/** Top-right close control */ /** Top-right close control */
close?: Snippet | Omit<DialogControlButton, 'label'> | null; close?: Snippet | Omit<DialogControlButton, 'label'> | null;
/** /** Callback when the dialog is opened */
* Callback when the dialog is opened
* @deprecated use onopenchange instead and check the open parameter
*/
onopen?: (dialog: DialogAPI) => void; onopen?: (dialog: DialogAPI) => void;
/** /** Callback when the dialog is closed */
* Callback when the dialog is closed
* @deprecated use onopenchange instead and check the open parameter
*/
onclose?: (dialog: DialogAPI) => void; onclose?: (dialog: DialogAPI) => void;
/** Callback when the dialog open state changes */
onopenchange?: ({ open, dialog }: { open: boolean; dialog: DialogAPI }) => void;
/** If default controls are used, controls loading state of submit button */ /** If default controls are used, controls loading state of submit button */
loading?: boolean; loading?: boolean;
/** If default controls are used, freezes all interactions */ /** If default controls are used, freezes all interactions */
@@ -151,68 +136,34 @@
close = {}, close = {},
onopen, onopen,
onclose, onclose,
onopenchange,
loading = $bindable(false), loading = $bindable(false),
frozen = $bindable(false), frozen = $bindable(false),
disabled = $bindable(false) disabled = $bindable(false)
}: Props = $props(); }: Props = $props();
const controls = $derived( let controls = $derived(
typeof rawControls === 'function' typeof rawControls === 'function'
? rawControls ? rawControls
: mergeOverrideObject(defaultDialogControls, rawControls) : mergeOverrideObject(defaultDialogControls, rawControls)
); );
const identifier = generateIdentifier('dialog');
let lastOpen = $state(open);
let dialogPage = $state<HTMLDivElement | null>(null);
let dialogContainer = $state<HTMLDivElement | null>(null); let dialogContainer = $state<HTMLDivElement | null>(null);
let error = $state<ErrorMessage | null>(null); let error = $state<ErrorMessage | null>(null);
let stackIndex = $state(-1);
/** handles open change */ // disable window scroll when dialog is open
const handleOpenChange = (localOpen: boolean) => {
if (localOpen) {
document.body.style.overflow = 'hidden'; // prevent scrolling
// focus the dialog BEFORE callbacks for accessibility & flexibility
dialogPage?.focus();
// run callbacks
onopen?.(dialogAPI);
onopenchange?.({ open: true, dialog: dialogAPI });
//update stack
dialogStack.push(dialogAPI); // add to stack of open dialogs
stackIndex = dialogStack.length - 1; // track index in stack for this dialog
} else {
// update stack
dialogStack.pop(); // remove from stack of open dialogs
stackIndex = -1; // reset stack index for this dialog
// update focus & handle scroll locking for accessibility
if (dialogStack.length > 0) {
dialogStack[dialogStack.length - 1].focus();
} else {
document.body.style.overflow = ''; // re-enable scrolling since no dialogs are open
}
// run callbacks
onclose?.(dialogAPI);
onopenchange?.({ open: false, dialog: dialogAPI });
}
};
// deduplicate open changes
$effect(() => { $effect(() => {
if (open !== untrack(() => lastOpen)) { if (open) {
lastOpen = open; document.body.style.overflow = 'hidden';
untrack(() => { untrack(() => onopen?.(dialogAPI));
handleOpenChange(open); } else {
}); document.body.style.overflow = '';
untrack(() => onclose?.(dialogAPI));
} }
}); });
/** DialogAPI instance to control this dialog */ /** DialogAPI instance to control this dialog */
export const dialogAPI: DialogAPI = { export const dialogAPI: DialogAPI = {
error: (message) => (error = ErrorMessage.from(message)), error: (message) => (error = ErrorMessage.from(message)),
hasError: () => error !== null,
close: () => (open = false), close: () => (open = false),
open: () => (open = true), open: () => (open = true),
isOpen: () => open, isOpen: () => open,
@@ -226,8 +177,7 @@
unfreeze: () => (frozen = false), unfreeze: () => (frozen = false),
isFrozen: () => frozen, isFrozen: () => frozen,
canContinue: () => !loading && !disabled && !frozen, canContinue: () => !loading && !disabled && !frozen,
title: (newTitle) => (title = newTitle), title: (newTitle) => (title = newTitle)
focus: () => dialogPage?.focus()
}; };
/** Returns the current state of the dialog */ /** Returns the current state of the dialog */
@@ -249,14 +199,11 @@
{#snippet dialog()} {#snippet dialog()}
<div <div
bind:this={dialogPage}
class={[ class={[
'fixed inset-0 flex items-center-safe justify-center bg-black/50 backdrop-blur-sm', 'fixed inset-0 z-50 flex items-center-safe justify-center bg-black/50 backdrop-blur-sm',
'overflow-auto p-8', 'overflow-auto p-8',
classValue classValue
]} ]}
style={// increase z-index and decrease opacity for each nested dialog
`z-index: ${1000 + stackIndex}`}
transition:fade={{ duration: 150 }} transition:fade={{ duration: 150 }}
onclick={(e) => { onclick={(e) => {
const target = e.target as HTMLElement; const target = e.target as HTMLElement;
@@ -265,15 +212,10 @@
}} }}
onkeydown={(e) => { onkeydown={(e) => {
if (e.key === 'Escape' && !frozen) { if (e.key === 'Escape' && !frozen) {
if (stackIndex === dialogStack.length - 1) {
// only close if this dialog is the topmost dialog
open = false; open = false;
} }
}
}} }}
role="dialog" role="dialog"
aria-labelledby="{identifier}-title"
aria-describedby="{identifier}-description"
tabindex="-1" tabindex="-1"
> >
<div <div
@@ -293,10 +235,7 @@
> >
<div class="flex items-center justify-between"> <div class="flex items-center justify-between">
<!-- Dialog title --> <!-- Dialog title -->
<h2 <h2 class="pointer-events-none mb-2 text-lg font-medium text-black select-none">
class="pointer-events-none mb-2 text-lg font-medium text-black select-none"
id="{identifier}-title"
>
{@render stringOrSnippet(title)} {@render stringOrSnippet(title)}
</h2> </h2>
@@ -315,7 +254,7 @@
{/if} {/if}
{#if description} {#if description}
<p class="mb-3 leading-normal text-zinc-600" id="{identifier}-description"> <p class="mb-3 leading-normal text-zinc-600">
{@render stringOrSnippet(description)} {@render stringOrSnippet(description)}
</p> </p>
{/if} {/if}

View File

@@ -35,7 +35,8 @@
import { createLazyComponent, type ComboboxOption, type Option } from '$lib'; import { createLazyComponent, type ComboboxOption, type Option } from '$lib';
import Tabs from '$lib/Tabs.svelte'; import Tabs from '$lib/Tabs.svelte';
import { Time } from '@internationalized/date'; import { Time } from '@internationalized/date';
import { onMount } from 'svelte'; import { onMount, type Component } from 'svelte';
import ErrorBox from '$lib/ErrorBox.svelte';
import TextareaInput from '$lib/TextareaInput.svelte'; import TextareaInput from '$lib/TextareaInput.svelte';
import DurationInput, { formatDuration } from '$lib/DurationInput.svelte'; import DurationInput, { formatDuration } from '$lib/DurationInput.svelte';
import Banner from '$lib/Banner.svelte'; import Banner from '$lib/Banner.svelte';
@@ -59,7 +60,6 @@
let dateInputValue = $state<CalendarDate | null>(null); let dateInputValue = $state<CalendarDate | null>(null);
let checkboxValue = $state<CheckboxState>('indeterminate'); let checkboxValue = $state<CheckboxState>('indeterminate');
let dialogOpen = $state(false); let dialogOpen = $state(false);
let nestedDialogOpen = $state(false);
let scrollableDialogOpen = $state(false); let scrollableDialogOpen = $state(false);
let toggleOptions: Option[] = $state([ let toggleOptions: Option[] = $state([
'item one', 'item one',
@@ -218,7 +218,7 @@
label="Lazy combobox" label="Lazy combobox"
placeholder="Choose..." placeholder="Choose..."
options={lazyOptions} options={lazyOptions}
lazy="always" lazy={'always'}
onlazy={async () => { onlazy={async () => {
await new Promise((resolve) => setTimeout(resolve, 2500)); await new Promise((resolve) => setTimeout(resolve, 2500));
lazyOptions = [ lazyOptions = [
@@ -555,13 +555,6 @@
}} }}
> >
<p>This is a dialog content area.</p> <p>This is a dialog content area.</p>
<Button onclick={() => (nestedDialogOpen = true)}>Open Nested Dialog</Button>
</Dialog>
<!-- Nested Dialog Demo -->
<Dialog bind:open={nestedDialogOpen} title="Nested Dialog" size="sm">
<p>This is a nested dialog content area.</p>
</Dialog> </Dialog>
<!-- Scrollable Dialog Demo --> <!-- Scrollable Dialog Demo -->