@naptics/vue-collection 0.2.15 → 0.3.1

package/src/lib/components/NBadge.tsx

@@ -0,0 +1,75 @@
+import { createComponent } from '../utils/component'
+import type { TWTextSize } from '../utils/tailwind'
+import type { PropType } from 'vue'
+import NTooltip, { mapTooltipProps, nToolTipPropsForImplementor } from './NTooltip'
+
+export const nBadgeProps = {
+    /**
+     * The text of the badge. Can alternatively be passed in the default slot.
+     */
+    text: String,
+    /**
+     * The text size, a standard tailwind text-size class.
+     */
+    textSize: {
+        type: String as PropType<TWTextSize>,
+        default: 'text-sm',
+    },
+    /**
+     * The color of the badge.
+     */
+    color: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * The background shade of the badge.
+     */
+    shade: {
+        type: Number,
+        default: 200,
+    },
+    /**
+     * The text shade of the badge.
+     */
+    textShade: {
+        type: Number,
+        default: 900,
+    },
+    /**
+     * If set to `true` the badges text is all-caps. Default is `true`.
+     */
+    allCaps: {
+        type: Boolean,
+        default: true,
+    },
+    /**
+     * Adds the classes to the badge.
+     * Use this instead of `class` to style the button, because the button is wrapped inside
+     * a div for the tooltip and `class` would be applied to the wrapping div.
+     */
+    badgeClass: String,
+    ...nToolTipPropsForImplementor,
+} as const
+
+/**
+ * The `NBadge` is a styled element to wrap a text.
+ */
+const Component = createComponent('NBadge', nBadgeProps, (props, { slots }) => {
+    return () => (
+        <NTooltip {...mapTooltipProps(props)}>
+            <div
+                class={[
+                    'px-2 py-1 rounded-md font-semibold shadow',
+                    `${props.textSize} bg-${props.color}-${props.shade} text-${props.color}-${props.textShade}`,
+                    props.allCaps ? 'uppercase' : '',
+                    props.badgeClass,
+                ]}
+            >
+                {slots.default?.() || props.text}
+            </div>
+        </NTooltip>
+    )
+})
+
+export { Component as NBadge, Component as default }

package/src/lib/components/NBreadcrub.tsx

@@ -0,0 +1,97 @@
+import { createComponentWithSlots } from '../utils/component'
+import type { HeroIcon } from '../utils/tailwind'
+import type { TWTextSize } from '../utils/tailwind'
+import { ChevronRightIcon } from '@heroicons/vue/24/solid'
+import type { RouteLocationRaw } from 'vue-router'
+import NLink from './NLink'
+import type { PropType } from 'vue'
+
+export const nBreadcrumbProps = {
+    /**
+     * The items of the breadcrumb.
+     */
+    items: {
+        type: Array as PropType<BreadcrumbItem[]>,
+        default: () => [],
+    },
+    /**
+     * The color of the breadcrumbs text and icons.
+     */
+    color: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * The text-size of the breadcrumb labels.
+     */
+    textSize: {
+        type: String as PropType<TWTextSize>,
+        default: 'text-base',
+    },
+    /**
+     * The icon which is used as a seperator between two breadcrumb items.
+     */
+    icon: {
+        type: Function as PropType<HeroIcon>,
+        default: ChevronRightIcon,
+    },
+    /**
+     * The size of the icon in tailwind units.
+     */
+    iconSize: {
+        type: Number,
+        default: 5,
+    },
+    /**
+     * Adds the classes to the separator icons.
+     */
+    iconClass: String,
+    /**
+     * A slot the replace the breadcrumb labels.
+     */
+    item: Function as PropType<(item: BreadcrumbItem, index: number) => JSX.Element>,
+    /**
+     * A slot to replace the separators between the breadcrumb labels.
+     * The passsed item is the item before the seperator.
+     */
+    seperator: Function as PropType<(item: BreadcrumbItem, index: number) => JSX.Element>,
+} as const
+
+export type BreadcrumbItem = {
+    /**
+     * The visible label of the breadcrumb item.
+     */
+    label: string
+    /**
+     * The route the breadcrumb item points to.
+     */
+    route: RouteLocationRaw
+}
+
+/**
+ * The `NBreadcrumb` is a styled breadcrumb which can be used as a navigation in hierarchical views.
+ */
+const Component = createComponentWithSlots('NBreadcrumb', nBreadcrumbProps, ['seperator', 'item'], props => {
+    return () => (
+        <div class={`flex flex-wrap items-center`}>
+            {props.items.map((item, index) => (
+                <>
+                    {props.item?.(item, index) || (
+                        <NLink textSize={props.textSize} route={item.route} color={props.color}>
+                            {item.label}
+                        </NLink>
+                    )}
+
+                    {index < props.items.length - 1 &&
+                        (props.seperator?.(item, index) || (
+                            <props.icon
+                                class={`mx-2 w-${props.iconSize} h-${props.iconSize} text-${props.color}-500 ${props.iconClass}`}
+                            />
+                        ))}
+                </>
+            ))}
+        </div>
+    )
+})
+
+export { Component as NBreadcrumb, Component as default }

