vue-screener

Vue Screener

Easily search and filter data in Vue3
Documentation

Install

npm install vue-screener
# or
yarn add vue-screener

Basic Usage

<template>
  <VueScreener :data="[
    { category: 'Technology', product: 'Laptop', price: 799 },
    { category: 'Clothing', product: 'Sneakers', price: 60 }
  ]" />
</template>

<script setup>
import { VueScreener } from 'vue-screener'
import 'vue-screener/style.css'
</script>

Remote Control

Control the state externally using the useVueScreener hook:

<template>
  <VueScreener :screener="screener" />
</template>

<script setup>
import { VueScreener, useVueScreener } from 'vue-screener'
import 'vue-screener/style.css'

const screener = useVueScreener(data, {
  height: '400px',
  defaultCurrentPage: 1,
  defaultRowsPerPage: 10,
  defaultSortField: 'id',
  defaultSortDirection: 'desc',
  columns: {
    id: { width: '50px', order: 0 },
    name: { width: '150px', order: 1 },
    email: { width: '200px', order: 2 }
  }
})
</script>

Component Props

You can also configure options directly through VueScreener component props:

<template>
  <VueScreener
    :data="data"
    contentHeight="400px"
    :defaultCurrentPage="1"
    :defaultRowsPerPage="10"
    defaultSortField="id"
    defaultSortDirection="desc"
    :columns="{
      id: { width: '50px', order: 0 },
      name: { width: '150px', order: 1 }
    }"
    :disableSearchHighlight="false"
    :loading="false"
    title="My Table"
  />
</template>

Custom Styling

You can customize the appearance and layout by composing your own table using individual components. Here's an example:

<template>
  <VueScreener :screener="screener">
    <VueScreenerSearch :screener="screener" class="custom-search" />
    <VueScreenerTableView :screener="screener">
      <VueScreenerTableHead>
        <VueScreenerTableHeadCell
          v-for="column in screener.columns.value"
          :key="column.field"
          :screener="screener"
          :column="column"
          class="custom-header"
        />
      </VueScreenerTableHead>
      <VueScreenerTableRow
        v-for="row in screener.paginatedRows.value"
        :key="row.id"
        class="custom-row"
      >
        <VueScreenerTableCell
          v-for="column in screener.columns.value"
          :key="column.field"
          :screener="screener"
          :column="column"
          :row="row"
          class="custom-cell"
        />
      </VueScreenerTableRow>
    </VueScreenerTableView>
    <VueScreenerPagination :screener="screener" class="custom-pagination" />
  </VueScreener>
</template>

<script setup>
import {
  VueScreener,
  VueScreenerSearch,
  VueScreenerTableView,
  VueScreenerTableHead,
  VueScreenerTableHeadCell,
  VueScreenerTableRow,
  VueScreenerTableCell,
  VueScreenerPagination,
  useVueScreener
} from 'vue-screener'
import 'vue-screener/style.css'

const screener = useVueScreener(data)
</script>

Configuration Options

useVueScreener Options

• contentHeight: String - CSS height value for fixed height with scroll (optional)
• defaultCurrentPage: Number (default: 1)
• defaultRowsPerPage: Number (default: 10)
• defaultSortField: String
• defaultSortDirection: 'asc' | 'desc'
• columns: Column configuration object
• disableSearchHighlight: Boolean (default: false)
• loading: Boolean (default: false)

VueScreener Props

• data: Array of data (optional)
• screener: VueScreener state from useVueScreener (optional)
• class: String (optional)
• contentHeight: String - CSS height value for fixed height with scroll (optional)
• defaultCurrentPage: Number (default: 1)
• defaultRowsPerPage: Number (default: 10)
• defaultSortField: String
• defaultSortDirection: 'asc' | 'desc'
• columns: Column configuration object
• disableSearchHighlight: Boolean (default: false)
• loading: Boolean (default: false)
• title: String (optional)

Column Configuration

interface Column {
  width?: string | number
  label?: string
  order?: number
  isPinned?: boolean
  isSortable?: boolean
  hidden?: boolean
  format?: (value: any, row: Row) => string
}

Updating Options After Initialization

You can update options after initialization via the props or using the setOptions action:

screener.actions.setOptions({
  contentHeight: '600px',
  disableSearchHighlight: true,
  loading: true
})

License

MIT