slim-select 1.27.0 → 2.0.0

package/src/slim-select/store.test.ts

@@ -0,0 +1,220 @@
+'use strict'
+
+import { describe, expect, test } from '@jest/globals'
+import Store, { Optgroup, Option } from './store'
+
+describe('store module', () => {
+  test('constructor', () => {
+    let store = new Store('single', [])
+    expect(store).toBeInstanceOf(Store)
+  })
+
+  test('set data', () => {
+    let store = new Store('single', [
+      {
+        text: 'test',
+      },
+    ])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(1)
+    expect((data[0] as Option).text).toBe('test')
+
+    // Make sure the data has all the default fields
+    expect((data[0] as Option).id).toBeDefined()
+    expect((data[0] as Option).value).toBeDefined()
+    expect((data[0] as Option).text).toBeDefined()
+    expect((data[0] as Option).html).toBeDefined()
+    expect((data[0] as Option).selected).toBeDefined()
+    expect((data[0] as Option).display).toBeDefined()
+    expect((data[0] as Option).disabled).toBeDefined()
+    expect((data[0] as Option).placeholder).toBeDefined()
+    expect((data[0] as Option).class).toBeDefined()
+    expect((data[0] as Option).style).toBeDefined()
+    expect((data[0] as Option).data).toBeDefined()
+    expect((data[0] as Option).mandatory).toBeDefined()
+  })
+
+  test('set data with optgroup', () => {
+    let store = new Store('single', [
+      {
+        label: 'test',
+        options: [
+          {
+            text: 'test',
+          },
+        ],
+      },
+    ])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(1)
+    expect((data[0] as Optgroup).label).toBe('test')
+    expect((data[0] as Optgroup).options?.length).toBe(1)
+    expect((data[0] as Optgroup).options?.[0].text).toBe('test')
+  })
+
+  test('set data with optgroup and option', () => {
+    let store = new Store('single', [
+      {
+        label: 'test',
+        options: [
+          {
+            text: 'test',
+          },
+        ],
+      },
+      {
+        text: 'test',
+      },
+    ])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(2)
+    expect((data[0] as Optgroup).label).toBe('test')
+    expect((data[0] as Optgroup).options?.length).toBe(1)
+    expect((data[0] as Optgroup).options?.[0].text).toBe('test')
+    expect((data[1] as Option).text).toBe('test')
+  })
+
+  test('set data and set selected by ID', () => {
+    let store = new Store('single', [
+      {
+        id: '8675309',
+        text: 'test',
+      },
+    ])
+    store.setSelectedBy('id', ['8675309'])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(1)
+    expect((data[0] as Option).text).toBe('test')
+    expect((data[0] as Option).selected).toBe(true)
+  })
+
+  test('set data and set selected by value', () => {
+    let store = new Store('single', [
+      {
+        text: 'test',
+        value: 'hello',
+      },
+    ])
+    store.setSelectedBy('value', ['hello'])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(1)
+    expect((data[0] as Option).text).toBe('test')
+    expect((data[0] as Option).selected).toBe(true)
+  })
+
+  test('set data and set selected by value multiple for single element', () => {
+    let store = new Store('single', [
+      {
+        text: 'test1',
+      },
+      {
+        text: 'test2',
+      },
+    ])
+    store.setSelectedBy('value', ['test1', 'test2'])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(2)
+    expect((data[0] as Option).text).toBe('test1')
+    expect((data[0] as Option).selected).toBe(true)
+    expect((data[1] as Option).text).toBe('test2')
+    expect((data[1] as Option).selected).toBe(false)
+  })
+
+  test('set data and search', () => {
+    let store = new Store('single', [
+      {
+        text: 'test1',
+      },
+      {
+        text: 'test2',
+        value: 'test2',
+      },
+      {
+        text: 'test3',
+      },
+    ])
+
+    let data = store.getData()
+
+    const searchFilter = (opt: Option, search: string): boolean => {
+      return opt.text.toLowerCase().indexOf(search.toLowerCase()) !== -1
+    }
+
+    // With searchFilter search against current store data set
+    let search = store.search('test2', searchFilter)
+    expect(search.length).toBe(1)
+    expect((search[0] as Option).value).toBe('test2')
+  })
+
+  test('set data with non selected on single select', () => {
+    let store = new Store('single', [
+      {
+        text: 'test1',
+      },
+      {
+        text: 'test2',
+        value: 'test2',
+      },
+      {
+        text: 'test3',
+      },
+    ])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(3)
+    expect((data[0] as Option).text).toBe('test1')
+    expect((data[0] as Option).selected).toBe(true)
+    expect((data[1] as Option).text).toBe('test2')
+    expect((data[1] as Option).selected).toBe(false)
+    expect((data[2] as Option).text).toBe('test3')
+    expect((data[2] as Option).selected).toBe(false)
+  })
+
+  test('set data with multiple selected on single select', () => {
+    let store = new Store('single', [
+      {
+        text: 'test1',
+      },
+      {
+        text: 'test2',
+        value: 'test2',
+        selected: true,
+      },
+      {
+        text: 'test3',
+        selected: true,
+      },
+    ])
+
+    let data = store.getData()
+
+    // Make sure data has one item and that it has the correct text
+    expect(data.length).toBe(3)
+    expect((data[0] as Option).text).toBe('test1')
+    expect((data[0] as Option).selected).toBe(false)
+    expect((data[1] as Option).text).toBe('test2')
+    expect((data[1] as Option).selected).toBe(true)
+    expect((data[2] as Option).text).toBe('test3')
+    expect((data[2] as Option).selected).toBe(false)
+  })
+})

