sprintify-ui 0.1.15 → 0.1.17

package/src/components/BaseAutocompleteFetch.vue

@@ -1,276 +1,277 @@
-<template>
-  <BaseAutocomplete
-    ref="autocomplete"
-    :loading="showLoading && page == 1"
-    :loading-bottom="showLoading && page > 1"
-    :model-value="modelValue"
-    :disabled="disabled"
-    :name="name"
-    :placeholder="placeholder"
-    :options="options"
-    :value-key="valueKey"
-    :label-key="labelKey"
-    :has-error="hasError"
-    :required="required"
-    :size="size"
-    :inline="inline"
-    :dropdown-show="dropdownShow"
-    :show-model-value="showModelValue"
-    :visible-focus="visibleFocus"
-    :show-empty-option="showEmptyOption"
-    :empty-option-label="emptyOptionLabel"
-    :select="select"
-    :filter="filterOptions"
-    @clear="onClear"
-    @open="onOpen"
-    @typing="onTyping"
-    @scroll-bottom="scrollBottom"
-    @update:model-value="$emit('update:modelValue', $event)"
-  >
-    <template #option="optionProps">
-      <slot name="option" v-bind="optionProps" />
-    </template>
-
-    <template #footer="footerProps">
-      <slot name="footer" v-bind="footerProps" :keywords="keywords" />
-    </template>
-
-    <template #empty="emptyProps">
-      <slot name="empty" v-bind="emptyProps" :first-search="firstSearch">
-        <div
-          v-if="firstSearch"
-          class="flex h-[80px] items-center justify-center px-3 text-center text-base leading-tight text-slate-600"
-        >
-          {{ $t('sui.nothing_found') }}
-        </div>
-      </slot>
-    </template>
-  </BaseAutocomplete>
-</template>
-
-<script lang="ts" setup>
-import { config } from '@/index';
-import { debounce, throttle } from 'lodash';
-import { PropType } from 'vue';
-import {
-  Collection,
-  Option,
-  PaginatedCollection,
-  ResourceCollection,
-  SelectConfiguration,
-} from '@/types';
-import BaseAutocomplete from './BaseAutocomplete.vue';
-import { useHasPaginatedData } from '@/composables/paginatedData';
-
-/**
- * Behavior notes
- *
- * - When the user types, the component will fetch the data from the API.
- * - When the user scrolls to the bottom, the component will fetch the next page.
- * - When the user clears the input, the component will NOT re-fetch the data if the current query is already empty.
- * - When a value is selected, the component will NOT re-fetch the data.
- */
-
-const props = defineProps({
-  modelValue: {
-    default: undefined,
-    type: [Object, null] as PropType<Option | null | undefined>,
-  },
-  url: {
-    required: true,
-    type: String,
-  },
-  labelKey: {
-    required: true,
-    type: String,
-  },
-  valueKey: {
-    required: true,
-    type: String,
-  },
-  name: {
-    default: undefined,
-    type: String,
-  },
-  placeholder: {
-    default: undefined,
-    type: String,
-  },
-  required: {
-    default: false,
-    type: Boolean,
-  },
-  disabled: {
-    default: false,
-    type: Boolean,
-  },
-  queryKey: {
-    default: 'search',
-    type: String,
-  },
-  hasError: {
-    default: false,
-    type: Boolean,
-  },
-  inline: {
-    default: false,
-    type: Boolean,
-  },
-  size: {
-    default: 'base',
-    type: String as PropType<'xs' | 'sm' | 'base'>,
-  },
-  dropdownShow: {
-    default: 'focus',
-    type: String as PropType<'focus' | 'always'>,
-  },
-  showModelValue: {
-    default: true,
-    type: Boolean,
-  },
-  visibleFocus: {
-    default: true,
-    type: Boolean,
-  },
-  showEmptyOption: {
-    default: false,
-    type: Boolean,
-  },
-  emptyOptionLabel: {
-    default: undefined,
-    type: String,
-  },
-  select: {
-    default: undefined,
-    type: Object as PropType<SelectConfiguration | undefined>,
-  },
-});
-
-const emit = defineEmits([
-  'update:modelValue',
-  'typing',
-  'focus',
-  'scrollBottom',
-  'clear',
-]);
-
-const showLoading = ref(false);
-const fetching = ref(false);
-const firstSearch = ref(false);
-const keywords = ref('');
-const page = ref(1);
-const options = ref<Option[]>([]);
-
-const data = ref<null | ResourceCollection | PaginatedCollection | Collection>(
-  null
-);
-
-const { items, lastPage } = useHasPaginatedData(data);
-
-const autocomplete = ref<InstanceType<typeof BaseAutocomplete> | null>(null);
-
-const onTyping = (query: string) => {
-  page.value = 1;
-  keywords.value = query;
-  showLoading.value = true;
-  debouncedSearch();
-};
-
-const onOpen = () => {
-  if (!firstSearch.value) {
-    search();
-  }
-};
-
-const onClear = () => {
-  if (keywords.value != '') {
-    keywords.value = '';
-    search();
-  }
-  emit('clear');
-};
-
-const scrollBottom = throttle(() => {
-  if (page.value >= lastPage.value) {
-    return;
-  }
-
-  if (fetching.value) {
-    return;
-  }
-
-  page.value++;
-  search();
-}, 500);
-
-watch(
-  () => props.url,
-  () => {
-    page.value = 1;
-    search();
-  }
-);
-
-function search() {
-  if (fetching.value) {
-    return;
-  }
-
-  fetching.value = true;
-  showLoading.value = true;
-
-  config.http
-    .get(props.url, {
-      params: {
-        [props.queryKey]: keywords.value,
-        page: page.value,
-      },
-    })
-    .then((response: any) => {
-      data.value = response.data as
-        | ResourceCollection
-        | PaginatedCollection
-        | Collection;
-
-      if (page.value == 1) {
-        options.value = items.value;
-      } else {
-        options.value.push(...items.value);
-      }
-
-      firstSearch.value = true;
-    })
-    .finally(() => {
-      fetching.value = false;
-      showLoading.value = false;
-    });
-}
-
-const debouncedSearch = debounce(() => {
-  search();
-}, 300);
-
-function filterOptions(option: Option): boolean {
-  // Do nothing if showEmptyOption is false
-  if (!props.showEmptyOption) {
-    return true;
-  }
-
-  // Hide the empty value on search
-  if (
-    option.value == null &&
-    !option.label.toLowerCase().includes(keywords.value.toLowerCase())
-  ) {
-    return false;
-  }
-  return true;
-}
-
-defineExpose({
-  focus: () => autocomplete.value?.focus(),
-  blur: () => autocomplete.value?.blur(),
-  open: () => autocomplete.value?.open(),
-  close: () => autocomplete.value?.close(),
-  setKeywords: (input: string) => autocomplete.value?.setKeywords(input),
-});
-</script>
+<template>
+  <BaseAutocomplete
+    ref="autocomplete"
+    :loading="showLoading && page == 1"
+    :loading-bottom="showLoading && page > 1"
+    :model-value="modelValue"
+    :disabled="disabled"
+    :name="name"
+    :placeholder="placeholder"
+    :options="options"
+    :value-key="valueKey"
+    :label-key="labelKey"
+    :has-error="hasError"
+    :required="required"
+    :size="size"
+    :inline="inline"
+    :dropdown-show="dropdownShow"
+    :show-model-value="showModelValue"
+    :visible-focus="visibleFocus"
+    :show-empty-option="showEmptyOption"
+    :empty-option-label="emptyOptionLabel"
+    :select="select"
+    :filter="filterOptions"
+    @clear="onClear"
+    @open="onOpen"
+    @typing="onTyping"
+    @scroll-bottom="scrollBottom"
+    @update:model-value="$emit('update:modelValue', $event)"
+  >
+    <template #option="optionProps">
+      <slot name="option" v-bind="optionProps" />
+    </template>
+
+    <template #footer="footerProps">
+      <slot name="footer" v-bind="footerProps" :keywords="keywords" />
+    </template>
+
+    <template #empty="emptyProps">
+      <slot name="empty" v-bind="emptyProps" :first-search="firstSearch">
+        <div
+          v-if="firstSearch"
+          class="flex h-[80px] items-center justify-center px-3 text-center text-base leading-tight text-slate-600"
+        >
+          {{ t('sui.nothing_found') }}
+        </div>
+      </slot>
+    </template>
+  </BaseAutocomplete>
+</template>
+
+<script lang="ts" setup>
+import { config } from '@/index';
+import { debounce, throttle } from 'lodash';
+import { PropType } from 'vue';
+import {
+  Collection,
+  Option,
+  PaginatedCollection,
+  ResourceCollection,
+  SelectConfiguration,
+} from '@/types';
+import BaseAutocomplete from './BaseAutocomplete.vue';
+import { useHasPaginatedData } from '@/composables/paginatedData';
+import { t } from '@/i18n';
+
+/**
+ * Behavior notes
+ *
+ * - When the user types, the component will fetch the data from the API.
+ * - When the user scrolls to the bottom, the component will fetch the next page.
+ * - When the user clears the input, the component will NOT re-fetch the data if the current query is already empty.
+ * - When a value is selected, the component will NOT re-fetch the data.
+ */
+
+const props = defineProps({
+  modelValue: {
+    default: undefined,
+    type: [Object, null] as PropType<Option | null | undefined>,
+  },
+  url: {
+    required: true,
+    type: String,
+  },
+  labelKey: {
+    required: true,
+    type: String,
+  },
+  valueKey: {
+    required: true,
+    type: String,
+  },
+  name: {
+    default: undefined,
+    type: String,
+  },
+  placeholder: {
+    default: undefined,
+    type: String,
+  },
+  required: {
+    default: false,
+    type: Boolean,
+  },
+  disabled: {
+    default: false,
+    type: Boolean,
+  },
+  queryKey: {
+    default: 'search',
+    type: String,
+  },
+  hasError: {
+    default: false,
+    type: Boolean,
+  },
+  inline: {
+    default: false,
+    type: Boolean,
+  },
+  size: {
+    default: 'base',
+    type: String as PropType<'xs' | 'sm' | 'base'>,
+  },
+  dropdownShow: {
+    default: 'focus',
+    type: String as PropType<'focus' | 'always'>,
+  },
+  showModelValue: {
+    default: true,
+    type: Boolean,
+  },
+  visibleFocus: {
+    default: true,
+    type: Boolean,
+  },
+  showEmptyOption: {
+    default: false,
+    type: Boolean,
+  },
+  emptyOptionLabel: {
+    default: undefined,
+    type: String,
+  },
+  select: {
+    default: undefined,
+    type: Object as PropType<SelectConfiguration | undefined>,
+  },
+});
+
+const emit = defineEmits([
+  'update:modelValue',
+  'typing',
+  'focus',
+  'scrollBottom',
+  'clear',
+]);
+
+const showLoading = ref(false);
+const fetching = ref(false);
+const firstSearch = ref(false);
+const keywords = ref('');
+const page = ref(1);
+const options = ref<Option[]>([]);
+
+const data = ref<null | ResourceCollection | PaginatedCollection | Collection>(
+  null
+);
+
+const { items, lastPage } = useHasPaginatedData(data);
+
+const autocomplete = ref<InstanceType<typeof BaseAutocomplete> | null>(null);
+
+const onTyping = (query: string) => {
+  page.value = 1;
+  keywords.value = query;
+  showLoading.value = true;
+  debouncedSearch();
+};
+
+const onOpen = () => {
+  if (!firstSearch.value) {
+    search();
+  }
+};
+
+const onClear = () => {
+  if (keywords.value != '') {
+    keywords.value = '';
+    search();
+  }
+  emit('clear');
+};
+
+const scrollBottom = throttle(() => {
+  if (page.value >= lastPage.value) {
+    return;
+  }
+
+  if (fetching.value) {
+    return;
+  }
+
+  page.value++;
+  search();
+}, 500);
+
+watch(
+  () => props.url,
+  () => {
+    page.value = 1;
+    search();
+  }
+);
+
+function search() {
+  if (fetching.value) {
+    return;
+  }
+
+  fetching.value = true;
+  showLoading.value = true;
+
+  config.http
+    .get(props.url, {
+      params: {
+        [props.queryKey]: keywords.value,
+        page: page.value,
+      },
+    })
+    .then((response: any) => {
+      data.value = response.data as
+        | ResourceCollection
+        | PaginatedCollection
+        | Collection;
+
+      if (page.value == 1) {
+        options.value = items.value;
+      } else {
+        options.value.push(...items.value);
+      }
+
+      firstSearch.value = true;
+    })
+    .finally(() => {
+      fetching.value = false;
+      showLoading.value = false;
+    });
+}
+
+const debouncedSearch = debounce(() => {
+  search();
+}, 300);
+
+function filterOptions(option: Option): boolean {
+  // Do nothing if showEmptyOption is false
+  if (!props.showEmptyOption) {
+    return true;
+  }
+
+  // Hide the empty value on search
+  if (
+    option.value == null &&
+    !option.label.toLowerCase().includes(keywords.value.toLowerCase())
+  ) {
+    return false;
+  }
+  return true;
+}
+
+defineExpose({
+  focus: () => autocomplete.value?.focus(),
+  blur: () => autocomplete.value?.blur(),
+  open: () => autocomplete.value?.open(),
+  close: () => autocomplete.value?.close(),
+  setKeywords: (input: string) => autocomplete.value?.setKeywords(input),
+});
+</script>

