Filters - Pharen

Use Filters to build composable filtering controls. This page covers every Vue component exported by the public module.

Install the package and import its styles once. See Installation for the complete setup.

Import

import { Filters, FilterInput, FilterValueSelector } from '@pharen/ui';

Example

<script setup lang="ts">
import { Filters } from '@pharen/ui';
import { ref } from 'vue';
import type { Filter, FilterFieldConfig } from '@pharen/ui';

const filters = ref<Filter[]>([]);
const fields: FilterFieldConfig[] = [
  { id: 'status', label: 'Status', type: 'select', options: [
    { label: 'Active', value: 'active' },
    { label: 'Paused', value: 'paused' },
  ] },
];
</script>

<template>
  <Filters v-model="filters" :fields="fields" />
</template>

Exports

Export	Purpose
`Filters`	Exported Vue component from this module.
`FilterInput`	Exported Vue component from this module.
`FilterValueSelector`	Exported Vue component from this module.

Source

Open the source on GitHub