strapi-plugin-content-search

    0.6.0 • Public • Published

    Strapi - Content search service (bookshelf only)

    Utilities for Strapi Headless CMS that allow searching across content types fields which have searchable property.

    Installation

    (Use yarn to install this plugin within your Strapi project (recommended). Install yarn with these docs.)

    yarn add strapi-plugin-content-search

    Enjoy 🎉

    🖐 Requirements

    Complete installation requirements are exact same as for Strapi itself and can be found in the documentation under Installation Requirements.

    Supported Strapi versions:

    • Strapi v3.3.3 (recently tested)
    • Strapi v3.x

    (This plugin may work with the older Strapi versions, but these are not tested nor officially supported at this time.)

    We recommend always using the latest version of Strapi to start your new projects.

    Features

    -Search by content type entity field Now you will be able to search through all content-type fields!

    Component model configuration

    Component by default is not searchable. To enable Component to be included in search or be able to filter by, you've to add option searchable to true in a configuration json file (*.settings.json):

    For example for component called paragraph_component You need to change components/text/paragraph_component.json by modifying option object:

    {
      "collectionName": "components_text_paragraph_components",
      "info": {
        "name": "paragraph_component",
        "icon": "align-justify"
      },
      "options": {
    ++    "searchable": true
      },
      "attributes": {
        "body": {
          "type": "text",
    ++    "searchable": true
        }
      }
    }

    Usage

    To be able to find model content field, model needs searchable property with true value, then just use endpoint with required query parameter _q:

    /content-search?_q=lorem
    

    Response:

    [
        {
            "id": 1,
            "title": "lorem",
            "content": "lorem ipsum",
            "created_at": "2020-07-23T09:48:24.140Z",
            "updated_at": "2020-07-23T09:48:24.140Z",
            "__contentType": "exmaple_content_type"
        }
    ]
    

    Custom hook

    transformResponse

    To be able to modify payload before send response add transformResponse to plugin configuration:

    // /config/plugins.js
    module.exports = ({ env }) => ({
      'content-search': {
        transformResponse: (payload) => {
          return {
            ...payload,
            injectedProperty: 'injectedProperty',
          };
        },
      },
    });

    Contributing

    Feel free to fork and make a Pull Request to this plugin project. All the input is warmly welcome!

    Community support

    For general help using Strapi, please refer to the official Strapi documentation. For additional help, you can use one of these channels to ask a question:

    • Email us We are always glad to help.
    • Slack We're present on official Strapi slack workspace.
    • GitHub (Bug reports, Contributions, Questions and Discussions)

    License

    MIT License Copyright (c) 2020 VirtusLab Sp. z o.o. & Strapi Solutions.

    Keywords

    none

    Install

    npm i strapi-plugin-content-search

    DownloadsWeekly Downloads

    88

    Version

    0.6.0

    License

    MIT

    Unpacked Size

    242 kB

    Total Files

    15

    Last publish

    Collaborators

    • mstrag