@naptics/vue-collection 0.0.3 → 0.0.5

package/components/NTooltip.js

@@ -0,0 +1,178 @@
+import { withDirectives as _withDirectives, vShow as _vShow, Fragment as _Fragment, createVNode as _createVNode } from "vue";
+import { createComponent, createProps } from '../utils/component';
+import { uniqueId } from '../utils/utils';
+import { computed, onMounted, ref, watch, onUnmounted, Transition } from 'vue';
+import { createPopper } from '@popperjs/core';
+import { watchRef } from '../utils/vue';
+import './NTooltip.css';
+export const nTooltipProps = createProps({
+  /**
+   * The text content of the tooltip.
+   */
+  text: String,
+  /**
+   * A slot to replace the content of the tooltip. This will override the `text` prop.
+   */
+  content: Function,
+  /**
+   * If set to `true` the tooltip is shown constantly.
+   */
+  show: Boolean,
+  /**
+   * If set to `true` the tooltip is hidden constantly.
+   */
+  hide: Boolean,
+  /**
+   * If set to `true` the `block` class is applied to the tooltip.
+   * This should be set if the content in the default slot is also block.
+   */
+  block: Boolean,
+  /**
+   * The placement of the tooltip.
+   */
+  placement: {
+    type: String,
+    default: 'auto'
+  },
+  /**
+   * The maximum width of the tooltip.
+   */
+  maxWidth: {
+    type: String,
+    default: 'max-w-xs'
+  }
+});
+/**
+ * These props are made to use on a component which implements the tooltip
+ * and wants it to be controllable via the own props.
+ * e.g. `text` is now called `tooltipText`.
+ * They can be mapped to the normal tooltip props with {@link mapTooltipProps}
+ */
+export const nToolTipPropsForImplementor = {
+  /**
+   * Adds a tooltip to the component with the specified text.
+   * @see {@link nTooltipProps.text}
+   */
+  tooltipText: nTooltipProps.text,
+  /**
+   * A slot for the tooltip of this component.
+   * If the slot is set, the tooltip with the specified content is added to the component.
+   * @see {@link nTooltipProps.content}
+   */
+  tooltipContent: nTooltipProps.content,
+  /**
+   * @see {@link nTooltipProps.hide}
+   */
+  tooltipHide: nTooltipProps.hide,
+  /**
+   * @see {@link nTooltipProps.show}
+   */
+  tooltipShow: nTooltipProps.show,
+  /**
+   * @see {@link nTooltipProps.placement}
+   */
+  tooltipPlacement: nTooltipProps.placement,
+  /**
+   * @see {@link nTooltipProps.maxWidth}
+   */
+  tooltipMaxWidth: nTooltipProps.maxWidth
+};
+/**
+ * Maps the {@link nToolTipPropsForImplementor} props to normal tooltip props
+ * @returns an object containing the normal tooltip props.
+ */
+export function mapTooltipProps(props) {
+  return {
+    text: props.tooltipText,
+    content: props.tooltipContent,
+    hide: props.tooltipHide,
+    show: props.tooltipShow,
+    placement: props.tooltipPlacement,
+    maxWidth: props.tooltipMaxWidth
+  };
+}
+/**
+ * The `NTooltip` is a wrapper for any component which adds a tooltip to it.
+ * Any component can just be passed in the default slot and a tooltip will be added to it.
+ * Note that this component disappears when neither the `text` nor the `content`
+ * prop is passed as the tooltip would then be empty.
+ * If this is the case, the default slot will just be rendered inside a div.
+ * @example
+ * <NTooltip text="Hello">
+ *      <NButton />
+ * </NTooltip>
+ */
+export default createComponent('NTooltip', nTooltipProps, (props, {
+  slots
+}) => {
+  return () => _createVNode("div", {
+    "class": props.block ? 'block' : 'inline-block'
+  }, [props.content || props.text ? _createVNode(NTooltipBase, props, {
+    default: () => [slots.default?.()]
+  }) : slots.default?.()]);
+});
+const NTooltipBase = createComponent('NTooltipBase', nTooltipProps, (props, {
+  slots
+}) => {
+  let popperInstance = null;
+  const contentId = `content-${uniqueId()}`;
+  const tooltipId = `tooltip-${uniqueId()}`;
+  function createTooltip() {
+    const content = document.getElementById(contentId);
+    const tooltip = document.getElementById(tooltipId);
+    if (content && tooltip) {
+      popperInstance = createPopper(content, tooltip, {
+        placement: props.placement,
+        modifiers: [{
+          name: 'offset',
+          options: {
+            offset: [0, 8]
+          }
+        }]
+      });
+    } else {
+      console.error('Could not create tooltip. HTML elements for content or tooltip were not found.');
+    }
+  }
+  function destroyTooltip() {
+    popperInstance?.destroy();
+    popperInstance = null;
+  }
+  onMounted(createTooltip);
+  onUnmounted(destroyTooltip);
+  watch(() => props.placement, newPlacement => popperInstance?.setOptions({
+    placement: newPlacement
+  }));
+  const isHoveringContent = ref(false);
+  const isHoveringTooltip = ref(false);
+  const isHovering = computed(() => isHoveringContent.value || isHoveringTooltip.value);
+  const showTooltip = computed(() => props.show || !props.hide && isHovering.value);
+  watchRef(showTooltip, () => popperInstance?.update());
+  return () => _createVNode(_Fragment, null, [_createVNode("div", {
+    "class": "p-[10px] -m-[10px]",
+    "onMouseleave": () => setTimeout(() => isHoveringContent.value = false, 10)
+  }, [_createVNode("div", {
+    "id": contentId,
+    "onMouseenter": () => isHoveringContent.value = true
+  }, [slots.default?.()])]), _createVNode(Transition, {
+    "enterActiveClass": "transition-opacity ease-out duration-100",
+    "enterFromClass": "opacity-0",
+    "enterToClass": "opacity-100",
+    "leaveActiveClass": "transition-opacity ease-in duration-75",
+    "leaveFromClass": "opacity-100",
+    "leaveToClass": "opacity-0"
+  }, {
+    default: () => [_withDirectives(_createVNode("div", {
+      "id": tooltipId,
+      "role": "tooltip",
+      "onMouseenter": () => isHoveringTooltip.value = true,
+      "onMouseleave": () => isHoveringTooltip.value = false,
+      "class": [isHovering.value ? 'z-20' : 'z-10', props.maxWidth, 'tooltip']
+    }, [_createVNode("div", {
+      "class": "bg-white rounded-md py-2 px-4 shadow-lg border-default-200 border text-sm font-normal text-default-700"
+    }, [props.content?.() || props.text]), _createVNode("div", {
+      "data-popper-arrow": true,
+      "class": "arrow"
+    }, null)]), [[_vShow, showTooltip.value]])]
+  })]);
+});

