@naptics/vue-collection 0.2.14 → 0.3.0

package/src/lib/components/NLink.tsx

@@ -0,0 +1,68 @@
+import { createComponent } from '../utils/component'
+import type { TWTextSize } from '../utils/tailwind'
+import { computed, type PropType } from 'vue'
+import { RouterLink, type RouteLocationRaw } from 'vue-router'
+
+export const nLinkProps = {
+    /**
+     * The text of the link. Can also be set in the default slot.
+     */
+    text: String,
+    /**
+     * The route of the link. If this is set,
+     * the link becomes a {@link RouterLink} and does not emit the `onClick` event.
+     */
+    route: [Object, String] as PropType<RouteLocationRaw>,
+    /**
+     * The color of the link.
+     */
+    color: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * The text size, a standard tailwind text-size class.
+     */
+    textSize: String as PropType<TWTextSize>,
+    /**
+     * The shade of the link.
+     */
+    shade: {
+        type: Number,
+        default: 500,
+    },
+    /**
+     * This is called when the link is clicked but only, if the `route` prop is not set.
+     * If the `route` prop is not set, the link will act as a regular button.
+     */
+    onClick: Function as PropType<() => void>,
+} as const
+
+/**
+ * The `NLink` is a styled text which can be used as a {@link RouterLink} or a regular button.
+ */
+const Component = createComponent('NLink', nLinkProps, (props, { slots }) => {
+    const hoverShade = computed(() => {
+        const shade = props.shade
+        if (shade <= 500) return shade + 100
+        else return shade - 200
+    })
+
+    const classes = computed(() => [
+        'font-medium focus:outline-none focus-visible:ring-2 rounded-sm ring-offset-2 hover:underline text-left',
+        `${props.textSize} text-${props.color}-${props.shade} hover:text-${props.color}-${hoverShade.value} focus-visible:ring-${props.color}-${props.shade}`,
+    ])
+
+    return () =>
+        props.route ? (
+            <RouterLink to={props.route} class={classes.value}>
+                {slots.default?.() || props.text}
+            </RouterLink>
+        ) : (
+            <button onClick={props.onClick} class={classes.value}>
+                {slots.default?.() || props.text}
+            </button>
+        )
+})
+
+export { Component as NLink, Component as default }

package/src/lib/components/NList.tsx

@@ -0,0 +1,67 @@
+import { createComponent } from '../utils/component'
+import type { PropType } from 'vue'
+
+export type ListItem = {
+    /**
+     * The title of the item. Accepts either string or a function returning a JSX element.
+     */
+    title: string | (() => JSX.Element)
+    /**
+     * The text of the item. Accepts either string or a function returning a JSX element.
+     */
+    text?: string | (() => JSX.Element)
+}
+
+export const nListProps = {
+    /**
+     * The items which are displayed in the list.
+     */
+    items: {
+        type: Array as PropType<ListItem[]>,
+        default: () => [],
+    },
+    /**
+     * Adds the classes to all title elements (on the left side).
+     */
+    titleClass: String,
+    /**
+     * Adds the classes to all text elements (on the right side).
+     */
+    textClass: String,
+    /**
+     * Adds the classes to each row.
+     */
+    rowClass: String,
+} as const
+
+/**
+ * The `NList` displays key-value data in an appealing way.
+ */
+const Component = createComponent('NList', nListProps, props => {
+    return () => (
+        <dl>
+            {props.items.map((item, index) => (
+                <div
+                    key={index}
+                    class={[
+                        'py-5 px-4 sm:grid sm:grid-cols-3 sm:gap-4',
+                        index % 2 === 1 ? 'bg-white' : 'bg-default-50',
+                        props.rowClass,
+                    ]}
+                >
+                    <dt class={`text-sm font-medium text-default-500 ${props.titleClass}`}>
+                        {buildElement(item.title)}
+                    </dt>
+                    <dd class={`mt-1 text-sm sm:mt-0 sm:col-span-2 ${props.textClass}`}>{buildElement(item.text)}</dd>
+                </div>
+            ))}
+        </dl>
+    )
+})
+
+export { Component as NList, Component as default }
+
+function buildElement(element: string | undefined | (() => JSX.Element)): JSX.Element {
+    if (typeof element === 'function') return element()
+    else return <>{element}</>
+}