package/src/slim-select/store.ts

@@ -0,0 +1,320 @@
+import { generateID } from './helper'
+
+export type DataArray = DataObject[]
+export type DataObject = Optgroup | Option
+
+export type DataArrayPartial = DataObjectPartial[]
+export type DataObjectPartial = OptgroupOptional | OptionOptional
+
+type selectType = 'single' | 'multiple'
+
+export interface OptgroupOptional {
+  id?: string
+  label: string // Required
+  options?: OptionOptional[]
+}
+
+export class Optgroup {
+  public id: string
+  public label: string
+  public options: Option[]
+
+  constructor(optgroup: OptgroupOptional) {
+    this.id = !optgroup.id || optgroup.id === '' ? generateID() : optgroup.id
+    this.label = optgroup.label || ''
+
+    // If options exist, loop through options and create new option class
+    // and set the options to the optgroup options field
+    this.options = []
+    if (optgroup.options) {
+      for (const o of optgroup.options) {
+        this.options.push(new Option(o))
+      }
+    }
+  }
+}
+
+export interface OptionOptional {
+  id?: string
+  value?: string
+  text: string // Required
+  html?: string
+  selected?: boolean
+  display?: boolean
+  disabled?: boolean
+  mandatory?: boolean
+  placeholder?: boolean
+  class?: string
+  style?: string
+  data?: { [key: string]: string }
+}
+
+export class Option {
+  id: string
+  value: string
+  text: string
+  html: string
+  selected: boolean
+  display: boolean
+  disabled: boolean
+  placeholder: boolean
+  class: string
+  style: string
+  data: { [key: string]: string }
+  mandatory: boolean
+
+  constructor(option: OptionOptional) {
+    this.id = !option.id || option.id === '' ? generateID() : option.id
+    this.value = option.value === undefined ? option.text : option.value
+    this.text = option.text || ''
+    this.html = option.html || ''
+    this.selected = option.selected !== undefined ? option.selected : false
+    this.display = option.display !== undefined ? option.display : true
+    this.disabled = option.disabled !== undefined ? option.disabled : false
+    this.mandatory = option.mandatory !== undefined ? option.mandatory : false
+    this.placeholder = option.placeholder !== undefined ? option.placeholder : false
+    this.class = option.class || ''
+    this.style = option.style || ''
+    this.data = option.data || {}
+  }
+}
+
+export default class Store {
+  private selectType: selectType = 'single'
+
+  // Main data set, never null
+  private data: DataArray = []
+
+  constructor(type: selectType, data: DataArrayPartial) {
+    this.selectType = type
+    this.setData(data)
+  }
+
+  // Validate DataArrayPartial
+  public validateDataArray(data: DataArray | DataArrayPartial): Error | null {
+    if (!Array.isArray(data)) {
+      return new Error('Data must be an array')
+    }
+
+    // Loop through each data object
+    for (let dataObj of data) {
+      // Optgroup
+      if (dataObj instanceof Optgroup || 'label' in dataObj) {
+        if (!('label' in dataObj)) {
+          return new Error('Optgroup must have a label')
+        }
+
+        if ('options' in dataObj && dataObj.options) {
+          for (let option of dataObj.options) {
+            return this.validateOption(option)
+          }
+        }
+      } else if (dataObj instanceof Option || 'text' in dataObj) {
+        return this.validateOption(dataObj)
+      } else {
+        return new Error('Data object must be a valid optgroup or option')
+      }
+    }
+
+    return null
+  }
+
+  // Validate Option
+  public validateOption(option: Option | OptionOptional): Error | null {
+    if (!('text' in option)) {
+      return new Error('Option must have a text')
+    }
+
+    return null
+  }
+
+  public partialToFullData(data: DataArrayPartial): DataArray {
+    let dataFinal: DataArray = []
+    data.forEach((dataObj: DataObject | DataObjectPartial) => {
+      // Optgroup
+      if (dataObj instanceof Optgroup || 'label' in dataObj) {
+        let optOptions: Option[] = []
+        if ('options' in dataObj && dataObj.options) {
+          dataObj.options.forEach((option: Option | OptionOptional) => {
+            optOptions.push(new Option(option))
+          })
+        }
+
+        if (optOptions.length > 0) {
+          dataFinal.push(new Optgroup(dataObj))
+        }
+      }
+
+      // Option
+      if (dataObj instanceof Option || 'text' in dataObj) {
+        dataFinal.push(new Option(dataObj))
+      }
+    })
+
+    return dataFinal
+  }
+
+  public setData(data: DataArray | DataArrayPartial) {
+    this.data = this.partialToFullData(data)
+
+    // Run this.data through setSelected by value
+    // to set the selected property and clean any wrong selected
+    if (this.selectType === 'single') {
+      this.setSelectedBy('value', this.getSelected())
+    }
+  }
+
+  // Get data will return all the data
+  public getData(): DataArray {
+    return this.filter(null, true)
+  }
+
+  // Get data options will return the data as a
+  // flat array of just options
+  public getDataOptions(): Option[] {
+    return this.filter(null, false) as Option[]
+  }
+
+  public addOption(option: OptionOptional) {
+    this.setData(this.getData().concat(new Option(option)))
+  }
+
+  // Pass in an array of id that will loop through
+  // each option and set the selected property to true
+  // but also clean selected by determining selectType
+  public setSelectedBy(selectedType: 'id' | 'value', selectedValues: string[]) {
+    let firstOption: Option | null = null
+    let hasSelected = false
+
+    for (let dataObj of this.data) {
+      // Optgroup
+      if (dataObj instanceof Optgroup) {
+        for (let option of dataObj.options) {
+          if (!firstOption) {
+            firstOption = option
+          }
+
+          option.selected = hasSelected ? false : selectedValues.includes(option[selectedType])
+
+          // If the option is selected, set hasSelected to true
+          // for single based selects
+          if (option.selected && this.selectType === 'single') {
+            hasSelected = true
+          }
+        }
+      }
+
+      // Option
+      if (dataObj instanceof Option) {
+        if (!firstOption) {
+          firstOption = dataObj
+        }
+
+        dataObj.selected = hasSelected ? false : selectedValues.includes(dataObj[selectedType])
+
+        // If the option is selected, set hasSelected to true
+        // for single based selects
+        if (dataObj.selected && this.selectType === 'single') {
+          hasSelected = true
+        }
+      }
+    }
+
+    // If no options are selected, select the first option
+    if (this.selectType === 'single' && firstOption && !hasSelected) {
+      firstOption.selected = true
+    }
+  }
+
+  public getSelected(): string[] {
+    let selectedOptions = this.getSelectedOptions()
+    let selectedValues: string[] = []
+
+    // Loop through each option and get the value
+    selectedOptions.forEach((option: Option) => {
+      selectedValues.push(option.value)
+    })
+
+    return selectedValues
+  }
+
+  public getSelectedOptions(): Option[] {
+    return this.filter((opt: Option) => {
+      return opt.selected
+    }, false) as Option[]
+  }
+
+  public getSelectedIDs(): string[] {
+    let selectedOptions = this.getSelectedOptions()
+
+    let selectedIDs: string[] = []
+    selectedOptions.forEach((op: Option) => {
+      selectedIDs.push(op.id)
+    })
+
+    return selectedIDs
+  }
+
+  public getOptionByID(id: string): Option | null {
+    let options = this.filter((opt: Option) => {
+      return opt.id === id
+    }, false) as Option[]
+
+    return options.length ? options[0] : null
+  }
+
+  // Take in search string and return filtered list of values
+  public search(search: string, searchFilter: (opt: Option, search: string) => boolean): DataArray {
+    search = search.trim()
+
+    // If search is empty, return all data
+    if (search === '') {
+      return this.getData()
+    }
+
+    // Run filter with search function
+    return this.filter((opt: Option): boolean => {
+      return searchFilter(opt, search)
+    }, true)
+  }
+
+  // Filter takes in a function that will be used to filter the data
+  // This will also keep optgroups of sub options meet the filter requirements
+  public filter(filter: { (opt: Option): boolean } | null, includeOptgroup: boolean): DataArray {
+    const dataSearch: DataArray = []
+    this.data.forEach((dataObj: DataObject) => {
+      // Optgroup
+      if (dataObj instanceof Optgroup) {
+        // If you dont want to include optgroups
+        if (!includeOptgroup) {
+          // Loop through each option and check if it meets the filter requirements
+          dataObj.options.forEach((option: Option) => {
+            if (filter && filter(option)) {
+              dataSearch.push(option)
+            }
+          })
+        } else {
+          let optOptions: Option[] = []
+          dataObj.options.forEach((option: Option) => {
+            if (!filter || filter(option)) {
+              optOptions.push(new Option(option))
+            }
+          })
+
+          if (optOptions.length > 0) {
+            dataSearch.push(new Optgroup({ id: dataObj.id, label: dataObj.label, options: optOptions }))
+          }
+        }
+      }
+
+      // Option
+      if (dataObj instanceof Option) {
+        if (!filter || filter(dataObj)) {
+          dataSearch.push(new Option(dataObj))
+        }
+      }
+    })
+
+    return dataSearch
+  }
+}