package/src/lib/components/NButton.tsx

@@ -0,0 +1,80 @@
+import { createComponent } from '../utils/component'
+import { computed, type PropType } from 'vue'
+import NLoadingIndicator from './NLoadingIndicator'
+import NTooltip, { mapTooltipProps, nToolTipPropsForImplementor } from './NTooltip'
+
+export const nButtonProps = {
+    /**
+     * The color of the button.
+     */
+    color: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * The html attribute, which indicates the type of the button.
+     */
+    type: {
+        type: String as PropType<'submit' | 'button' | 'reset'>,
+        default: 'button',
+    },
+    /**
+     * If set to `true` the button is disabled and no interaction is possible.
+     */
+    disabled: Boolean,
+    /**
+     * If set to `true` the button will show a loading animation.
+     * Setting `loading` to `true` will also disable the button.
+     */
+    loading: Boolean,
+    /**
+     * If set to `true` the button will appear smaller.
+     */
+    small: Boolean,
+    /**
+     * Adds the classes to the button.
+     * Use this instead of `class` to style the button, because the button is wrapped inside
+     * a div for the tooltip and `class` would be applied to the wrapping div.
+     */
+    buttonClass: String,
+    /**
+     * This is called, when the button is clicked.
+     */
+    onClick: Function as PropType<() => void>,
+    ...nToolTipPropsForImplementor,
+} as const
+
+/**
+ * The `NButton` is a styled button.
+ */
+const Component = createComponent('NButton', nButtonProps, (props, { slots }) => {
+    const isDisabled = computed(() => props.loading || props.disabled)
+
+    return () => (
+        <NTooltip {...mapTooltipProps(props)}>
+            <button
+                disabled={isDisabled.value}
+                type={props.type}
+                class={[
+                    `block w-full font-medium rounded-md focus:outline-none focus-visible:ring-2 shadow text-${props.color}-900 relative`,
+                    isDisabled.value
+                        ? `bg-${props.color}-100 text-opacity-20 cursor-default`
+                        : `bg-${props.color}-200 hover:bg-${props.color}-300 focus-visible:ring-${props.color}-500`,
+
+                    props.small ? 'py-1 px-2 text-xs' : 'py-2 px-4 text-sm',
+                    props.buttonClass,
+                ]}
+                onClick={props.onClick}
+            >
+                <span class={{ 'opacity-10': props.loading }}>{slots.default?.()}</span>
+                {props.loading && (
+                    <div class="absolute inset-0 flex items-center justify-center opacity-50">
+                        <NLoadingIndicator color={props.color} size={props.small ? 4 : 6} shade={600} />
+                    </div>
+                )}
+            </button>
+        </NTooltip>
+    )
+})
+
+export { Component as NButton, Component as default }

package/src/lib/components/NCheckbox.tsx