package/src/lib/components/NLoadingIndicator.css

@@ -0,0 +1,46 @@
+.lds-ellipsis {
+    position: relative;
+}
+
+.lds-ellipsis div {
+    position: absolute;
+    border-radius: 50%;
+    animation-timing-function: cubic-bezier(0, 1, 1, 0);
+}
+
+.lds-ellipsis div:nth-child(1) {
+    animation: lds-ellipsis1 0.6s infinite;
+}
+.lds-ellipsis div:nth-child(2) {
+    animation: lds-ellipsis2 0.6s infinite;
+}
+.lds-ellipsis div:nth-child(3) {
+    animation: lds-ellipsis2 0.6s infinite;
+}
+.lds-ellipsis div:nth-child(4) {
+    animation: lds-ellipsis3 0.6s infinite;
+}
+@keyframes lds-ellipsis1 {
+    0% {
+        transform: scale(0);
+    }
+    100% {
+        transform: scale(1);
+    }
+}
+@keyframes lds-ellipsis3 {
+    0% {
+        transform: scale(1);
+    }
+    100% {
+        transform: scale(0);
+    }
+}
+@keyframes lds-ellipsis2 {
+    0% {
+        transform: translate(0, 0);
+    }
+    100% {
+        transform: translate(var(--n-loading-indicator-gap), 0);
+    }
+}

package/src/lib/components/NLoadingIndicator.tsx

@@ -0,0 +1,63 @@
+import { createComponent } from '../utils/component'
+import { computed, useCssVars } from 'vue'
+import './NLoadingIndicator.css'
+
+export const nLoadingIndicator = {
+    /**
+     * The color of the loading-indicator.
+     */
+    color: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * The shade of the loading-indicator.
+     */
+    shade: {
+        type: Number,
+        default: 400,
+    },
+    /**
+     * The height of the loading-indicator in px.
+     */
+    size: {
+        type: Number,
+        default: 10,
+    },
+} as const
+
+/**
+ * The `NLoadingIndicator` is a styled loading indicator.
+ */
+const Component = createComponent('NLoadingIndicator', nLoadingIndicator, props => {
+    const gap = computed(() => (props.size / 13) * 24)
+
+    const totalWidth = computed(() => gap.value * 2 + props.size)
+
+    useCssVars(() => ({
+        'n-loading-indicator-gap': `${gap.value}px`,
+    }))
+
+    return () => (
+        <div class="lds-ellipsis" style={`height:${props.size}px;width:${totalWidth.value}px`}>
+            <div
+                class={`bg-${props.color}-${props.shade}`}
+                style={`height:${props.size}px;width:${props.size}px;left:0px`}
+            />
+            <div
+                class={`bg-${props.color}-${props.shade}`}
+                style={`height:${props.size}px;width:${props.size}px;left:0px`}
+            />
+            <div
+                class={`bg-${props.color}-${props.shade}`}
+                style={`height:${props.size}px;width:${props.size}px;left:${gap.value}px`}
+            />
+            <div
+                class={`bg-${props.color}-${props.shade}`}
+                style={`height:${props.size}px;width:${props.size}px;left:${2 * gap.value}px`}
+            />
+        </div>
+    )
+})
+
+export { Component as NLoadingIndicator, Component as default }

package/src/lib/components/NModal.tsx