package/src/slim-select/tsconfig.json

@@ -1,8 +1,14 @@
 {
   "compilerOptions": {
-    "strict": true, /* Enable all strict type-checking options. */
-    "declaration": true, /* Generates corresponding '.d.ts' file. */
+    "target": "es2016",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "strict": true /* Enable all strict type-checking options. */,
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
     "outDir": "../../dist", // Output to dist folder
-    "removeComments": true /* Do not emit comments to output. */
-  }
-}
+    "removeComments": true /* Do not emit comments to output. */,
+    "importHelpers": true /* Import emit helpers from 'tslib'. */
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["**/*.test.ts"]
+}

package/src/vue/slimselect.vue

@@ -0,0 +1,61 @@
+<script lang="ts">
+import { defineComponent, ref, watch, onMounted, onBeforeUnmount } from 'vue'
+import SlimSelect from '../slim-select'
+
+export default defineComponent({
+  name: 'SlimSelect',
+  props: {
+    options: {
+      type: Array,
+      required: true,
+    },
+    value: {
+      type: [String, Number, Array],
+      required: true,
+    },
+    config: {
+      type: Object,
+      required: false,
+    },
+  },
+  emits: ['update:value'],
+  setup(props, { emit }) {
+    const selectRef = ref(null)
+    let select: SlimSelect
+
+    const updateValue = (value: string | number | string[] | number[]) => {
+      emit('update:value', value)
+    }
+
+    const updateSelect = () => {
+      select.set(props.value)
+    }
+
+    const initSelect = () => {
+      select = new SlimSelect(selectRef.value, {
+        ...props.config,
+        onChange: updateValue,
+      })
+    }
+
+    onMounted(() => {
+      initSelect()
+    })
+
+    onBeforeUnmount(() => {
+      select.destroy()
+    })
+
+    watch(
+      () => props.value,
+      () => {
+        updateSelect()
+      },
+    )
+
+    return {
+      selectRef,
+    }
+  }
+})
+</script>

