https://github.com/realityloop/druxt-search

Provides JSON API Search integration for a Druxt (DRUpal nuXT) project.
https://github.com/realityloop/druxt-search

Last synced: about 1 year ago
JSON representation

Provides JSON API Search integration for a Druxt (DRUpal nuXT) project.

• Host: GitHub
• URL: https://github.com/realityloop/druxt-search
• Owner: Realityloop
• Created: 2020-07-12T22:02:33.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2021-02-27T02:45:21.000Z (about 5 years ago)
• Last Synced: 2025-02-15T11:39:17.253Z (about 1 year ago)
• Language: JavaScript
• Size: 286 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# \

[![CircleCI](https://circleci.com/gh/Realityloop/druxt-search.svg?style=svg)](https://circleci.com/gh/Realityloop/druxt-search)

[![Known Vulnerabilities](https://snyk.io/test/github/Realityloop/druxt-search/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Realityloop/druxt-search?targetFile=package.json)

[![codecov](https://codecov.io/gh/Realityloop/druxt-search/branch/develop/graph/badge.svg)](https://codecov.io/gh/Realityloop/druxt-search)

Provides JSON API Search integration for a Druxt (DRUpal nuXT) project.

## Install

`$ npm install druxt-search`

## Usage

Add module to `nuxt.config.js`

```js

module.exports = {

  modules: [

    'druxt-search'

  ],

  druxt: {

    baseUrl: 'https://demo-api.druxtjs.org'

  }

}

```

## Options

### Base Druxt options

These options are available to all Druxt modules.

| Option | Type | Required | Default | Description |

| --- | --- | --- | --- | --- |

| `axios` | `object` | No | `{}` | [Axios instance settings](https://github.com/axios/axios#axioscreateconfig). |

| `baseUrl` | `string` | Yes | `null` | Base URL for the Drupal installation. |