Compare commits
15 Commits
72b277d138
...
v0.3.5
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d3c4962495 | ||
|
|
3cdda64686 | ||
|
|
6630051d67 | ||
|
|
bf77a20ff9 | ||
|
|
42c9bc0bcc | ||
|
|
ed48b404d4 | ||
|
|
54f7924c4a | ||
|
|
d9cd2b406a | ||
|
|
46bd6b935a | ||
|
|
9782a31846 | ||
|
|
63b29e3f6a | ||
|
|
1c4fac7523 | ||
|
|
098bf75bd3 | ||
|
|
a321cbffe9 | ||
|
|
1cc8cd6913 |
@@ -4,7 +4,7 @@
|
||||
"type": "git",
|
||||
"url": "https://gitea.auvem.com/svelte-toolkit/sui.git"
|
||||
},
|
||||
"version": "0.3.1",
|
||||
"version": "0.3.5",
|
||||
"scripts": {
|
||||
"dev": "vite dev",
|
||||
"build": "vite build && pnpm run prepack",
|
||||
|
||||
228
src/lib/Banner.svelte
Normal file
228
src/lib/Banner.svelte
Normal file
@@ -0,0 +1,228 @@
|
||||
<script lang="ts" module>
|
||||
export interface BannerAPI {
|
||||
/** opens the banner */
|
||||
open: () => void;
|
||||
/** closes the banner */
|
||||
close: () => void;
|
||||
/** returns whether the banner is open */
|
||||
isOpen: () => boolean;
|
||||
/** disables banner controls */
|
||||
disable: () => void;
|
||||
/** enables banner controls */
|
||||
enable: () => void;
|
||||
/** returns whether the banner controls are disabled */
|
||||
isDisabled: () => boolean;
|
||||
/** freezes banner state (cannot be dismissed) */
|
||||
freeze: () => void;
|
||||
/** unfreezes banner state */
|
||||
unfreeze: () => void;
|
||||
/** returns whether the banner is frozen */
|
||||
isFrozen: () => boolean;
|
||||
}
|
||||
|
||||
type BannerControlButton = {
|
||||
label?: string;
|
||||
class?: ClassValue;
|
||||
/** if framed is false, FramelessButton is used instead of Button */
|
||||
framed?: boolean;
|
||||
action?: (banner: BannerAPI) => void;
|
||||
};
|
||||
|
||||
export type BannerControls = {
|
||||
accept?: BannerControlButton | null;
|
||||
decline?: BannerControlButton | null;
|
||||
moreInfo?:
|
||||
| (Omit<BannerControlButton, 'framed'> & {
|
||||
type?: 'link' | 'framed' | 'frameless';
|
||||
href?: string;
|
||||
})
|
||||
| null;
|
||||
dismiss?: Omit<BannerControlButton, 'framed'> | null;
|
||||
/** if true, accept and decline buttons are swapped with more info */
|
||||
swap?: boolean | null;
|
||||
};
|
||||
|
||||
const defaultBannerControls: BannerControls = {
|
||||
accept: {
|
||||
label: 'Accept',
|
||||
framed: true,
|
||||
action: (banner) => banner.close()
|
||||
},
|
||||
decline: {
|
||||
label: 'Decline',
|
||||
framed: false,
|
||||
action: (banner) => banner.close()
|
||||
},
|
||||
dismiss: {
|
||||
action: (banner) => banner.close()
|
||||
},
|
||||
swap: false
|
||||
};
|
||||
</script>
|
||||
|
||||
<script lang="ts">
|
||||
import type { Snippet } from 'svelte';
|
||||
import type { ClassValue } from 'svelte/elements';
|
||||
import Link from './Link.svelte';
|
||||
import Button from './Button.svelte';
|
||||
import FramelessButton from './FramelessButton.svelte';
|
||||
import { X } from 'phosphor-svelte';
|
||||
import { mergeOverrideObject } from './util';
|
||||
|
||||
/**
|
||||
* Banner provides a simple component to display a banner message with
|
||||
* additional tooling for easy control integration. Controls tools are
|
||||
* geared toward cookie consent, announcements, and similar use cases.
|
||||
*/
|
||||
|
||||
interface Props {
|
||||
title?: string;
|
||||
open?: boolean;
|
||||
disabled?: boolean;
|
||||
frozen?: boolean;
|
||||
position?: 'top' | 'bottom';
|
||||
controls?: BannerControls | null;
|
||||
/** if true, frameless buttons and links are inverted (default: true) */
|
||||
invertFrameless?: boolean;
|
||||
class?: ClassValue | null;
|
||||
onaccept?: (banner: BannerAPI) => void;
|
||||
ondecline?: (banner: BannerAPI) => void;
|
||||
children?: Snippet;
|
||||
}
|
||||
|
||||
let {
|
||||
title,
|
||||
open = $bindable(false),
|
||||
disabled = $bindable(false),
|
||||
frozen = $bindable(false),
|
||||
position,
|
||||
controls: rawControls = defaultBannerControls,
|
||||
invertFrameless = true,
|
||||
class: classValue,
|
||||
onaccept,
|
||||
ondecline,
|
||||
children
|
||||
}: Props = $props();
|
||||
|
||||
const controls = $derived(mergeOverrideObject(defaultBannerControls, rawControls));
|
||||
|
||||
const api: BannerAPI = {
|
||||
open: () => (open = true),
|
||||
close: () => (open = false),
|
||||
isOpen: () => open,
|
||||
disable: () => (disabled = true),
|
||||
enable: () => (disabled = false),
|
||||
isDisabled: () => disabled,
|
||||
freeze: () => (frozen = true),
|
||||
unfreeze: () => (frozen = false),
|
||||
isFrozen: () => frozen
|
||||
};
|
||||
|
||||
const handleAccept = () => {
|
||||
controls.accept?.action?.(api);
|
||||
onaccept?.(api);
|
||||
};
|
||||
const handleDecline = () => {
|
||||
controls.decline?.action?.(api);
|
||||
ondecline?.(api);
|
||||
};
|
||||
</script>
|
||||
|
||||
{#if open}
|
||||
<div
|
||||
class={[
|
||||
'fixed left-0 z-50 w-screen px-8 py-6',
|
||||
position === 'top' ? 'top-0' : 'bottom-0',
|
||||
'bg-sui-secondary-800 text-sui-background',
|
||||
classValue
|
||||
]}
|
||||
>
|
||||
{#if title || controls?.dismiss}
|
||||
<div class="mb-2 flex items-center justify-between gap-4">
|
||||
{#if title}
|
||||
<h3 class="mb-2 text-lg font-semibold">{title}</h3>
|
||||
{/if}
|
||||
|
||||
{#if controls?.dismiss}
|
||||
<FramelessButton
|
||||
inverted={invertFrameless}
|
||||
onclick={() => controls.dismiss?.action?.(api)}
|
||||
class="ml-auto"
|
||||
>
|
||||
{#if controls.dismiss?.label}
|
||||
{controls.dismiss.label}
|
||||
{/if}
|
||||
<X class="mt-0.5" size="1.2rem" weight="bold" />
|
||||
</FramelessButton>
|
||||
{/if}
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
{@render children?.()}
|
||||
|
||||
{#if controls !== null}
|
||||
<div
|
||||
class={['mt-4 flex flex-wrap justify-between gap-4', controls.swap && 'flex-row-reverse']}
|
||||
>
|
||||
<!-- More info button/link -->
|
||||
{#if controls.moreInfo}
|
||||
{#if controls.moreInfo.type === 'link' && controls.moreInfo.href}
|
||||
<Link
|
||||
href={controls.moreInfo.href}
|
||||
class={controls.moreInfo.class}
|
||||
inverted={invertFrameless}
|
||||
>
|
||||
{controls.moreInfo.label || 'More Info'}
|
||||
</Link>
|
||||
{:else if controls.moreInfo.type === 'framed'}
|
||||
<Button
|
||||
class={controls.moreInfo.class}
|
||||
onclick={() => controls.moreInfo?.action?.(api)}
|
||||
>
|
||||
{controls.moreInfo.label || 'More Info'}
|
||||
</Button>
|
||||
{:else}
|
||||
<FramelessButton
|
||||
class={controls.moreInfo.class}
|
||||
onclick={() => controls.moreInfo?.action?.(api)}
|
||||
inverted={invertFrameless}
|
||||
>
|
||||
{controls.moreInfo.label || 'More Info'}
|
||||
</FramelessButton>
|
||||
{/if}
|
||||
{/if}
|
||||
|
||||
<div
|
||||
class={['flex justify-end gap-4', controls.swap ? 'mr-auto flex-row-reverse' : 'ml-auto']}
|
||||
>
|
||||
<!-- Decline button -->
|
||||
{@render buttonControl(controls.decline, handleDecline, false)}
|
||||
<!-- Accept button -->
|
||||
{@render buttonControl(controls.accept, handleAccept, true)}
|
||||
</div>
|
||||
</div>
|
||||
{/if}
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
{#snippet buttonControl(
|
||||
button: BannerControlButton | undefined | null,
|
||||
handleClick: (banner: BannerAPI) => void,
|
||||
framedDefault: boolean
|
||||
)}
|
||||
{#if button}
|
||||
{#if button.framed || framedDefault}
|
||||
<Button class={button.class} onclick={() => handleClick(api)}>
|
||||
{button.label || 'Button'}
|
||||
</Button>
|
||||
{:else}
|
||||
<FramelessButton
|
||||
class={button.class}
|
||||
onclick={() => handleClick(api)}
|
||||
inverted={invertFrameless}
|
||||
>
|
||||
{button.label || 'Button'}
|
||||
</FramelessButton>
|
||||
{/if}
|
||||
{/if}
|
||||
{/snippet}
|
||||
@@ -41,24 +41,29 @@
|
||||
title: (title: string) => void;
|
||||
}
|
||||
|
||||
type DialogControlButton = {
|
||||
label?: string;
|
||||
class?: ClassValue;
|
||||
action?: (dialog: DialogAPI) => void;
|
||||
};
|
||||
|
||||
/**
|
||||
* Configures the default dialog controls.
|
||||
*/
|
||||
export type DialogControlOpts = {
|
||||
cancel?: {
|
||||
label?: string;
|
||||
class?: ClassValue;
|
||||
action?: (dialog: DialogAPI) => void;
|
||||
};
|
||||
ok?: {
|
||||
label?: string;
|
||||
class?: ClassValue;
|
||||
action?: (dialog: DialogAPI) => void;
|
||||
};
|
||||
close?: {
|
||||
class?: ClassValue;
|
||||
action?: (dialog: DialogAPI) => void;
|
||||
export type DialogControls = {
|
||||
cancel?: DialogControlButton | null;
|
||||
ok?: DialogControlButton | null;
|
||||
close?: Omit<DialogControlButton, 'label'> | null;
|
||||
};
|
||||
|
||||
const defaultDialogControls: DialogControls = {
|
||||
cancel: {
|
||||
label: 'Cancel'
|
||||
},
|
||||
ok: {
|
||||
label: 'OK'
|
||||
},
|
||||
close: {}
|
||||
};
|
||||
</script>
|
||||
|
||||
@@ -72,6 +77,7 @@
|
||||
import { X } from 'phosphor-svelte';
|
||||
import { ErrorMessage, type RawError } from './error';
|
||||
import ErrorBox from './ErrorBox.svelte';
|
||||
import { mergeOverrideObject } from './util';
|
||||
|
||||
interface Props {
|
||||
open?: boolean;
|
||||
@@ -80,7 +86,7 @@
|
||||
size?: 'sm' | 'md' | 'lg' | 'max';
|
||||
class?: ClassValue;
|
||||
children?: Snippet;
|
||||
controls?: Snippet | DialogControlOpts;
|
||||
controls?: Snippet | DialogControls;
|
||||
onopen?: (dialog: DialogAPI) => void;
|
||||
onclose?: (dialog: DialogAPI) => void;
|
||||
loading?: boolean;
|
||||
@@ -95,7 +101,7 @@
|
||||
size = 'sm',
|
||||
class: classValue,
|
||||
children,
|
||||
controls,
|
||||
controls: rawControls = defaultDialogControls,
|
||||
onopen,
|
||||
onclose,
|
||||
loading = $bindable(false),
|
||||
@@ -103,6 +109,12 @@
|
||||
disabled = $bindable(false)
|
||||
}: Props = $props();
|
||||
|
||||
let controls = $derived(
|
||||
typeof rawControls === 'function'
|
||||
? rawControls
|
||||
: mergeOverrideObject(defaultDialogControls, rawControls)
|
||||
);
|
||||
|
||||
let dialogContainer = $state<HTMLDivElement | null>(null);
|
||||
let error = $state<ErrorMessage | null>(null);
|
||||
|
||||
@@ -192,8 +204,10 @@
|
||||
|
||||
{#if children}{@render children()}{:else}Dialog is empty{/if}
|
||||
|
||||
<!-- Dialog Controls -->
|
||||
<div class="mt-6 flex justify-end gap-4">
|
||||
{#if controls && typeof controls === 'function'}{@render controls()}{:else}
|
||||
{#if controls.cancel !== null}
|
||||
<Button
|
||||
class={controls?.cancel?.class}
|
||||
onclick={() => {
|
||||
@@ -207,6 +221,8 @@
|
||||
>
|
||||
{controls?.cancel?.label || 'Cancel'}
|
||||
</Button>
|
||||
{/if}
|
||||
{#if controls.ok !== null}
|
||||
<Button
|
||||
class={controls?.ok?.class}
|
||||
onclick={() => {
|
||||
@@ -222,19 +238,28 @@
|
||||
{controls?.ok?.label || 'OK'}
|
||||
</Button>
|
||||
{/if}
|
||||
{/if}
|
||||
</div>
|
||||
|
||||
<!-- Close Button -->
|
||||
{#if typeof controls === 'function' || controls?.close !== null}
|
||||
<button
|
||||
type="button"
|
||||
aria-label="close"
|
||||
class="absolute top-4 right-4 inline-flex cursor-pointer items-center
|
||||
justify-center disabled:cursor-not-allowed disabled:opacity-50"
|
||||
onclick={() => {
|
||||
if (!frozen) open = false;
|
||||
if (typeof controls !== 'function' && controls?.close?.action) {
|
||||
controls?.close?.action?.(dialogAPI);
|
||||
} else if (!frozen) {
|
||||
open = false;
|
||||
}
|
||||
}}
|
||||
disabled={frozen}
|
||||
>
|
||||
<X size="1.5em" weight="bold" />
|
||||
</button>
|
||||
{/if}
|
||||
</div>
|
||||
</div>
|
||||
{/snippet}
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
icon?: IconDef;
|
||||
iconPosition?: 'left' | 'right';
|
||||
disabled?: boolean;
|
||||
inverted?: boolean;
|
||||
class?: ClassValue | null | undefined;
|
||||
children: Snippet;
|
||||
onclick?: MouseEventHandler<HTMLButtonElement>;
|
||||
@@ -16,6 +17,7 @@
|
||||
icon,
|
||||
iconPosition = 'right',
|
||||
disabled = false,
|
||||
inverted = false,
|
||||
class: classValue,
|
||||
children,
|
||||
onclick
|
||||
@@ -31,8 +33,11 @@
|
||||
<button
|
||||
type="button"
|
||||
class={[
|
||||
'text-sui-accent hover:text-sui-primary inline-flex cursor-pointer items-center gap-1.5 transition-colors',
|
||||
'inline-flex cursor-pointer items-center gap-1.5 transition-colors',
|
||||
disabled && 'pointer-events-none cursor-not-allowed opacity-50',
|
||||
inverted
|
||||
? 'text-sui-background hover:text-sui-background/80 font-medium'
|
||||
: 'text-sui-accent hover:text-sui-primary',
|
||||
classValue
|
||||
]}
|
||||
{onclick}
|
||||
|
||||
@@ -9,6 +9,6 @@
|
||||
let { class: classList, children }: Props = $props();
|
||||
</script>
|
||||
|
||||
<div class={['mt-4 flex min-w-80 items-center justify-start gap-2', classList]}>
|
||||
<div class={['mt-4 flex min-w-80 flex-wrap items-center justify-start gap-2', classList]}>
|
||||
{@render children?.()}
|
||||
</div>
|
||||
|
||||
@@ -40,6 +40,7 @@
|
||||
basepath?: string | null;
|
||||
disabled?: boolean;
|
||||
tab?: 'current' | 'new';
|
||||
inverted?: boolean;
|
||||
class?: ClassValue | null | undefined;
|
||||
children: Snippet;
|
||||
onclick?: MouseEventHandler<HTMLAnchorElement>;
|
||||
@@ -50,6 +51,7 @@
|
||||
basepath,
|
||||
disabled = false,
|
||||
tab = 'current',
|
||||
inverted = false,
|
||||
class: classValue,
|
||||
children,
|
||||
onclick
|
||||
@@ -60,8 +62,11 @@
|
||||
|
||||
<a
|
||||
class={[
|
||||
'text-sui-accent hover:text-sui-primary inline-flex items-center gap-1.5 transition-colors',
|
||||
'inline-flex items-center gap-1.5 transition-colors',
|
||||
disabled && 'pointer-events-none cursor-not-allowed opacity-50',
|
||||
inverted
|
||||
? 'text-sui-background hover:text-sui-background/80 font-medium'
|
||||
: 'text-sui-accent hover:text-sui-primary',
|
||||
classValue
|
||||
]}
|
||||
href={computedHref}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
// Reexport your entry components here
|
||||
export { default as ActionSelect, type ActionSelectOption } from './ActionSelect.svelte';
|
||||
export { default as Banner, type BannerControls, type BannerAPI } from './Banner.svelte';
|
||||
export { default as Button } from './Button.svelte';
|
||||
export { default as CenterBox } from './CenterBox.svelte';
|
||||
export { default as Checkbox, type CheckboxState } from './Checkbox.svelte';
|
||||
|
||||
@@ -143,3 +143,55 @@ export const trimEdges = (str: string, char: string, trimStart?: boolean, trimEn
|
||||
|
||||
return str.substring(start, end);
|
||||
};
|
||||
|
||||
// helper: only treat plain objects as mergeable
|
||||
const isPlainObject = (v: unknown): v is Record<string, unknown> =>
|
||||
typeof v === 'object' &&
|
||||
v !== null &&
|
||||
!Array.isArray(v) &&
|
||||
Object.getPrototypeOf(v) === Object.prototype;
|
||||
|
||||
/** Merge two plain object maps. No `any` used. */
|
||||
function mergePlainObjects(
|
||||
baseObj: Record<string, unknown>,
|
||||
overrideObj: Record<string, unknown>
|
||||
): Record<string, unknown> {
|
||||
const res: Record<string, unknown> = { ...baseObj };
|
||||
|
||||
for (const k of Object.keys(overrideObj)) {
|
||||
const v = overrideObj[k];
|
||||
if (v === undefined) continue; // undefined preserves base
|
||||
const b = res[k];
|
||||
|
||||
if (isPlainObject(v) && isPlainObject(b)) {
|
||||
res[k] = mergePlainObjects(b as Record<string, unknown>, v as Record<string, unknown>);
|
||||
} else {
|
||||
// primitives, null, arrays, non-plain objects replace base
|
||||
res[k] = v;
|
||||
}
|
||||
}
|
||||
|
||||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge `base` with `override`.
|
||||
* - `null` in `override` replaces (kept as valid override)
|
||||
* - `undefined` in `override` is ignored (keeps base)
|
||||
* - Only plain objects are deep-merged
|
||||
* - If `override` is null/undefined we return a shallow copy of `base`
|
||||
*/
|
||||
export const mergeOverrideObject = <T extends Record<string, unknown>>(
|
||||
base: T,
|
||||
override?: Partial<T> | null
|
||||
): T => {
|
||||
if (override == null) return { ...base } as T;
|
||||
|
||||
// Use plain maps internally to avoid explicit any
|
||||
const baseMap = { ...base } as Record<string, unknown>;
|
||||
const overrideMap = override as Record<string, unknown>;
|
||||
|
||||
const merged = mergePlainObjects(baseMap, overrideMap);
|
||||
|
||||
return merged as T;
|
||||
};
|
||||
|
||||
@@ -39,6 +39,7 @@
|
||||
import ErrorBox from '$lib/ErrorBox.svelte';
|
||||
import TextareaInput from '$lib/TextareaInput.svelte';
|
||||
import DurationInput, { formatDuration } from '$lib/DurationInput.svelte';
|
||||
import Banner from '$lib/Banner.svelte';
|
||||
|
||||
// Lazy-load heavy components
|
||||
let PhoneInput = createLazyComponent(() => import('$lib/PhoneInput.svelte'));
|
||||
@@ -56,7 +57,7 @@
|
||||
{ value: 'option3', label: 'Option 3', disabled: true }
|
||||
];
|
||||
let lazyOptions: ComboboxOption[] = $state([]);
|
||||
let dateInputValue = $state<CalendarDate | undefined>(undefined);
|
||||
let dateInputValue = $state<CalendarDate | null>(null);
|
||||
let checkboxValue = $state<CheckboxState>('indeterminate');
|
||||
let dialogOpen = $state(false);
|
||||
let scrollableDialogOpen = $state(false);
|
||||
@@ -74,7 +75,25 @@
|
||||
const boldStore = boldToggle.store;
|
||||
</script>
|
||||
|
||||
<title>sui</title>
|
||||
<svelte:head>
|
||||
<title>sui</title>
|
||||
</svelte:head>
|
||||
|
||||
<!-- Cookie Consent Banner Demo -->
|
||||
<Banner
|
||||
title="Manage Cookies"
|
||||
controls={{
|
||||
moreInfo: { label: 'More Info', type: 'link', href: '#!' },
|
||||
dismiss: null,
|
||||
swap: true
|
||||
}}
|
||||
onaccept={() => console.log('Cookies accepted!')}
|
||||
ondecline={() => console.log('Cookies declined!')}
|
||||
open
|
||||
>
|
||||
We use cookies and similar technologies to enhance your experience, analyze site traffic, and
|
||||
measure our ads. You can manage your preferences anytime.
|
||||
</Banner>
|
||||
|
||||
<h1 class="mb-4 text-3xl font-bold">sui — Opinionated Svelte 5 UI toolkit</h1>
|
||||
|
||||
@@ -504,7 +523,8 @@
|
||||
dialog.close();
|
||||
alert('Dialog submitted!');
|
||||
}
|
||||
}
|
||||
},
|
||||
cancel: null
|
||||
}}
|
||||
onopen={(dialog) => {
|
||||
dialog.error('Example error message!');
|
||||
|
||||
Reference in New Issue
Block a user