package/tsconfig.json

@@ -1,37 +1,18 @@
 {
   "compilerOptions": {
+    "declaration": true,
     "target": "esnext",
+    "useDefineForClassFields": true,
     "module": "esnext",
-    "strict": true,
-    "importHelpers": true,
     "moduleResolution": "node",
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "jsx": "preserve",
+    "allowJs": false,
     "sourceMap": true,
-    "baseUrl": ".",
-    "types": [
-      "webpack-env"
-    ],
-    "paths": {
-      "@/*": [
-        "src/*"
-      ]
-    },
-    "lib": [
-      "esnext",
-      "dom",
-      "dom.iterable",
-      "scripthost"
-    ]
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "importHelpers": true,
+    "lib": ["esnext", "dom"]
   },
-  "include": [
-    "src/**/*.ts",
-    "src/**/*.tsx",
-    "src/**/*.vue",
-    "tests/**/*.ts",
-    "tests/**/*.tsx"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
 }

package/vite.config.ts

@@ -0,0 +1,18 @@
+import vue from '@vitejs/plugin-vue'
+import { defineConfig } from 'vite'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  build: {
+    outDir: 'docs',
+    emptyOutDir: true,
+    rollupOptions: {
+      output: {
+        entryFileNames: `assets/[name].js`,
+        chunkFileNames: `assets/[name].js`,
+        assetFileNames: `assets/[name].[ext]`,
+      },
+    },
+  },
+  plugins: [vue()],
+})

package/.browserslistrc

@@ -1,4 +0,0 @@
-> 1%
-last 2 versions
-not ie <= 8
-ie 11

package/.postcssrc.js

@@ -1,5 +0,0 @@
-module.exports = {
-  plugins: {
-    autoprefixer: {}
-  }
-}