Skip to content

Latest commit

 

History

History
163 lines (123 loc) · 2.82 KB

README.md

File metadata and controls

163 lines (123 loc) · 2.82 KB
Raw

A generic search component. please have a look at our demo's

Limitations

Max 1000 items in dataset. OdpMasterDetail:155

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Properties

Source

dataset

  • type: String
  • required: true

query

  • type: String
  • default: 'Zoek op trefwoord'

Defines the label of the text input field.

horizontal

  • type: Boolean
  • default: false

Determines if the teasers are rendered in a grid or as a stacked column.

formFields

  • type: Array as PropType<FormField[]>
  • default: () => []

sort

  • type: String

random

  • type: Boolean
  • default: false

theme

type: String default: 'cs--cyan'

Events

This component throws events on filter and on opening a detail.
These can be catched and passed on the Google Tag Manager.

More information on passing custom events to GTM

For example:

odpSearch.addEventListener('filter', sendToGTM)
odpSearch.addEventListener('detail', sendToGTM)

function sendToGTM(e) {
    if (window.dataLayer) {
      window.dataLayer.push({
        event: 'custom_event_' + e.type,
        custom_event: {
          detail: e.detail[0]
        }
      })
    }
}

Types

FormField

export interface FormField {
  type?: string;
  label: string;
  column: string;
  value?: string;
  options: [{ name: string; value: string } | string];
}

Return value of the source

export interface Dataset {
  nhits: number;
  parameters: { [key: string]: string };
  records: {
    recordid: string;
    fields: Row;
  }[];
}

One row in the dataset

export interface Row {
titel: string;
  recordid: string;
  teaser_text: string;
  teaser_img_url?: string;
  label_1?: string;
  label_2?: string;
  label1hidden?: string;
  label2hidden?: string;
  tag_1?: string;
  tag_2?: string;
  tag_3?: string;
  tag1hidden?: string;
  tag2hidden?: string;
  tag3hidden?: string;
  adres?: string;
  telefoon?: string;
  email?: string;
  lees_meer?: string;
  beschrijving?: string;
  postcode?: string;
  gemeente?: string;
  coordinates?: string;
  website?: string;
  image_url?: string;
  openingsuren?: string;
}

Coordinates are expected as comma separated string in EPSG:3857 web-mercator cfr: '410456.8852, 6633842.9202'
tag_1, tag_2 and tag_3 can be a comma separated strings, resulting in multiple tags per category