10 Commits

Author SHA1 Message Date
Elijah Duffy
2c99c16b48 tabs: more configurable content padding options
choice between margin and padding. ngl, this feels kind of dumb, it
wasn't be problem and I don't know when it would ever be a problem.
perhaps i'll simplify or revert this later.
2026-03-15 22:03:59 -07:00
Elijah Duffy
ffe9c0369b tabs: separate controls for header and content padding 2026-03-15 21:52:01 -07:00
Elijah Duffy
622481a1ca dialog: add autofreeze to sync loading state
Enabled by default, autofreeze freezes the dialog whenever loading state
is enabled.
2026-03-15 15:58:44 -07:00
Elijah Duffy
ebdca97527 dialog: fix DialogState export 2026-03-15 13:03:39 -07:00
Elijah Duffy
bb27d0c9d7 dialog: pass state to snippet overrides 2026-03-15 12:58:28 -07:00
Elijah Duffy
ade904d0c9 1.1.2 2026-03-13 16:27:42 -07:00
Elijah Duffy
50c052a3c3 combobox: don't use portal for picker
fixes z-stacking issues when used within dialogs
2026-03-13 16:27:35 -07:00
Elijah Duffy
bcfd3ea740 dialog: add z-index to dialog api 2026-03-13 16:27:13 -07:00
Elijah Duffy
1844fa0096 1.1.1 2026-03-12 23:15:52 -07:00
Elijah Duffy
7c9a6398d4 dialog: support nesting/stacking & improve ergonomics
- stacked/nested dialogs work properly
- dialog api expanded to include `hasError` and `focus`
- `onopenchange` prop added, `onopen` and `onclose` deprecated
- improve accessibility with additional aria props
2026-03-12 23:15:08 -07:00
6 changed files with 193 additions and 95 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.0", "version": "1.1.2",
"scripts": { "scripts": {
"dev": "vite dev", "dev": "vite dev",
"build": "vite build && pnpm run prepack", "build": "vite build && pnpm run prepack",

View File

@@ -41,8 +41,7 @@
import Label from './Label.svelte'; import Label from './Label.svelte';
import StyledRawInput from './StyledRawInput.svelte'; import StyledRawInput from './StyledRawInput.svelte';
import { InputValidatorEvent, validate, type ValidatorOptions } from '@svelte-toolkit/validate'; import { InputValidatorEvent, validate, type ValidatorOptions } from '@svelte-toolkit/validate';
import { onMount, tick, untrack, type Snippet } from 'svelte'; import { untrack, type Snippet } from 'svelte';
import { Portal } from '@jsrob/svelte-portal';
import { scale } from 'svelte/transition'; import { scale } from 'svelte/transition';
import { generateIdentifier, type IconDef } from './util'; import { generateIdentifier, type IconDef } from './util';
import type { ClassValue, MouseEventHandler } from 'svelte/elements'; import type { ClassValue, MouseEventHandler } from 'svelte/elements';
@@ -502,54 +501,52 @@
<svelte:window onclick={handleWindowClick} /> <svelte:window onclick={handleWindowClick} />
<!-- Combobox picker --> <!-- Combobox picker -->
<Portal target="body"> {#if open}
{#if open} <!-- Picker container -->
<!-- Picker container --> <div
<div class={[
class={[ 'picker absolute top-0 left-0 z-50 overflow-y-auto px-2 py-3',
'picker absolute top-0 left-0 z-50 overflow-y-auto px-2 py-3', 'rounded-sm border shadow-lg shadow-black/25 outline-hidden',
'rounded-sm border shadow-lg shadow-black/25 outline-hidden', 'border-sui-accent dark:border-sui-accent/50 dark:bg-sui-text-800 bg-white dark:sm:bg-slate-800',
'border-sui-accent dark:border-sui-accent/50 dark:bg-sui-text-800 bg-white dark:sm:bg-slate-800', 'text-sui-text dark:text-sui-background',
'text-sui-text dark:text-sui-background', open && pickerPosition === 'top' && 'mb-[var(--outer-gap)]',
open && pickerPosition === 'top' && 'mb-[var(--outer-gap)]', open && pickerPosition === 'bottom' && 'mt-[var(--outer-gap)]'
open && pickerPosition === 'bottom' && 'mt-[var(--outer-gap)]' ]}
]} bind:this={pickerContainer}
bind:this={pickerContainer} transition:scale={{ duration: 200 }}
transition:scale={{ duration: 200 }} role="listbox"
role="listbox" onkeydown={(e) => {
onkeydown={(e) => { if (e.key === 'Escape') {
if (e.key === 'Escape') { popover.setOpen(false);
popover.setOpen(false); searchInput?.focus();
searchInput?.focus(); }
} }}
}} onscroll={(e) => {
onscroll={(e) => { if (!onscroll) return;
if (!onscroll) return; const target = e.target as HTMLDivElement;
const target = e.target as HTMLDivElement; if (!target) return;
if (!target) return;
const margin = 10; // 10px margin for top & bottom const margin = 10; // 10px margin for top & bottom
const atTop = target.scrollTop < margin; const atTop = target.scrollTop < margin;
const atBottom = target.scrollTop + target.clientHeight > target.scrollHeight - margin; const atBottom = target.scrollTop + target.clientHeight > target.scrollHeight - margin;
onscroll({ event: e, top: atTop, bottom: atBottom, searchInput: searchInput?.value ?? '' }); onscroll({ event: e, top: atTop, bottom: atBottom, searchInput: searchInput?.value ?? '' });
}} }}
tabindex="0" tabindex="0"
{@attach minWidth({ options, mode: pickerWidth, matchElem: searchInput })} {@attach minWidth({ options, mode: pickerWidth, matchElem: searchInput })}
{...popover.floating()} {...popover.floating()}
> >
{#each filteredItems as opt (opt.value)} {#each filteredItems as opt (opt.value)}
{@render option(opt)} {@render option(opt)}
{:else}
<!-- Display loading state or not found if no options available -->
{#if loading}
{@render option(loadingOption, true)}
{:else} {:else}
<!-- Display loading state or not found if no options available --> {@render option(notFoundOption, true)}
{#if loading} {/if}
{@render option(loadingOption, true)} {/each}
{:else} </div>
{@render option(notFoundOption, true)} {/if}
{/if}
{/each}
</div>
{/if}
</Portal>
<!-- Combobox main input container --> <!-- Combobox main input container -->
<div class={classValue}> <div class={classValue}>

View File

@@ -5,6 +5,8 @@
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 */
@@ -39,6 +41,16 @@
* 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;
/** Returns the stack index for this dialog */
stackIndex: () => number;
/**
* Returns the z-index of this dialog, where each incremental stack
* index increases the z-index by 100 starting from 1000. This can be
* used to layer custom elements on top of and within the dialog.
*/
zIndex: () => number;
} }
type DialogControlButton = { type DialogControlButton = {
@@ -64,9 +76,9 @@
/** /**
* Stores internal state of the dialog, everything necessary to render * Stores internal state of the dialog, everything necessary to render
* internal snippets. * internal and override capable snippets.
*/ */
type DialogState = { export type DialogState = {
frozen: boolean; frozen: boolean;
loading: boolean; loading: boolean;
disabled: boolean; disabled: boolean;
@@ -79,6 +91,9 @@
}; };
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">
@@ -91,15 +106,15 @@
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 { mergeOverrideObject } from './util'; import { generateIdentifier, mergeOverrideObject } from './util';
interface Props { interface Props {
/** Bindable open state of the dialog */ /** Bindable open state of the dialog */
open?: boolean; open?: boolean;
/** Title of the dialog */ /** Title of the dialog */
title: string | Snippet; title: string | Snippet<[state: DialogState]>;
/** Description of the dialog, optionally rendered below the title */ /** Description of the dialog, optionally rendered below the title */
description?: string | Snippet; description?: string | Snippet<[state: DialogState]>;
/** Size of the dialog (default: 'sm') */ /** Size of the dialog (default: 'sm') */
size?: 'sm' | 'md' | 'lg' | 'max'; size?: 'sm' | 'md' | 'lg' | 'max';
/** Additional classes for the dialog */ /** Additional classes for the dialog */
@@ -107,19 +122,29 @@
/** Content of the dialog */ /** Content of the dialog */
children?: Snippet; children?: Snippet;
/** Bottom controls for the dialog */ /** Bottom controls for the dialog */
controls?: Snippet | DialogControls; controls?: Snippet<[state: DialogState]> | DialogControls;
/** Sets bottom alignment of controls (default: end) */ /** Sets bottom alignment of controls (default: end) */
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 preventing user input */
frozen?: boolean; frozen?: boolean;
/** If enabled, automatically freezes dialog when loading (default: true) */
autoFreeze?: boolean;
/** If default controls are used, disables submit button */ /** If default controls are used, disables submit button */
disabled?: boolean; disabled?: boolean;
} }
@@ -136,34 +161,72 @@
close = {}, close = {},
onopen, onopen,
onclose, onclose,
onopenchange,
loading = $bindable(false), loading = $bindable(false),
frozen = $bindable(false), frozen = $bindable(false),
autoFreeze = true,
disabled = $bindable(false) disabled = $bindable(false)
}: Props = $props(); }: Props = $props();
let controls = $derived( const 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);
const zIndex = $derived(1000 + stackIndex * 100);
// disable window scroll when dialog is open const reallyFrozen = $derived(autoFreeze ? frozen || loading : frozen);
$effect(() => {
if (open) { /** handles open change */
document.body.style.overflow = 'hidden'; const handleOpenChange = (localOpen: boolean) => {
untrack(() => onopen?.(dialogAPI)); 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 { } else {
document.body.style.overflow = ''; // update stack
untrack(() => onclose?.(dialogAPI)); 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(() => {
if (open !== untrack(() => lastOpen)) {
lastOpen = open;
untrack(() => {
handleOpenChange(open);
});
} }
}); });
/** 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,
@@ -177,13 +240,16 @@
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(),
stackIndex: () => stackIndex,
zIndex: () => zIndex
}; };
/** Returns the current state of the dialog */ /** Returns the current state of the dialog */
export const getState = (): DialogState => { export const getState = (): DialogState => {
return { return {
frozen, frozen: reallyFrozen,
loading, loading,
disabled, disabled,
api: dialogAPI api: dialogAPI
@@ -199,23 +265,31 @@
{#snippet dialog()} {#snippet dialog()}
<div <div
bind:this={dialogPage}
class={[ class={[
'fixed inset-0 z-50 flex items-center-safe justify-center bg-black/50 backdrop-blur-sm', 'fixed inset-0 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: ${zIndex}`}
transition:fade={{ duration: 150 }} transition:fade={{ duration: 150 }}
onclick={(e) => { onclick={(e) => {
const target = e.target as HTMLElement; const target = e.target as HTMLElement;
if (open && !frozen && !dialogContainer?.contains(target) && target !== dialogContainer) if (open && !reallyFrozen && !dialogContainer?.contains(target) && target !== dialogContainer)
open = false; open = false;
}} }}
onkeydown={(e) => { onkeydown={(e) => {
if (e.key === 'Escape' && !frozen) { if (e.key === 'Escape' && !reallyFrozen) {
open = false; if (stackIndex === dialogStack.length - 1) {
// only close if this dialog is the topmost dialog
open = false;
}
} }
}} }}
role="dialog" role="dialog"
aria-labelledby="{identifier}-title"
aria-describedby="{identifier}-description"
tabindex="-1" tabindex="-1"
> >
<div <div
@@ -235,7 +309,10 @@
> >
<div class="flex items-center justify-between"> <div class="flex items-center justify-between">
<!-- Dialog title --> <!-- Dialog title -->
<h2 class="pointer-events-none mb-2 text-lg font-medium text-black select-none"> <h2
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>
@@ -254,7 +331,7 @@
{/if} {/if}
{#if description} {#if description}
<p class="mb-3 leading-normal text-zinc-600"> <p class="mb-3 leading-normal text-zinc-600" id="{identifier}-description">
{@render stringOrSnippet(description)} {@render stringOrSnippet(description)}
</p> </p>
{/if} {/if}
@@ -270,7 +347,9 @@
controlsAlign === 'end' && 'justify-end' controlsAlign === 'end' && 'justify-end'
]} ]}
> >
{#if controls && typeof controls === 'function'}{@render controls()}{:else if controls?.flip} {#if controls && typeof controls === 'function'}{@render controls(
getState()
)}{:else if controls?.flip}
{#if controls.ok !== null} {#if controls.ok !== null}
{@render dialogOkButton(getState(), controls.ok)} {@render dialogOkButton(getState(), controls.ok)}
{/if} {/if}
@@ -300,7 +379,7 @@
state.api.close(); state.api.close();
} }
}} }}
disabled={state.frozen} disabled={state.frozen || state.disabled}
> >
{opts?.label || 'Cancel'} {opts?.label || 'Cancel'}
</Button> </Button>
@@ -345,10 +424,10 @@
</button> </button>
{/snippet} {/snippet}
{#snippet stringOrSnippet(val: string | Snippet)} {#snippet stringOrSnippet(val: string | Snippet<[state: DialogState]>)}
{#if typeof val === 'string'} {#if typeof val === 'string'}
{val} {val}
{:else} {:else}
{@render val()} {@render val(getState())}
{/if} {/if}
{/snippet} {/snippet}

View File

@@ -23,12 +23,22 @@
activeIndex?: number; activeIndex?: number;
/** Callback fired when the active tab changes */ /** Callback fired when the active tab changes */
onchange?: (event: { index: number; tab: TabPage }) => void; onchange?: (event: { index: number; tab: TabPage }) => void;
/** Applies layout padding to the tab header & content areas (default: false) */ /** Applies layout padding to the tab header (default: false) */
padded?: boolean; padHeader?: boolean;
/** Applies layout padding to the content areas (default: false) */
padContent?: 'padding' | 'margin' | 'none';
/** Additional classes applied to the outer container */
class?: ClassValue | null; class?: ClassValue | null;
} }
let { pages, activeIndex = 0, onchange, padded = false, class: classValue }: Props = $props(); let {
pages,
activeIndex = 0,
onchange,
padHeader = false,
padContent = 'none',
class: classValue
}: Props = $props();
let primaryContainerEl: HTMLDivElement; let primaryContainerEl: HTMLDivElement;
let tabContainerEl: HTMLDivElement; let tabContainerEl: HTMLDivElement;
@@ -99,7 +109,7 @@
bind:this={tabContainerEl} bind:this={tabContainerEl}
class={[ class={[
'border-sui-text/15 relative mb-4 flex items-center gap-5 border-b-2', 'border-sui-text/15 relative mb-4 flex items-center gap-5 border-b-2',
padded && 'px-layout' padHeader && 'px-layout'
]} ]}
> >
{#each pages as page, i (page.title)} {#each pages as page, i (page.title)}
@@ -134,7 +144,7 @@
{#key activeIndex} {#key activeIndex}
<div <div
class={[padded && 'px-layout']} class={[padContent === 'padding' && 'px-layout', padContent === 'margin' && 'mx-layout']}
in:flyX={{ direction: activeIndex > prevIndex ? 1 : -1, duration: 180, delay: 181 }} in:flyX={{ direction: activeIndex > prevIndex ? 1 : -1, duration: 180, delay: 181 }}
out:flyX={{ direction: activeIndex > prevIndex ? -1 : 1, duration: 180 }} out:flyX={{ direction: activeIndex > prevIndex ? -1 : 1, duration: 180 }}
onoutrostart={lockHeight} onoutrostart={lockHeight}

View File

@@ -10,6 +10,7 @@ export {
default as Dialog, default as Dialog,
type DialogAPI, type DialogAPI,
type DialogControls, type DialogControls,
type DialogState,
dialogCancelButton, dialogCancelButton,
dialogCloseButton, dialogCloseButton,
dialogOkButton dialogOkButton

View File

@@ -35,8 +35,7 @@
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, type Component } from 'svelte'; import { onMount } 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';
@@ -60,6 +59,7 @@
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 = [
@@ -537,15 +537,6 @@
bind:open={dialogOpen} bind:open={dialogOpen}
title="Dialog Title" title="Dialog Title"
size="sm" size="sm"
controls={{
ok: {
action: (dialog) => {
dialog.close();
alert('Dialog submitted!');
}
},
cancel: null
}}
onopen={(dialog) => { onopen={(dialog) => {
dialog.error('Example error message!'); dialog.error('Example error message!');
dialog.loading(); dialog.loading();
@@ -554,7 +545,27 @@
}, 2000); }, 2000);
}} }}
> >
{#snippet controls(state)}
<Button onclick={() => state.api.close()}>Cancel</Button>
<Button
onclick={() => {
state.api.close();
alert('Dialog submitted!');
}}
loading={state.loading}
>
Submit
</Button>
{/snippet}
<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 -->