@@ -0,0 +1,243 @@
+import { createComponentWithSlots } from '../utils/component'
+import type { PropType } from 'vue'
+import { Dialog, DialogOverlay, DialogTitle, TransitionRoot, TransitionChild } from '@headlessui/vue'
+import NButton from './NButton'
+import NIconButton from './NIconButton'
+import { XMarkIcon } from '@heroicons/vue/24/solid'
+import { trsl } from '../i18n'
+import type { TWMaxWidth } from '../utils/tailwind'
+import { vModelProps } from '../utils/vModel'
+
+export const nModalProps = {
+    ...vModelProps(Boolean),
+    /**
+     * If set to `true` the header of the modal is hidden.
+     */
+    hideHeader: Boolean,
+    /**
+     * If set to `true` the footer of the modal is hidden.
+     */
+    hideFooter: Boolean,
+    /**
+     * If set to `true` the X-button in the top right is hidden.
+     */
+    hideX: Boolean,
+    /**
+     * The maximum width of the modal. A regular tailwind class.
+     */
+    maxWidth: {
+        type: String as PropType<TWMaxWidth>,
+        default: 'max-w-md',
+    },
+    /**
+     * The vertical position of the modal. Default is `center`.
+     */
+    verticalPosition: {
+        type: String as PropType<'start' | 'center' | 'end'>,
+        default: 'center',
+    },
+    /**
+     * The horizontal position of the modal. Default is `center`.
+     */
+    horizontalPosition: {
+        type: String as PropType<'start' | 'center' | 'end'>,
+        default: 'center',
+    },
+    /**
+     * The title of the modal which is displayed in the header.
+     */
+    title: String,
+    /**
+     * The text of the ok-button.
+     */
+    okText: {
+        type: String,
+        default: trsl('vue-collection.action.save'),
+    },
+    /**
+     * The color of the ok-button.
+     */
+    okColor: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * If set to `true` the modal is closed when `onOk` is called.
+     */
+    closeOnOk: {
+        type: Boolean,
+        default: true,
+    },
+    /**
+     * If set to `true` the ok-button is hidden.
+     */
+    hideOk: Boolean,
+    /**
+     * If set to `true` the ok-button is disabled.
+     */
+    okDisabled: Boolean,
+    /**
+     * The text of the cancel-button.
+     */
+    cancelText: {
+        type: String,
+        default: trsl('vue-collection.action.cancel'),
+    },
+    /**
+     * The color of the cancel-button.
+     */
+    cancelColor: {
+        type: String,
+        default: 'default',
+    },
+    /**
+     * If set to `true`, the modal is closed when clicking on the background.
+     * This will call `onCancel`. Default is `true`.
+     */
+    closeOnBackground: {
+        type: Boolean,
+        default: true,
+    },
+    /**
+     * If set to `true` the cancel-button is hidden.
+     */
+    hideCancel: Boolean,
+    /**
+     * This is called when the ok-button was clicked.
+     */
+    onOk: Function as PropType<() => void>,
+    /**
+     * This is called when the cancel-button or X-button was clicked or
+     * if the modal was closed by clicking on the background.
+     */
+    onCancel: Function as PropType<() => void>,
+    /**
+     * A slot to replace the whole modal content including all buttons, header and footer.
+     */
+    modal: Function as PropType<(props: ModalSlotProps) => JSX.Element>,
+    /**
+     * A slot to replace the whole content section, i.e. everything between the header and the footer.
+     */
+    content: Function as PropType<(props: ModalSlotProps) => JSX.Element>,
+    /**
+     * A slot to replace the whole header section (excluding the x).
+     */
+    header: Function as PropType<() => JSX.Element>,
+    /**
+     * A slot to replace the whole footer section.
+     */
+    footer: Function as PropType<(props: ModalSlotProps) => JSX.Element>,
+} as const
+
+export type ModalSlotProps = { ok: () => void; cancel: () => void }
+
+/**
+ * The `NModal` is the base component for all modals and dialogs.
+ * It provides the core mechanics to display a window in front of everything else.
+ */
+const Component = createComponentWithSlots('NModal', nModalProps, ['modal', 'header', 'footer'], (props, { slots }) => {
+    const ok = () => {
+        props.onOk?.()
+        if (props.closeOnOk) props.onUpdateValue?.(false)
+    }
+
+    const cancel = () => {
+        props.onCancel?.()
+        props.onUpdateValue?.(false)
+    }
+
+    return () => (
+        <TransitionRoot as="template" show={props.value}>
+            <Dialog as="div" static class="fixed z-40 inset-0 overflow-y-auto" onClose={cancel} open={props.value}>
+                <div class={`flex items-${props.verticalPosition} justify-${props.horizontalPosition} min-h-screen`}>
+                    <TransitionChild
+                        as="template"
+                        enter="ease-out duration-300"
+                        enter-from="opacity-0"
+                        enter-to="opacity-100"
+                        leave="ease-in duration-200"
+                        leave-from="opacity-100"
+                        leave-to="opacity-0"
+                    >
+                        {props.closeOnBackground ? (
+                            <DialogOverlay class="fixed inset-0 bg-default-700 bg-opacity-75" />
+                        ) : (
+                            <div class="fixed inset-0 bg-default-700 bg-opacity-75" />
+                        )}
+                    </TransitionChild>
+
+                    {/* This element is to trick the browser into centering the modal contents. */}
+                    <span class="hidden align-middle h-screen" aria-hidden="true">
+                        &#8203;
+                    </span>
+
+                    <TransitionChild
+                        as="template"
+                        enter="ease-out duration-300"
+                        enter-from="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"
+                        enter-to="opacity-100 translate-y-0 sm:scale-100"
+                        leave="ease-in duration-200"
+                        leave-from="opacity-100 translate-y-0 sm:scale-100"
+                        leave-to="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"
+                    >
+                        <div class={['transform m-4 w-full align-middle', props.maxWidth]}>
+                            {props.modal?.({ ok, cancel }) || (
+                                <div
+                                    class={[
+                                        'shadow-xl rounded-lg bg-white divide-y divide-default-100',
+                                        props.maxWidth,
+                                    ]}
+                                >
+                                    {!props.hideX && (
+                                        <div class="sm:block absolute top-0 right-0 mt-3 mr-3">
+                                            <NIconButton icon={XMarkIcon} color="default" size={5} onClick={cancel} />
+                                        </div>
+                                    )}
+
+                                    {!props.hideHeader && (
+                                        <div class="px-4 sm:px-6 pt-4 pb-2 bg-default-50 rounded-t-lg">
+                                            {props.header?.() || (
+                                                <DialogTitle as="h4" class="text-lg font-semibold">
+                                                    {props.title}
+                                                </DialogTitle>
+                                            )}
+                                        </div>
+                                    )}
+
+                                    {props.content?.({ ok, cancel }) || (
+                                        <div class="px-4 sm:px-6 py-4 rounded-lg">{slots.default?.()}</div>
+                                    )}
+
+                                    {!props.hideFooter && (
+                                        <div class="px-4 sm:px-6 pb-4 pt-2 bg-default-50 rounded-b-lg">
+                                            {props.footer?.({ ok, cancel }) || (
+                                                <div class="flex justify-end space-x-2">
+                                                    {!props.hideCancel && (
+                                                        <NButton color={props.cancelColor} onClick={cancel}>
+                                                            {props.cancelText}
+                                                        </NButton>
+                                                    )}
+                                                    {!props.hideOk && (
+                                                        <NButton
+                                                            color={props.okColor}
+                                                            onClick={ok}
+                                                            disabled={props.okDisabled}
+                                                        >
+                                                            {props.okText}
+                                                        </NButton>
+                                                    )}
+                                                </div>
+                                            )}
+                                        </div>
+                                    )}
+                                </div>
+                            )}
+                        </div>
+                    </TransitionChild>
+                </div>
+            </Dialog>
+        </TransitionRoot>
+    )
+})
+
+export { Component as NModal, Component as default }

