vue-legal-query-builder

A Vue 3 component for building legal document search queries using the legal-docs-client package.

Installation

npm install vue-legal-query-builder

Usage

Import the Component

<template>
  <LegalDocsForm 
    title="Search Legal Documents"
    :on-submit="handleSubmit"
    @success="onSuccess"
    @error="onError"
  />
</template>

<script setup>
import { LegalDocsForm, createLegalDocsClient } from 'vue-legal-query-builder'
import 'vue-legal-query-builder/style.css'

const client = createLegalDocsClient({
  // config (Optional)
})

const handleSubmit = async (queryParams) => {
  const results = await client.fetchDocuments(queryParams)
  return results
}

const onSuccess = (data) => {
  console.log('Search successful:', data)
}

const onError = (error) => {
  console.error('Search error:', error)
}
</script>

Accessing Legal Documents Client Functions

Since vue-legal-query-builder re-exports the entire legal-docs-client dependency, you only need to install vue-legal-query-builder to access both the form component and the client.

Props

| Prop | Type | Description | |------|------|-------------| | title | string | Form title (optional) | | subtitle | string | Form subtitle (optional) | | onSubmit | function | Callback that receives QueryParameters and returns search results (optional) |

Events

| Event | Payload | Description | |-------|---------|-------------| | @submit | QueryParameters | Emitted when form is submitted | | @success | any | Emitted when search completes successfully | | @error | Error | Emitted when an error occurs |

Requirements

• Vue 3.4 or higher

License

MIT

Development

Test the package locally:

npm run test:dev

License

MIT