package/components/NValInput.js

@@ -0,0 +1,104 @@
+import { createVNode as _createVNode, mergeProps as _mergeProps } from "vue";
+import { createComponent, createProps } from '../utils/component';
+import { computed } from 'vue';
+import { ref, reactive, watch } from 'vue';
+import NInput, { nInputProps } from './NInput';
+import { validate, required } from '../utils/validation';
+export const validationProps = createProps({
+  /**
+   * If set to `true` this input is always valid when its value is empty.
+   * If set to `false` the input receives the {@link required} rule. Default is `false`.
+   */
+  optional: Boolean,
+  /**
+   * The rules which this input is checked with.
+   * The rules are checked sequentially and the error of the first failed rule is displayed.
+   * If `optional` is set to false, the rule {@link required} will be checked first.
+   */
+  rules: {
+    type: [Function, Array],
+    default: () => []
+  },
+  /**
+   * The form, which this input will be added to.
+   * On initialization, this input will call {@link ValidatedForm.addInput} passing itself to the form.
+   */
+  form: Object,
+  /**
+   * Overrides the internal error state. If set to true, it will always display an error.
+   */
+  error: Boolean,
+  /**
+   * Overrides the internal error message. If set, this message is always displayed.
+   */
+  errorMessage: String,
+  /**
+   * If set to `true` the error message is not shown.
+   * However, the input is still marked red if it is in an error state.
+   */
+  hideErrorMessage: Boolean,
+  /**
+   * Disables the validation on blur. Should only be used in special occasions.
+   */
+  disableBlurValidation: Boolean
+});
+export const nValInputProps = createProps({
+  ...nInputProps,
+  ...validationProps,
+  /**
+   * A slot to replace the input.
+   */
+  input: Function
+});
+/**
+ * The `NValInput` is a `NInput` with custom validation.
+ */
+export default createComponent('NValInput', nValInputProps, (props, context) => {
+  const rules = computed(() => {
+    const otherRules = Array.isArray(props.rules) ? props.rules : [props.rules];
+    return props.optional ? otherRules : [required, ...otherRules];
+  });
+  const validationResult = ref();
+  const validateRules = input => {
+    const result = validate(input, rules.value);
+    validationResult.value = result;
+    return result;
+  };
+  const showError = computed(() => props.error || validationResult.value != null && !validationResult.value.isValid);
+  const showErrorMessage = computed(() => !props.hideErrorMessage && showError.value);
+  const errorMessage = computed(() => props.errorMessage || validationResult.value?.errorMessage);
+  const validateIfError = (value = props.value) => {
+    if (showError.value) validateRules(value);
+  };
+  watch(() => props.value, () => validateIfError());
+  watch(() => rules.value, () => validateIfError());
+  const onBlur = () => {
+    if (!props.disableBlurValidation) validateRules(props.value);
+    props.onBlur?.();
+  };
+  const onUpdateValue = newValue => {
+    validateIfError(newValue);
+    props.onUpdateValue?.(newValue);
+  };
+  const inputSlotProps = reactive({
+    onBlur,
+    onUpdateValue,
+    error: showError
+  });
+  const inputRef = ref();
+  const expose = {
+    validate: () => validateRules(props.value),
+    reset: () => validationResult.value = undefined,
+    focus: () => inputRef.value?.focus()
+  };
+  context.expose(expose);
+  props.form?.addInput(expose);
+  return () => _createVNode("div", null, [props.input?.(inputSlotProps) || _createVNode(NInput, _mergeProps({
+    "ref": inputRef
+  }, {
+    ...props,
+    ...inputSlotProps
+  }), null), showErrorMessage.value && _createVNode("p", {
+    "class": "text-red-500 text-xs mt-1"
+  }, [errorMessage.value])]);
+});

