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
10 changed files with 142 additions and 451 deletions

1
.nvmrc
View File

@@ -1 +0,0 @@
24.12.0

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.2.0", "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

@@ -29,11 +29,10 @@
}; };
/** returns option label, falling back to value or 'Undefined Option' if no option provided */ /** returns option label, falling back to value or 'Undefined Option' if no option provided */
const getLabel = (opt: ComboboxOption | undefined | null): string => const getLabel = (opt: ComboboxOption | undefined): string =>
opt ? (opt.label ?? opt.value) : 'Undefined Option'; opt ? (opt.label ?? opt.value) : 'Undefined Option';
/** returns option preview, falling back to getLabel if missing */ /** returns option preview, falling back to getLabel if missing */
const getPreview = (opt: ComboboxOption | undefined | null): string => const getPreview = (opt: ComboboxOption | undefined): string => opt?.preview ?? getLabel(opt);
opt?.preview ?? getLabel(opt);
</script> </script>
<script lang="ts"> <script lang="ts">
@@ -42,7 +41,8 @@
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 { type Snippet } from 'svelte'; import { onMount, tick, 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';
@@ -79,7 +79,7 @@
stateless?: boolean; stateless?: boolean;
/** Bindable value of the combobox, the currently selected option */ /** Bindable value of the combobox, the currently selected option */
value?: ComboboxOption | null; value?: ComboboxOption;
/** Array of ComboboxOptions for the picker */ /** Array of ComboboxOptions for the picker */
options: ComboboxOption[]; options: ComboboxOption[];
/** /**
@@ -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);
} }
}); });
@@ -272,7 +273,7 @@
}); });
/** currently highlighted option, updated by keyboard navigation or defaults to first item */ /** currently highlighted option, updated by keyboard navigation or defaults to first item */
let highlighted = $derived.by((): ComboboxOption | undefined | null => { let highlighted = $derived.by((): ComboboxOption | undefined => {
if (!searching) return undefined; // otherwise, the first item is highlighted on first open if (!searching) return undefined; // otherwise, the first item is highlighted on first open
if (filteredItems.length === 0) return undefined; if (filteredItems.length === 0) return undefined;
if (value !== undefined && filteredItems.find((v) => v.value === value?.value)) return value; if (value !== undefined && filteredItems.find((v) => v.value === value?.value)) return value;
@@ -315,8 +316,12 @@
easing: cubicOut easing: cubicOut
}); });
$effect(() => { $effect(() => {
if (iconWidth >= 0) {
untrack(() => {
inputPadding.target = calculatePadding(); inputPadding.target = calculatePadding();
}); });
}
});
/*** HELPER FUNCTIONS ***/ /*** HELPER FUNCTIONS ***/
@@ -498,6 +503,7 @@
<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
@@ -544,6 +550,7 @@
{/each} {/each}
</div> </div>
{/if} {/if}
</Portal>
<!-- Combobox main input container --> <!-- Combobox main input container -->
<div class={classValue}> <div class={classValue}>
@@ -651,9 +658,9 @@
> >
{#if loading} {#if loading}
<Spinner class="stroke-sui-accent! -mt-0.5" size="1em" /> <Spinner class="stroke-sui-accent! -mt-0.5" size="1em" />
{:else if useHighlighted && highlighted && highlighted.icon} {:else if useHighlighted && highlighted}
{@render optionIcon(highlighted)} {@render optionIcon(highlighted)}
{:else if value && value.icon} {:else if value}
{@render optionIcon(value)} {@render optionIcon(value)}
{:else if icon} {:else if icon}
{#if typeof icon === 'function'} {#if typeof icon === 'function'}

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,16 +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;
/** 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 = {
@@ -76,9 +64,9 @@
/** /**
* Stores internal state of the dialog, everything necessary to render * Stores internal state of the dialog, everything necessary to render
* internal and override capable snippets. * internal snippets.
*/ */
export type DialogState = { type DialogState = {
frozen: boolean; frozen: boolean;
loading: boolean; loading: boolean;
disabled: boolean; disabled: boolean;
@@ -91,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">
@@ -106,15 +91,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 { generateIdentifier, mergeOverrideObject } from './util'; import { 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<[state: DialogState]>; title: string | Snippet;
/** Description of the dialog, optionally rendered below the title */ /** Description of the dialog, optionally rendered below the title */
description?: string | Snippet<[state: DialogState]>; description?: string | Snippet;
/** 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 */
@@ -122,29 +107,19 @@
/** Content of the dialog */ /** Content of the dialog */
children?: Snippet; children?: Snippet;
/** Bottom controls for the dialog */ /** Bottom controls for the dialog */
controls?: Snippet<[state: DialogState]> | DialogControls; controls?: Snippet | 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<[state: DialogState]> | 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 preventing user input */ /** If default controls are used, freezes all interactions */
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;
} }
@@ -161,72 +136,34 @@
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();
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);
const zIndex = $derived(1000 + stackIndex * 100);
const reallyFrozen = $derived(autoFreeze ? frozen || loading : frozen); // disable window scroll when dialog is open
/** handles open change */
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,
@@ -240,16 +177,13 @@
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: reallyFrozen, frozen,
loading, loading,
disabled, disabled,
api: dialogAPI api: dialogAPI
@@ -265,31 +199,23 @@
{#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: ${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 && !reallyFrozen && !dialogContainer?.contains(target) && target !== dialogContainer) if (open && !frozen && !dialogContainer?.contains(target) && target !== dialogContainer)
open = false; open = false;
}} }}
onkeydown={(e) => { onkeydown={(e) => {
if (e.key === 'Escape' && !reallyFrozen) { 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
@@ -309,17 +235,14 @@
> >
<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>
<!-- Close Button --> <!-- Close Button -->
{#if close !== null} {#if close !== null}
{#if typeof close === 'function'} {#if typeof close === 'function'}
{@render close(getState())} {@render close()}
{:else} {:else}
{@render dialogCloseButton(getState(), close)} {@render dialogCloseButton(getState(), close)}
{/if} {/if}
@@ -331,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}
@@ -347,9 +270,7 @@
controlsAlign === 'end' && 'justify-end' controlsAlign === 'end' && 'justify-end'
]} ]}
> >
{#if controls && typeof controls === 'function'}{@render controls( {#if controls && typeof controls === 'function'}{@render controls()}{:else if controls?.flip}
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}
@@ -379,7 +300,7 @@
state.api.close(); state.api.close();
} }
}} }}
disabled={state.frozen || state.disabled} disabled={state.frozen}
> >
{opts?.label || 'Cancel'} {opts?.label || 'Cancel'}
</Button> </Button>
@@ -424,10 +345,10 @@
</button> </button>
{/snippet} {/snippet}
{#snippet stringOrSnippet(val: string | Snippet<[state: DialogState]>)} {#snippet stringOrSnippet(val: string | Snippet)}
{#if typeof val === 'string'} {#if typeof val === 'string'}
{val} {val}
{:else} {:else}
{@render val(getState())} {@render val()}
{/if} {/if}
{/snippet} {/snippet}

View File

@@ -23,22 +23,12 @@
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 (default: false) */ /** Applies layout padding to the tab header & content areas (default: false) */
padHeader?: boolean; padded?: 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 { let { pages, activeIndex = 0, onchange, padded = false, class: classValue }: Props = $props();
pages,
activeIndex = 0,
onchange,
padHeader = false,
padContent = 'none',
class: classValue
}: Props = $props();
let primaryContainerEl: HTMLDivElement; let primaryContainerEl: HTMLDivElement;
let tabContainerEl: HTMLDivElement; let tabContainerEl: HTMLDivElement;
@@ -109,7 +99,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',
padHeader && 'px-layout' padded && 'px-layout'
]} ]}
> >
{#each pages as page, i (page.title)} {#each pages as page, i (page.title)}
@@ -144,7 +134,7 @@
{#key activeIndex} {#key activeIndex}
<div <div
class={[padContent === 'padding' && 'px-layout', padContent === 'margin' && 'mx-layout']} class={[padded && 'px-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

@@ -7,105 +7,21 @@ export interface GraphError {
} }
/** RawError is an error that can be converted to a string by ErrorMessage */ /** RawError is an error that can be converted to a string by ErrorMessage */
export type RawError = ErrorMessage | Error | string | GraphError[]; export type RawError = Error | string | GraphError[];
/**
* Type guard to check if an error is a RawError
* @param error The error to check
* @returns true if the error is a RawError, false otherwise
*/
export const isRawError = (error: unknown): error is RawError => {
return (
error instanceof ErrorMessage ||
error instanceof Error ||
typeof error === 'string' ||
(Array.isArray(error) &&
error.every(
(e) => typeof e.message === 'string' && (e.path === undefined || Array.isArray(e.path))
))
);
};
/**
* Converts any error (including GraphQL errors, standard Errors, strings, and
* ErrorMessages) into a consistent string format for display.
* @param error The error to convert to a string.
* @returns A string representation of the error, suitable for display to users.
*/
export const catchErrorString = (error: unknown): string => {
if (error instanceof ErrorMessage) {
return error.toString();
} else if (isRawError(error)) {
return new ErrorMessage(error).toString();
} else {
return String(error);
}
};
/**
* Checks a typical response from a GraphQL server for error and missing data,
* throwing an appropriate ErrorMessage if an error is found or if no data is
* returned.
* @param resourceName A human-readable name for the resource being fetched,
* used in error messages.
* @param response The response from the GraphQL server, which may contain an
* 'errors' array and a 'data' field.
* @throws An ErrorMessage if the response contains errors or if the data field
* is missing (undefined or null).
*/
export const checkGraphResponse = (
resourceName: string,
response: { errors?: GraphError[] | null; data?: unknown }
): void => {
if (response.errors && response.errors.length > 0) {
throw new ErrorMessage(`Error fetching ${resourceName}`, response.errors);
}
if (!response.data) {
throw new ErrorMessage(`No data returned for ${resourceName}`);
}
};
/**
* A class that represents an error message, which can be constructed from various types of raw errors
* and provides methods to convert those errors into a consistent format (lines of text) for display.
* It also supports wrapping existing error messages with additional context.
*/
export class ErrorMessage { export class ErrorMessage {
private _lines: string[] = []; private _lines: string[] = [];
/** /**
* Always creates a new ErrorMessage instance, even if there are no errors. * Converts a RawError to an array of lines and stores it for later access,
* @param errors The raw errors to convert and store, or null/undefined for no error. * or initializes without any errors if the input is null or undefined.
* @throws If any of the raw errors are of an unsupported type. * @param raw The raw error to convert and store, or null/undefined for no error.
* @throws If the raw error is of an unsupported type.
*/ */
constructor(...errors: (unknown | null | undefined)[]) { constructor(raw: RawError | null | undefined) {
if (errors.length === 0) return; if (raw) {
this._lines = errors.flatMap((e) => ErrorMessage.rawErrorToLines(e)); this._lines = ErrorMessage.rawErrorToLines(raw);
} }
/**
* Creates a new ErrorMessage only if the provided errors are not null or
* undefined. If no errors are provided, returns null.
*/
static from(...errors: (unknown | null | undefined)[]): ErrorMessage | null {
if (errors.length === 0) return null;
return new ErrorMessage(...errors);
}
/**
* Wraps this ErrorMessage inside another error, nesting the original error.
* @param errors The raw errors to wrap around this error, or null/undefined for no additional error.
* @returns A new ErrorMessage instance that includes the original error and any new errors.
*/
wrap(...errors: (unknown | null | undefined)[]): ErrorMessage {
if (errors.length === 0) return this;
const newLines = errors.flatMap((e) => ErrorMessage.rawErrorToLines(e));
return new ErrorMessage(...newLines, ...this._lines);
}
/** returns true if there are any error lines */
hasError(): boolean {
return this._lines.length > 0;
} }
/** returns the stored lines */ /** returns the stored lines */
@@ -121,14 +37,28 @@ export class ErrorMessage {
return this._lines.join('<br />'); return this._lines.join('<br />');
} }
/** returns true if there are any error lines */
hasError(): boolean {
return this._lines.length > 0;
}
/** adds a new line to the error message */
addLine(line: string): void {
this._lines.push(line);
}
/** optionally returns a new ErrorMessage only if the RawError is not empty */
static from(raw: RawError | null | undefined): ErrorMessage | null {
if (!raw) return null;
return new ErrorMessage(raw);
}
/** converts a RawError to an array of lines */ /** converts a RawError to an array of lines */
static rawErrorToLines(raw: unknown | null | undefined): string[] { static rawErrorToLines(raw: RawError | null | undefined): string[] {
if (!raw) return []; if (!raw) return ['No error'];
let errorLines: string[]; let errorLines: string[];
if (raw instanceof ErrorMessage) { if (typeof raw === 'string') {
errorLines = raw.lines;
} else if (typeof raw === 'string') {
errorLines = [raw]; errorLines = [raw];
} else if (raw instanceof Error) { } else if (raw instanceof Error) {
errorLines = [raw.message]; errorLines = [raw.message];

View File

@@ -4,7 +4,7 @@
* for more details, examples, and original source. * for more details, examples, and original source.
*/ */
import { computePosition, autoUpdate, flip, offset, type Placement, size } from '@floating-ui/dom'; import { computePosition, autoUpdate, flip, offset, type Placement } from '@floating-ui/dom';
import { createAttachmentKey } from 'svelte/attachments'; import { createAttachmentKey } from 'svelte/attachments';
/** /**
@@ -17,13 +17,6 @@ export interface PopoverOptions {
placement?: Placement; placement?: Placement;
/** Offset distance between the reference and floating elements (default: 8) */ /** Offset distance between the reference and floating elements (default: 8) */
offset?: number; offset?: number;
/**
* Constraints the width and height of the popover to prevent it from
* overflowing the viewport. If true, the popover will adjust its max-width
* and max-height to fit. Scrolling is the responsibility of the parent
* element. Default is true.
*/
constrainSize?: boolean;
/** Callback when the popover is opened or closed */ /** Callback when the popover is opened or closed */
ontoggle?: (open: boolean) => void; ontoggle?: (open: boolean) => void;
} }
@@ -36,12 +29,10 @@ export class Popover {
private options: PopoverOptions = { private options: PopoverOptions = {
interaction: 'click', interaction: 'click',
placement: 'bottom-start', placement: 'bottom-start',
offset: 8, offset: 8
constrainSize: true
}; };
private referenceElement: HTMLElement | undefined = $state(); private referenceElement: HTMLElement | undefined = $state();
private floatingElement: HTMLElement | undefined = $state(); private floatingElement: HTMLElement | undefined = $state();
private positionElement: HTMLElement | undefined = $state();
private open = $state(false); private open = $state(false);
/** /**
@@ -96,23 +87,6 @@ export class Popover {
return attrs; return attrs;
} }
/**
* Optionally sets the positioning element for the popover, which is used
* for calculating the position of the floating element. If not set, the
* reference element is used by default.
* @returns An object containing an attachment key for the positioning element.
*/
positionReference() {
return {
[createAttachmentKey()]: (node: HTMLElement) => {
this.positionElement = node;
return () => {
this.positionElement = undefined;
};
}
};
}
/** Returns whether the popover is open */ /** Returns whether the popover is open */
isOpen() { isOpen() {
return this.open; return this.open;
@@ -148,38 +122,6 @@ export class Popover {
}; };
} }
/**
* Callback function that closes the popover when the Escape key is pressed.
* Can be applied to the window, typically via <svelte:window onkeydown={popover.handleEscape} />,
* or to any other element that will receive keyboard events while the popover is open.
* @param event - The keyboard event to handle.
*/
handleEscape(event: KeyboardEvent) {
if (event.key === 'Escape') {
this.setOpen(false);
}
}
/**
* Callback function that closes the popover when a click occurs outside of the
* reference and floating elements. Should be applied to the window, typically
* via <svelte:window onclick={popover.handleClickOutside} />.
* @param event - The click event to handle.
*/
handleClickOutside(event: MouseEvent) {
if (!this.isOpen() || !this.referenceElement || !this.floatingElement) {
return;
}
if (
event.target instanceof Node &&
!this.referenceElement.contains(event.target) &&
!this.floatingElement.contains(event.target)
) {
this.setOpen(false);
}
}
/** /**
* Updates the position of the floating element based on the reference element using * Updates the position of the floating element based on the reference element using
* the computePosition function from floating-ui. It applies the calculated * the computePosition function from floating-ui. It applies the calculated
@@ -189,24 +131,9 @@ export class Popover {
if (!this.referenceElement || !this.floatingElement) { if (!this.referenceElement || !this.floatingElement) {
return; return;
} }
const reference = this.positionElement || this.referenceElement; const position = await computePosition(this.referenceElement, this.floatingElement, {
const position = await computePosition(reference, this.floatingElement, {
placement: this.options.placement, placement: this.options.placement,
middleware: [ middleware: [flip(), offset(this.options.offset)]
flip(),
offset(this.options.offset),
size({
apply: ({ availableWidth, availableHeight, elements }) => {
if (this.options.constrainSize) {
elements.floating.style.maxWidth = `${availableWidth}px`;
elements.floating.style.maxHeight = `${availableHeight}px`;
} else {
elements.floating.style.maxWidth = '';
elements.floating.style.maxHeight = '';
}
}
})
]
}); });
const { x, y } = position; const { x, y } = position;
Object.assign(this.floatingElement.style, { Object.assign(this.floatingElement.style, {

View File

@@ -10,7 +10,6 @@ export {
default as Dialog, default as Dialog,
type DialogAPI, type DialogAPI,
type DialogControls, type DialogControls,
type DialogState,
dialogCancelButton, dialogCancelButton,
dialogCloseButton, dialogCloseButton,
dialogOkButton dialogOkButton
@@ -31,7 +30,6 @@ export { default as Label } from './Label.svelte';
export { default as Link, rewriteHref } from './Link.svelte'; export { default as Link, rewriteHref } from './Link.svelte';
export { default as PhoneInput } from './PhoneInput.svelte'; export { default as PhoneInput } from './PhoneInput.svelte';
export { default as PinInput } from './PinInput.svelte'; export { default as PinInput } from './PinInput.svelte';
export { type Preventable, checkPreventer, type Reversible, checkReversible } from './prevent';
export { default as RadioGroup } from './RadioGroup.svelte'; export { default as RadioGroup } from './RadioGroup.svelte';
export { default as ScrollBox } from './ScrollBox.svelte'; export { default as ScrollBox } from './ScrollBox.svelte';
export { default as Spinner } from './Spinner.svelte'; export { default as Spinner } from './Spinner.svelte';
@@ -68,14 +66,7 @@ export {
ToolbarGroup, ToolbarGroup,
Toolbar Toolbar
} from './Toolbar'; } from './Toolbar';
export { export { type GraphError, type RawError, ErrorMessage } from './error';
type GraphError,
type RawError,
isRawError,
catchErrorString,
checkGraphResponse,
ErrorMessage
} from './error';
export { export {
NavigationItem, NavigationItem,
NavigationManager, NavigationManager,

View File

@@ -1,63 +0,0 @@
/**
* A type for a function that can be prevented from executing its default behavior.
* See checkPreventer for easy usage of this type.
*/
export type Preventable<T> = (ev: T & { prevent: () => void }) => Promise<void> | void;
/**
* Calls the provided function with a preventer object, and if the preventer is not
* prevented, calls the callback function.
* @param fn The function to call with the preventer.
* @param ev The event object to pass to the function.
* @param cb The callback function to call if the preventer is not prevented.
* @returns A promise that resolves to true if the action was not prevented, or false if it was prevented.
*/
export const checkPreventer = async <T>(
fn: Preventable<T>,
ev: T,
cb?: () => void
): Promise<boolean> => {
let prevented = false;
const preventer = {
prevent: () => {
prevented = true;
}
};
await fn({ ...ev, ...preventer });
if (!prevented && cb) {
cb();
}
return !prevented;
};
/**
* A type for a function that can be reversed after executing its behavior.
* See checkReversible for easy usage of this type.
*/
export type Reversible<T> = (ev: T & { reverse: () => void }) => Promise<void> | void;
/**
* Calls the provided function with a reverser object, and if the reverser is
* reversed, calls the callback function.
* @param fn The function to call with the reverser.
* @param ev The event object to pass to the function.
* @param cb The callback function to call if the reverser is reversed.
* @returns A promise that resolves to true if the action was not reversed, or false if it was reversed.
*/
export const checkReversible = async <T>(
fn: Reversible<T>,
ev: T,
cb?: () => void
): Promise<boolean> => {
let reversed = false;
const reverser = {
reverse: () => {
reversed = true;
}
};
await fn({ ...ev, ...reverser });
if (reversed && cb) {
cb();
}
return !reversed;
};

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 = [
@@ -537,6 +537,15 @@
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();
@@ -545,27 +554,7 @@
}, 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 -->