package/src/lib/components/NPagination.css

@@ -0,0 +1,15 @@
+.pagination-item {
+    @apply h-9 w-9 text-sm inline-flex items-center justify-center border font-medium border-default-300 text-default-500;
+}
+
+.pagination-item.not-small {
+    @apply sm:w-11;
+}
+
+.pagination-item.selectable {
+    @apply hover:bg-default-50 focus:outline-none focus-visible:border-primary-500 focus-visible:ring-primary-500 focus-visible:ring-1 focus-visible:z-[2];
+}
+
+.pagination-item.selectable.selected {
+    @apply border-primary-500 bg-primary-100 hover:bg-primary-100 text-primary-600 z-[1];
+}

package/src/lib/components/NPagination.tsx

@@ -0,0 +1,131 @@
+import { createComponent } from '../utils/component'
+import { ChevronLeftIcon, ChevronRightIcon } from '@heroicons/vue/24/solid'
+import { computed, watch, type ComputedRef, type PropType } from 'vue'
+import './NPagination.css'
+
+export const nPaginationProps = {
+    /**
+     * The page number which is currently selected.
+     */
+    value: {
+        type: Number,
+        default: () => 1,
+    },
+    /**
+     * This is called, when a new page number has been selected.
+     */
+    onUpdateValue: Function as PropType<(newValue: number) => void>,
+    /**
+     * The total pages which exists. This is needed to correctly display the selectable pages.
+     */
+    total: {
+        type: Number,
+        default: () => 1,
+    },
+    /**
+     * If set to `true`, the pagination is displayed smaller.
+     */
+    small: Boolean,
+    /**
+     * This is called, when the visible pages, which are selectable in the pagination, have changed.
+     * This is useful as only these pages can be navigated to on the next click.
+     * This information can be useful for prefetching.
+     */
+    onVisiblePagesChanged: Function as PropType<(visiblePages: number[]) => void>,
+} as const
+
+/**
+ * The `NPagination` is a styled pagination component.
+ */
+const Component = createComponent('NPagination', nPaginationProps, props => {
+    const numbers = computed(() => {
+        if (props.total <= 7) {
+            return range(1, props.total)
+        } else if (props.value <= 4) {
+            return [...range(1, 5), -1, props.total]
+        } else if (props.value >= props.total - 3) {
+            return [1, -1, ...range(props.total - 4, props.total)]
+        } else {
+            return [1, -1, ...range(props.value - 1, props.value + 1), -1, props.total]
+        }
+    })
+
+    watch(
+        () => numbers.value,
+        () => {
+            const visiblePages = numbers.value.filter(value => value != -1)
+            props.onVisiblePagesChanged?.(visiblePages)
+        },
+        { immediate: true }
+    )
+
+    const clickedNumber = (value: number) => {
+        if (value <= props.total && value >= 1) props.onUpdateValue?.(value)
+    }
+    const next = () => clickedNumber(props.value + 1)
+    const previous = () => clickedNumber(props.value - 1)
+
+    const items: ComputedRef<PaginationItem[]> = computed(() =>
+        numbers.value.map(number => {
+            if (number == -1) return { label: '...', selectable: false, selected: false }
+            else
+                return {
+                    label: `${number}`,
+                    selectable: true,
+                    selected: number == props.value,
+                    click: () => clickedNumber(number),
+                }
+        })
+    )
+
+    const classesForItem = (item: PaginationItem) => [
+        'pagination-item',
+        item.selectable ? 'selectable ' : '',
+        item.selected ? 'selected' : '',
+        props.small ? '' : 'not-small',
+    ]
+
+    return () => (
+        <nav class="inline-flex rounded-md shadow -space-x-px">
+            <button
+                class={['pagination-item selectable rounded-l-md', props.small ? '' : 'not-small']}
+                onClick={previous}
+            >
+                <ChevronLeftIcon class="h-5 w-5" aria-hidden="true" />
+            </button>
+
+            {items.value.map((item, index) =>
+                item.selectable ? (
+                    <button key={index} class={classesForItem(item)} onClick={item.click}>
+                        {item.label}
+                    </button>
+                ) : (
+                    <div key={index} class={classesForItem(item)}>
+                        {item.label}
+                    </div>
+                )
+            )}
+
+            <button class={['pagination-item selectable rounded-r-md', props.small ? '' : 'not-small']} onClick={next}>
+                <ChevronRightIcon class="h-5 w-5" aria-hidden="true" />
+            </button>
+        </nav>
+    )
+})
+
+export { Component as NPagination, Component as default }
+
+type PaginationItem = {
+    label: string
+    selectable: boolean
+    selected: boolean
+    click?: () => void
+}
+
+function range(from: number, to: number): number[] {
+    const array: number[] = []
+    for (let i = from; i <= to; i++) {
+        array.push(i)
+    }
+    return array
+}