package/components/ValidatedForm.js

@@ -3,23 +3,23 @@
  * @returns the instance of the new form.
  */
 export function createValidatedForm() {
-    return new ValidatedFormImpl();
+  return new ValidatedFormImpl();
 }
 class ValidatedFormImpl {
-    inputs = [];
-    addInput(input) {
-        this.inputs.push(input);
-    }
-    validate() {
-        const results = this.inputs.map(input => input.validate());
-        // return first invalid result
-        for (const result of results)
-            if (result && !result.isValid)
-                return result;
-        // else return valid result
-        return { isValid: true };
-    }
-    reset() {
-        this.inputs.forEach(input => input.reset());
-    }
-}
+  inputs = [];
+  addInput(input) {
+    this.inputs.push(input);
+  }
+  validate() {
+    const results = this.inputs.map(input => input.validate());
+    // return first invalid result
+    for (const result of results) if (result && !result.isValid) return result;
+    // else return valid result
+    return {
+      isValid: true
+    };
+  }
+  reset() {
+    this.inputs.forEach(input => input.reset());
+  }
+}

package/i18n/index.js

@@ -15,8 +15,6 @@ export function registerTranslationProvider(newProvider) {
  * @returns the translated message.
  */
 export function trsl(key, params) {
-    if (!provider)
-        console.warn('Vue Collection: No translation provider has been registered!');
     return provider?.trsl(key, params) ?? key;
 }
 /**
@@ -29,7 +27,5 @@ export function trsl(key, params) {
  * @see trsl
  */
 export function trslc(key, count, params) {
-    if (!provider)
-        console.warn('Vue Collection: No translation provider has been registered!');
     return provider?.trslc(key, count, params) ?? key;
 }

package/package.json

@@ -1,7 +1,11 @@
 {
     "name": "@naptics/vue-collection",
-    "version": "0.0.3",
+    "version": "0.0.5",
     "main": "./index.js",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/naptics/vue-collection"
+    },
     "scripts": {
         "dev": "vite",
         "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
@@ -12,7 +16,7 @@
         "build-demo": "run-p type-check-demo build-only-demo",
         "build-lib": "run-p type-check-lib build-only-lib",
         "build-only-demo": "vite build",
-        "build-only-lib": "rm -rf ./lib && tsc --project tsconfig.lib.json && mv ./lib/src/lib/* ./lib && rm -rf ./lib/src && rm ./lib/tsconfig.lib.tsbuildinfo && cp ./src/lib/components/*.css ./lib/components"
+        "build-only-lib": "bash ./scripts/build-lib.sh"
     },
     "dependencies": {
         "@headlessui/vue": "^1.7.10",
@@ -24,6 +28,8 @@
         "vue": "^3.2.36"
     },
     "devDependencies": {
+        "@babel/cli": "^7.21.0",
+        "@babel/core": "^7.21.3",
         "@intlify/unplugin-vue-i18n": "^0.8.2",
         "@rushstack/eslint-patch": "^1.2.0",
         "@tailwindcss/forms": "^0.5.3",
@@ -31,6 +37,7 @@
         "@types/node": "^18.14.0",
         "@vitejs/plugin-vue": "^4.0.0",
         "@vitejs/plugin-vue-jsx": "^3.0.0",
+        "@vue/babel-plugin-jsx": "^1.1.1",
         "@vue/eslint-config-prettier": "^7.1.0",
         "@vue/eslint-config-typescript": "^11.0.2",
         "@vue/test-utils": "^2.3.0",

package/components/NAlert.jsx

@@ -1,69 +0,0 @@
-import { createComponent, createProps } from '../utils/component';
-import { CheckCircleIcon, ExclamationCircleIcon, InformationCircleIcon, XMarkIcon } from '@heroicons/vue/24/solid';
-import { computed } from 'vue';
-import NIconButton from './NIconButton';
-import NLoadingIndicator from './NLoadingIndicator';
-export const nAlertProps = createProps({
-    /**
-     * The variant of the alert. This defines its color and icon.
-     */
-    variant: {
-        type: String,
-        default: 'success',
-    },
-    /**
-     * The text of the alert.
-     */
-    text: String,
-    /**
-     * If set to `true` the X-button of the alert is hidden.
-     */
-    hideX: Boolean,
-    /**
-     * This is called, when the X-button is clicked.
-     */
-    onDismiss: Function,
-});
-/**
- * The `NAlert` is a fully styled alert with multiple variants.
- * It can be used as a normal blocking element or as part of an alert queue.
- */
-export default createComponent('NAlert', nAlertProps, props => {
-    const variant = computed(() => VARIANTS[props.variant]);
-    return () => (<div class={`rounded-md p-3 shadow-lg bg-${variant.value.color}-50`}>
-            <div class="flex items-center">
-                <div class="flex flex-shrink-0 items-center">{variant.value.icon()}</div>
-
-                <div class="ml-3 flex-grow">
-                    <p class={`text-sm font-medium text-${variant.value.color}-900`}>{props.text}</p>
-                </div>
-
-                {!props.hideX && (<div class="flex items-center flex-shrink-0 ml-3">
-                        <NIconButton color={variant.value.color} size={5} icon={XMarkIcon} onClick={props.onDismiss}/>
-                    </div>)}
-            </div>
-        </div>);
-});
-const icon = (icon, color) => () => <icon class={`h-5 w-5 text-${color}-500`}/>;
-const VARIANTS = {
-    success: {
-        icon: icon(CheckCircleIcon, 'green'),
-        color: 'green',
-    },
-    info: {
-        icon: icon(InformationCircleIcon, 'blue'),
-        color: 'blue',
-    },
-    warning: {
-        icon: icon(ExclamationCircleIcon, 'yellow'),
-        color: 'yellow',
-    },
-    error: {
-        icon: icon(ExclamationCircleIcon, 'red'),
-        color: 'red',
-    },
-    loading: {
-        icon: () => <NLoadingIndicator color="blue" size={7} shade={500}/>,
-        color: 'blue',
-    },
-};

package/components/NBadge.jsx

@@ -1,58 +0,0 @@
-import { createComponent, createProps } from '../utils/component';
-import NTooltip, { mapTooltipProps, nToolTipPropsForImplementor } from './NTooltip';
-export const nBadgeProps = createProps({
-    /**
-     * 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,
-        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,
-    },
-    ...nToolTipPropsForImplementor,
-});
-/**
- * The `NBadge` is a styled element to wrap a text.
- */
-export default 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' : '',
-        ]}>
-                {slots.default?.() || props.text}
-            </div>
-        </NTooltip>);
-});

