sv5ui 1.2.0 → 1.3.0

package/dist/CheckboxGroup/CheckboxGroup.svelte

@@ -0,0 +1,215 @@
+<script lang="ts" module>
+    import type { CheckboxGroupProps } from './checkbox-group.types.js'
+
+    export type Props = CheckboxGroupProps
+</script>
+
+<script lang="ts">
+    import { Checkbox, Label, useId } from 'bits-ui'
+    import { checkboxGroupVariants, checkboxGroupDefaults } from './checkbox-group.variants.js'
+    import { getComponentConfig, iconsDefaults } from '../config.js'
+    import { getContext } from 'svelte'
+    import Icon from '../Icon/Icon.svelte'
+    import type { FormFieldProps } from '../FormField/form-field.types.js'
+    import type { CheckboxGroupItem } from './checkbox-group.types.js'
+
+    const config = getComponentConfig('checkboxGroup', checkboxGroupDefaults)
+    const icons = getComponentConfig('icons', iconsDefaults)
+
+    let {
+        ref = $bindable(null),
+        value = $bindable([]),
+        onValueChange,
+        items = [],
+        ui,
+        id,
+        name,
+        color = config.defaultVariants.color,
+        size,
+        variant = config.defaultVariants.variant,
+        indicator = config.defaultVariants.indicator,
+        orientation = config.defaultVariants.orientation,
+        disabled = false,
+        required = false,
+        loading = false,
+        loadingIcon = icons.loading,
+        icon = icons.check,
+        legend,
+        legendSlot,
+        labelSlot,
+        descriptionSlot,
+        class: className,
+        ...restProps
+    }: Props = $props()
+
+    const formFieldContext = getContext<
+        | {
+              name?: string
+              size: NonNullable<FormFieldProps['size']>
+              error?: string | boolean
+              ariaId: string
+          }
+        | undefined
+    >('formField')
+
+    const hasError = $derived(
+        formFieldContext?.error !== undefined && formFieldContext?.error !== false
+    )
+    const resolvedSize = $derived(size ?? formFieldContext?.size ?? config.defaultVariants.size)
+    const resolvedColor = $derived(hasError ? 'error' : color)
+    const autoId = useId()
+    const resolvedId = $derived(id ?? formFieldContext?.ariaId ?? autoId)
+    const resolvedName = $derived(name ?? formFieldContext?.name)
+    const isDisabled = $derived(disabled || loading)
+
+    const ariaDescribedBy = $derived(
+        !formFieldContext
+            ? undefined
+            : hasError
+              ? `${formFieldContext.ariaId}-error`
+              : `${formFieldContext.ariaId}-description ${formFieldContext.ariaId}-help`
+    )
+
+    const slots = $derived(
+        checkboxGroupVariants({
+            color: resolvedColor,
+            size: resolvedSize,
+            variant,
+            indicator,
+            orientation,
+            loading,
+            required,
+            disabled: isDisabled ? true : undefined
+        })
+    )
+
+    const layoutClasses = $derived.by(() => ({
+        root: slots.root({ class: [config.slots.root, className, ui?.root] }),
+        fieldset: slots.fieldset({ class: [config.slots.fieldset, ui?.fieldset] }),
+        legend: slots.legend({ class: [config.slots.legend, ui?.legend] }),
+        item: slots.item({ class: [config.slots.item, ui?.item] }),
+        container: slots.container({ class: [config.slots.container, ui?.container] }),
+        wrapper: slots.wrapper({ class: [config.slots.wrapper, ui?.wrapper] })
+    }))
+
+    const elementClasses = $derived.by(() => ({
+        base: slots.base({ class: [config.slots.base, ui?.base] }),
+        indicator: slots.indicator({ class: [config.slots.indicator, ui?.indicator] }),
+        icon: slots.icon({ class: [config.slots.icon, ui?.icon] }),
+        label: slots.label({ class: [config.slots.label, ui?.label] }),
+        description: slots.description({ class: [config.slots.description, ui?.description] })
+    }))
+
+    function toggleItem(itemValue: string, checked: boolean) {
+        if (checked) {
+            value = [...value, itemValue]
+        } else {
+            value = value.filter((v) => v !== itemValue)
+        }
+        onValueChange?.(value)
+    }
+
+    function handleCardItemClick(e: MouseEvent, btnId: string, itemDisabled: boolean) {
+        if (itemDisabled) return
+        if ((e.target as Element).closest('button')) return
+        document.getElementById(btnId)?.click()
+    }
+</script>
+
+{#snippet itemContent(checkboxItem: CheckboxGroupItem)}
+    {@const itemId = `${resolvedId}-${checkboxItem.value}`}
+    {@const itemDisabled = isDisabled || !!checkboxItem.disabled}
+    <div class={layoutClasses.container}>
+        <Checkbox.Root
+            checked={value.includes(checkboxItem.value)}
+            onCheckedChange={(checked) => toggleItem(checkboxItem.value, checked)}
+            id={itemId}
+            name={resolvedName}
+            value={checkboxItem.value}
+            disabled={itemDisabled}
+            class={elementClasses.base}
+        >
+            {#snippet children({ checked: isChecked })}
+                {#if isChecked || loading}
+                    <span class={elementClasses.indicator}>
+                        <Icon name={loading ? loadingIcon : icon} class={elementClasses.icon} />
+                    </span>
+                {/if}
+            {/snippet}
+        </Checkbox.Root>
+    </div>
+
+    {#if checkboxItem.label || checkboxItem.description || labelSlot || descriptionSlot}
+        <div class={layoutClasses.wrapper}>
+            {#if labelSlot}
+                {@render labelSlot({ item: checkboxItem })}
+            {:else if checkboxItem.label}
+                {#if variant === 'card'}
+                    <span
+                        class={[elementClasses.label, itemDisabled && 'cursor-not-allowed']
+                            .filter(Boolean)
+                            .join(' ')}>{checkboxItem.label}</span
+                    >
+                {:else}
+                    <Label.Root
+                        for={itemId}
+                        class={[elementClasses.label, itemDisabled && 'cursor-not-allowed']
+                            .filter(Boolean)
+                            .join(' ')}
+                    >
+                        {checkboxItem.label}
+                    </Label.Root>
+                {/if}
+            {/if}
+
+            {#if descriptionSlot}
+                {@render descriptionSlot({ item: checkboxItem })}
+            {:else if checkboxItem.description}
+                <p
+                    class={[elementClasses.description, itemDisabled && 'cursor-not-allowed']
+                        .filter(Boolean)
+                        .join(' ')}
+                >
+                    {checkboxItem.description}
+                </p>
+            {/if}
+        </div>
+    {/if}
+{/snippet}
+
+<div {...restProps} bind:this={ref} class={layoutClasses.root}>
+    <fieldset class={layoutClasses.fieldset} aria-describedby={ariaDescribedBy}>
+        {#if legend || legendSlot}
+            {#if legendSlot}
+                {@render legendSlot({ legend })}
+            {:else}
+                <legend class={layoutClasses.legend}>{legend}</legend>
+            {/if}
+        {/if}
+
+        {#each items as checkboxItem (checkboxItem.value)}
+            {#if variant === 'card'}
+                <div
+                    role="none"
+                    class={layoutClasses.item}
+                    class:opacity-75={checkboxItem.disabled && !isDisabled}
+                    onclick={(e) =>
+                        handleCardItemClick(
+                            e,
+                            `${resolvedId}-${checkboxItem.value}`,
+                            isDisabled || !!checkboxItem.disabled
+                        )}
+                >
+                    {@render itemContent(checkboxItem)}
+                </div>
+            {:else}
+                <div
+                    class={layoutClasses.item}
+                    class:opacity-75={checkboxItem.disabled && !isDisabled}
+                >
+                    {@render itemContent(checkboxItem)}
+                </div>
+            {/if}
+        {/each}
+    </fieldset>
+</div>

package/dist/CheckboxGroup/CheckboxGroup.svelte.d.ts

@@ -0,0 +1,5 @@
+import type { CheckboxGroupProps } from './checkbox-group.types.js';
+export type Props = CheckboxGroupProps;
+declare const CheckboxGroup: import("svelte").Component<CheckboxGroupProps, {}, "ref" | "value">;
+type CheckboxGroup = ReturnType<typeof CheckboxGroup>;
+export default CheckboxGroup;

package/dist/CheckboxGroup/checkbox-group.types.d.ts

@@ -0,0 +1,130 @@
+import type { Snippet } from 'svelte';
+import type { HTMLAttributes } from 'svelte/elements';
+import type { ClassNameValue } from 'tailwind-merge';
+import type { CheckboxGroupVariantProps, CheckboxGroupSlots } from './checkbox-group.variants.js';
+export type CheckboxGroupItem = {
+    /**
+     * The unique value for this checkbox item.
+     */
+    value: string;
+    /**
+     * Label text displayed next to the checkbox.
+     */
+    label?: string;
+    /**
+     * Description text displayed below the label.
+     */
+    description?: string;
+    /**
+     * Whether this individual checkbox item is disabled.
+     * @default false
+     */
+    disabled?: boolean;
+};
+export type CheckboxGroupProps = Omit<HTMLAttributes<HTMLElement>, 'class'> & {
+    /**
+     * Bindable reference to the root DOM element.
+     */
+    ref?: HTMLElement | null;
+    /**
+     * The list of selected values. Supports two-way binding with `bind:value`.
+     * @default []
+     */
+    value?: string[];
+    /**
+     * Callback when the selected values change.
+     */
+    onValueChange?: (value: string[]) => void;
+    /**
+     * The list of checkbox items to render.
+     */
+    items?: CheckboxGroupItem[];
+    /**
+     * Sets the color scheme for the checkboxes.
+     * @default 'primary'
+     */
+    color?: NonNullable<CheckboxGroupVariantProps['color']>;
+    /**
+     * Controls the dimensions of the checkbox group.
+     * @default 'md'
+     */
+    size?: NonNullable<CheckboxGroupVariantProps['size']>;
+    /**
+     * Controls the visual style of each checkbox item.
+     * @default 'list'
+     */
+    variant?: NonNullable<CheckboxGroupVariantProps['variant']>;
+    /**
+     * Controls the position of the checkbox indicator.
+     * @default 'start'
+     */
+    indicator?: NonNullable<CheckboxGroupVariantProps['indicator']>;
+    /**
+     * Controls the layout direction of the items.
+     * @default 'vertical'
+     */
+    orientation?: NonNullable<CheckboxGroupVariantProps['orientation']>;
+    /**
+     * The name attribute for the checkbox inputs (used in form submission).
+     */
+    name?: string;
+    /**
+     * Whether the checkbox group is disabled.
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * Whether the checkbox group is required.
+     * @default false
+     */
+    required?: boolean;
+    /**
+     * Renders a loading spinner and disables interaction.
+     * @default false
+     */
+    loading?: boolean;
+    /**
+     * Icon displayed as the loading indicator.
+     * @default Uses `icons.loading` from app config
+     */
+    loadingIcon?: string;
+    /**
+     * Icon displayed when a checkbox is checked.
+     * @default Uses `icons.check` from app config
+     */
+    icon?: string;
+    /**
+     * Legend text displayed above the checkbox group.
+     */
+    legend?: string;
+    /**
+     * The HTML id attribute for the checkbox group.
+     */
+    id?: string;
+    /**
+     * Custom snippet for the legend.
+     */
+    legendSlot?: Snippet<[{
+        legend?: string;
+    }]>;
+    /**
+     * Custom snippet for each item's label.
+     */
+    labelSlot?: Snippet<[{
+        item: CheckboxGroupItem;
+    }]>;
+    /**
+     * Custom snippet for each item's description.
+     */
+    descriptionSlot?: Snippet<[{
+        item: CheckboxGroupItem;
+    }]>;
+    /**
+     * Additional CSS classes for the root element.
+     */
+    class?: ClassNameValue;
+    /**
+     * Override styles for specific checkbox group slots.
+     */
+    ui?: Partial<Record<CheckboxGroupSlots, ClassNameValue>>;
+};

package/dist/CheckboxGroup/checkbox-group.types.js

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