@@ -0,0 +1,55 @@
+import { createComponent } from '../utils/component'
+import { vModelProps } from '../utils/vModel'
+import { nextTick, ref } from 'vue'
+
+export const nCheckboxProps = {
+    ...vModelProps(Boolean),
+    /**
+     * The color of the checkbox.
+     */
+    color: {
+        type: String,
+        default: 'primary',
+    },
+    /**
+     * If set to `true` the checkbox is disabled and no interaction is possible.
+     */
+    disabled: Boolean,
+} as const
+
+/**
+ * The `NCheckbox` is a styled checkbox.
+ */
+const Component = createComponent('NCheckbox', nCheckboxProps, props => {
+    const toggle = () => {
+        props.onUpdateValue?.(!props.value)
+        forceUpdate()
+    }
+
+    const checkBoxRef = ref<InstanceType<typeof HTMLElement>>()
+
+    const updateKey = ref(0)
+    const forceUpdate = () => {
+        updateKey.value += 1
+        nextTick(() => checkBoxRef.value?.focus())
+    }
+
+    return () => (
+        <input
+            type="checkbox"
+            ref={checkBoxRef}
+            checked={props.value}
+            disabled={props.disabled}
+            onClick={toggle}
+            key={updateKey.value}
+            class={[
+                `h-5 w-5 border-default-300 rounded focus:outline-none focus:ring-0 focus-visible:ring-2 focus-visible:ring-${props.color}-500`,
+                props.disabled
+                    ? `cursor-default bg-default-100 text-${props.color}-200`
+                    : `cursor-pointer text-${props.color}-400`,
+            ]}
+        />
+    )
+})
+
+export { Component as NCheckbox, Component as default }

package/src/lib/components/NCheckboxLabel.tsx

@@ -0,0 +1,51 @@
+import { createComponent } from '../utils/component'
+import NCheckbox, { nCheckboxProps } from './NCheckbox'
+
+export const nCheckboxLabelProps = {
+    ...nCheckboxProps,
+    /**
+     * The title of the checkbox.
+     */
+    title: String,
+    /**
+     * The description of the checkbox.
+     */
+    description: String,
+    /**
+     * If set to `true`, a smaller margin is applied between the label and the checkbox.
+     */
+    compact: Boolean,
+} as const
+
+/**
+ * The `NCheckboxLabel` is a checkbox with a title and a description.
+ */
+const Component = createComponent('NCheckboxLabel', nCheckboxLabelProps, props => {
+    const toggleValue = () => {
+        if (!props.disabled) props.onUpdateValue?.(!props.value)
+    }
+
+    return () => (
+        <div class={`flex ${props.description ? 'items-start' : 'items-center'}`}>
+            <NCheckbox {...props} class={props.description ? 'mt-1' : ''} />
+            <div class={`${props.compact ? 'ml-2' : 'ml-3'} text-sm`}>
+                <label
+                    onClick={toggleValue}
+                    class={[
+                        'font-medium select-none',
+                        props.disabled ? 'text-default-300' : 'text-default-700 cursor-pointer',
+                    ]}
+                >
+                    {props.title}
+                </label>
+                <p class={props.disabled ? 'text-default-300' : 'text-default-500'}>
+                    <span onClick={toggleValue} class={['select-none', props.disabled ? '' : 'cursor-pointer']}>
+                        {props.description}
+                    </span>
+                </p>
+            </div>
+        </div>
+    )
+})
+
+export { Component as NCheckboxLabel, Component as default }

package/src/lib/components/NCrudModal.tsx