package/src/components/BaseAvatar.stories.js

@@ -1,39 +1,39 @@
-import BaseAvatar from './BaseAvatar.vue';
-
-export default {
-  title: 'Components/BaseAvatar',
-  component: BaseAvatar,
-  argTypes: {
-    size: {
-      control: { type: 'select' },
-      options: ['xs', 'sm', 'base', 'lg', 'xl'],
-    },
-    detailsPosition: {
-      control: { type: 'select' },
-      options: ['left', 'right'],
-    },
-  },
-};
-
-const Template = (args) => ({
-  components: { BaseAvatar },
-  setup() {
-    return { args };
-  },
-  template: `
-    <BaseAvatar v-bind="args"></BaseAvatar>
-  `,
-});
-
-export const Demo = Template.bind({});
-Demo.args = {
-  showDetails: true,
-  user: {
-    email: 'jane@witify.io',
-    first_name: 'Jane',
-    last_name: 'Doe',
-    full_name: 'Jane Doe',
-    avatar_url:
-      'https://images.unsplash.com/photo-1494790108377-be9c29b29330??auto=format&fit=crop&w=200&h=200&q=80&g=face',
-  },
-};
+import BaseAvatar from './BaseAvatar.vue';
+
+export default {
+  title: 'Components/BaseAvatar',
+  component: BaseAvatar,
+  argTypes: {
+    size: {
+      control: { type: 'select' },
+      options: ['xs', 'sm', 'base', 'lg', 'xl'],
+    },
+    detailsPosition: {
+      control: { type: 'select' },
+      options: ['left', 'right'],
+    },
+  },
+};
+
+const Template = (args) => ({
+  components: { BaseAvatar },
+  setup() {
+    return { args };
+  },
+  template: `
+    <BaseAvatar v-bind="args"></BaseAvatar>
+  `,
+});
+
+export const Demo = Template.bind({});
+Demo.args = {
+  showDetails: true,
+  user: {
+    email: 'jane@witify.io',
+    first_name: 'Jane',
+    last_name: 'Doe',
+    full_name: 'Jane Doe',
+    avatar_url:
+      'https://images.unsplash.com/photo-1494790108377-be9c29b29330??auto=format&fit=crop&w=200&h=200&q=80&g=face',
+  },
+};