package/components/NBreadcrub.jsx

@@ -1,64 +0,0 @@
-import { createComponent, createProps } from '../utils/component';
-import { ChevronRightIcon } from '@heroicons/vue/24/solid';
-import NLink from './NLink';
-export const nBreadcrumbProps = createProps({
-    /**
-     * The items of the breadcrumb.
-     */
-    items: {
-        type: Array,
-        default: () => [],
-    },
-    /**
-     * The color of the breadcrumbs text and icons.
-     */
-    color: {
-        type: String,
-        default: 'primary',
-    },
-    /**
-     * The text-size of the breadcrumb labels.
-     */
-    textSize: {
-        type: String,
-        default: 'text-base',
-    },
-    /**
-     * The icon which is used as a seperator between two breadcrumb items.
-     */
-    icon: {
-        type: Function,
-        default: ChevronRightIcon,
-    },
-    /**
-     * The size of the icon in tailwind units.
-     */
-    iconSize: {
-        type: Number,
-        default: 5,
-    },
-    /**
-     * A slot the replace the breadcrumb labels.
-     */
-    item: Function,
-    /**
-     * A slot to replace the separators between the breadcrumb labels.
-     * The passsed item is the item before the seperator.
-     */
-    seperator: Function,
-});
-/**
- * The `NBreadcrumb` is a styled breadcrumb which can be used as a navigation in hierarchical views.
- */
-export default createComponent('NBreadcrumb', nBreadcrumbProps, 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`}/>))}
-                </>))}
-        </div>);
-});

package/components/NButton.jsx

@@ -1,58 +0,0 @@
-import { createComponent, createProps } from '../utils/component';
-import { computed } from 'vue';
-import NLoadingIndicator from './NLoadingIndicator';
-import NTooltip, { mapTooltipProps, nToolTipPropsForImplementor } from './NTooltip';
-export const nButtonProps = createProps({
-    /**
-     * The color of the button.
-     */
-    color: {
-        type: String,
-        default: 'primary',
-    },
-    /**
-     * The html attribute, which indicates the type of the button.
-     */
-    type: {
-        type: String,
-        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,
-    /**
-     * This is called, when the button is clicked.
-     */
-    onClick: Function,
-    ...nToolTipPropsForImplementor,
-});
-/**
- * The `NButton` is a styled button.
- */
-export default 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',
-        ]} 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>);
-});

package/components/NCheckbox.jsx

@@ -1,38 +0,0 @@
-import { createComponent, createProps } from '../utils/component';
-import { vModelProps } from '../utils/vModel';
-import { nextTick, ref } from 'vue';
-export const nCheckboxProps = createProps({
-    ...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,
-});
-/**
- * The `NCheckbox` is a styled checkbox.
- */
-export default createComponent('NCheckbox', nCheckboxProps, props => {
-    const toggle = () => {
-        props.onUpdateValue?.(!props.value);
-        forceUpdate();
-    };
-    const checkBoxRef = ref();
-    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`,
-        ]}/>);
-});