@@ -0,0 +1,133 @@
+import { trsl } from '../i18n'
+import { createComponentWithSlots } from '../utils/component'
+import { ref, type PropType } from 'vue'
+import NButton from './NButton'
+import type { DialogVariant, NDialogExposed } from './NDialog'
+import NDialog from './NDialog'
+import NFormModal, { nFormModalProps } from './NFormModal'
+
+export const nCrudModalProps = {
+    ...nFormModalProps,
+    /**
+     * The text of the remove-button.
+     */
+    removeText: {
+        type: String,
+        default: trsl('vue-collection.action.remove'),
+    },
+    /**
+     * The color of the remove-button.
+     */
+    removeColor: {
+        type: String,
+        default: 'red',
+    },
+    /**
+     * If set to `true` the remove-button is disabled.
+     */
+    removeDisabled: Boolean,
+    /**
+     * If set to `true` the ok-button is hidden.
+     */
+    hideRemove: Boolean,
+    /**
+     * If set to `true` the ok-button is disabled.
+     */
+    okDisabled: Boolean,
+    /**
+     * The title of the dialog which appears when clicking on the remove-button.
+     */
+    removeDialogTitle: String,
+    /**
+     * The text of the dialog which appears when clicking on the remove-button.
+     */
+    removeDialogText: String,
+    /**
+     * The variant of the dialog which appears when clicking on the remove-button. Default is `remove`.
+     */
+    removeDialogVariant: {
+        type: String as PropType<DialogVariant>,
+        default: 'remove',
+    },
+    /**
+     * The text of the dialog's ok-button. Is already set by the `removeDialogVariant` but can be overridden.
+     */
+    removeDialogOkText: String,
+    /**
+     * If set to `true` the modal will close itself when `onRemove` is called.
+     */
+    closeOnRemove: {
+        type: Boolean,
+        default: true,
+    },
+    /**
+     * This is called, when the remove-button has been clicked and the dialog has been accepted.
+     */
+    onRemove: Function as PropType<() => void>,
+} as const
+
+/**
+ * The `NCrudModal` is a {@link NFormModal} which has some convenience features for a CRUD-scenario.
+ * It has an integrated remove-button with a user-dialog to remove the editing element.
+ * When the dialog is accepted `onRemove` is called.
+ */
+const Component = createComponentWithSlots(
+    'NCrudModal',
+    nCrudModalProps,
+    ['modal', 'footer', 'header'],
+    (props, { slots }) => {
+        const removeDialog = ref<NDialogExposed>()
+
+        const remove = () => {
+            removeDialog.value?.show().then(result => {
+                if (result) {
+                    props.onRemove?.()
+                    if (props.closeOnRemove) props.onUpdateValue?.(false)
+                }
+            })
+        }
+
+        return () => (
+            <NFormModal
+                {...props}
+                footer={
+                    props.footer ||
+                    (({ ok, cancel }) => (
+                        <div class="flex justify-between">
+                            <div>
+                                {!props.hideRemove && (
+                                    <NButton color={props.removeColor} onClick={remove} disabled={props.removeDisabled}>
+                                        {props.removeText}
+                                    </NButton>
+                                )}
+                            </div>
+                            <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>
+                    ))
+                }
+            >
+                {slots.default?.()}
+                <NDialog
+                    ref={removeDialog}
+                    variant={props.removeDialogVariant}
+                    title={props.removeDialogTitle}
+                    text={props.removeDialogText}
+                    okText={props.removeDialogOkText}
+                />
+            </NFormModal>
+        )
+    }
+)
+
+export { Component as NCrudModal, Component as default }

package/src/lib/components/NDialog.tsx

@@ -0,0 +1,182 @@
+import { deferred, type DeferredPromise } from '../utils/deferred'
+import { createComponent, extractProps } from '../utils/component'
+import { CheckIcon, ExclamationTriangleIcon, LightBulbIcon, TrashIcon } from '@heroicons/vue/24/outline'
+import { computed, ref, type PropType } from 'vue'
+import NIconCircle from './NIconCircle'
+import NModal from './NModal'
+import { DialogTitle } from '@headlessui/vue'
+import type { HeroIcon } from '../utils/tailwind'
+import { trsl } from '../i18n'
+import { vModelForRef } from '../utils/vModel'
+
+export type DialogVariant = 'success' | 'info' | 'warning' | 'danger' | 'remove'
+
+export const nDialogProps = {
+    /**
+     * The title of the dialog.
+     */
+    title: String,
+    /**
+     * The text of the dialog.
+     */
+    text: String,
+    /**
+     * The variant of the dialog.
+     * This determines the default icon and its color
+     * as well as the default text and color of the ok-button.
+     */
+    variant: {
+        type: String as PropType<DialogVariant>,
+        default: 'warning',
+    },
+    /**
+     * The icon of the alert. This overrides the `icon` of the `variant`.
+     */
+    icon: Function as PropType<HeroIcon>,
+    /**
+     * The color of the alert's icon. This overrides the `iconColor` of the `variant`.
+     */
+    iconColor: String,
+    /**
+     * The text of the ok-button. This overrides the `okText` of the `variant`.
+     */
+    okText: String,
+    /**
+     * The color of the ok-button. This overrides the `okColor` of the `variant`.
+     */
+    okColor: String,
+    /**
+     * 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 cancel-button is hidden.
+     */
+    hideCancel: Boolean,
+}
+
+export type NDialogExposed = {
+    /**
+     * Shows the alert and returns a promise.
+     * When the user interaction occurs the promise is resolved.
+     * It is resolved to `true` if the okButton was clicked, `false` if the dialog was cancelled.
+     */
+    show(): Promise<boolean>
+}
+
+/**
+ * A `NDialog` is an element to interact directly with the user.
+ * It can be controlled via a ref to prompt the user and to receive their answer.
+ * @example
+ * const dialogRef = ref<NDialogExposed>()
+ * ...
+ * const onShowDialog = () => {
+ *   dialofRef.value?.show().then(result => {
+ *     if (result)   // dialog accepted
+ *     else          // dialog cancelled
+ *   })
+ * }
+ * ...
+ * <NDialog ref={dialogRef} />
+ */
+const Component = createComponent('NDialog', nDialogProps, (props, context) => {
+    const showDialog = ref(false)
+
+    let deferredPromise: DeferredPromise<boolean> | null = null
+    const show = (): Promise<boolean> => {
+        if (deferredPromise != null) {
+            deferredPromise.reject('show() was called on the open dialog.')
+            deferredPromise = null
+        }
+        showDialog.value = true
+        deferredPromise = deferred<boolean>()
+        return deferredPromise.promise
+    }
+
+    context.expose({ show })
+
+    const resolveWith = (result: boolean) => {
+        deferredPromise?.resolve(result)
+        deferredPromise = null
+    }
+
+    const ok = () => resolveWith(true)
+    const cancel = () => resolveWith(false)
+
+    const defaults = computed(() => VARIANT_DEFAULTS[props.variant])
+
+    return () => (
+        <NModal
+            {...vModelForRef(showDialog)}
+            {...extractProps(props, 'cancelColor', 'cancelText', 'hideCancel')}
+            onOk={ok}
+            onCancel={cancel}
+            okColor={props.okColor || defaults.value.okColor}
+            okText={props.okText || defaults.value.okText}
+            hideX
+            hideHeader
+        >
+            <div class="flex space-x-4 py-2">
+                <div class="flex-grow-0">
+                    <NIconCircle
+                        icon={props.icon || defaults.value.icon}
+                        iconSize={6}
+                        color={props.iconColor || defaults.value.iconColor}
+                    />
+                </div>
+
+                <div class="flex-grow">
+                    <DialogTitle as="h4" class="font-medium text-lg text-default-700 mb-1">
+                        {props.title}
+                    </DialogTitle>
+                    {context.slots.default?.() || <p class="text-sm text-default-500">{props.text}</p>}
+                </div>
+            </div>
+        </NModal>
+    )
+})
+
+const VARIANT_DEFAULTS = {
+    success: {
+        icon: CheckIcon,
+        iconColor: 'green',
+        okText: trsl('vue-collection.action.all-right'),
+        okColor: 'green',
+    },
+    info: {
+        icon: LightBulbIcon,
+        iconColor: 'blue',
+        okText: trsl('vue-collection.action.all-right'),
+        okColor: 'blue',
+    },
+    warning: {
+        icon: ExclamationTriangleIcon,
+        iconColor: 'yellow',
+        okText: trsl('vue-collection.action.proceed'),
+        okColor: 'yellow',
+    },
+    danger: {
+        icon: ExclamationTriangleIcon,
+        iconColor: 'red',
+        okText: trsl('vue-collection.action.proceed'),
+        okColor: 'red',
+    },
+    remove: {
+        icon: TrashIcon,
+        iconColor: 'red',
+        okText: trsl('vue-collection.action.remove'),
+        okColor: 'red',
+    },
+}
+
+export { Component as NDialog, Component as default }