https://github.com/mendixlabs/offline-search

Deprecated, replace by List view controls widgets, https://github.com/mendixlabs/list-view-controls
https://github.com/mendixlabs/offline-search

Last synced: 8 months ago
JSON representation

Deprecated, replace by List view controls widgets, https://github.com/mendixlabs/list-view-controls

• Host: GitHub
• URL: https://github.com/mendixlabs/offline-search
• Owner: mendixlabs
• License: apache-2.0
• Created: 2017-07-10T08:15:03.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-01T14:15:49.000Z (over 8 years ago)
• Last Synced: 2025-07-01T12:53:52.362Z (12 months ago)
• Language: TypeScript
• Homepage:
• Size: 530 KB
• Stars: 0
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/mendixlabs/offline-search.svg?branch=master)](https://travis-ci.org/mendixlabs/offline-search)

[![Dependency Status](https://david-dm.org/mendixlabs/offline-search.svg)](https://david-dm.org/mendixlabs/offline-search)

[![Dev Dependency Status](https://david-dm.org/mendixlabs/offline-search.svg#info=devDependencies)](https://david-dm.org/mendixlabs/offline-search#info=devDependencies)

[![codecov](https://codecov.io/gh/mendixlabs/offline-search/branch/master/graph/offline-search.svg)](https://codecov.io/gh/mendixlabs/offline-search)

![badge](https://img.shields.io/badge/mendix-7.6.0-green.svg)

# Offline search

Add an interactive search box to your list view, even offline!

It supports searching on single field similar to the built-in list view search capabilities.

## Features

* Search through a single field

* Open search in default

* Hide / Show search bar

* When the list view is not specified, the widget will pick the closest one.

## Limitations

Supports only list views

The following data types are supported:

 - String

 - Integer

 - Long

 - Decimal

 - Enumeration

 - AutoNumber

Due to current platform constraints, the offline widget cannot search on multiple fields.

## Dependencies

Mendix 7.4

## Demo project

[https://offlinesearch.mxapps.io/](https://offlinesearch.mxapps.io/)

![Not Searching](/assets/LV_Normal_Offline.jpg)

![Searching](/assets/LV_Searching_Offline.jpg)

## Usage

### Data source configuration

![Data source](/assets/Datasource.png)

 - On the `List view name` option of the `Data source` tab, input the "name" property of the list widget you want to search in.

 - On the `Search method` option of the `Data source` tab, select the search name that you will use to constrain the data on the grid.

 - On the `List view entity` option of the `Data source` tab, input the name of the entity to be used in the filter. The entity shown in the list view widget. You must enter the value as: `ModuleName.EntityName`

 - On the `Search attribute` option of the `Data source` tab, input the name of the field or attribute on the list widget entity to be searched. You must enter the name of the attribute manually, exactly as it appears in the domain model.

 - On the `Default query` option of the `Data source` tab, input the name of default query to be used when the when the widget is first launched for the first time.

### Data source configuration

![Appearance](/assets/Appearance.png)

 - On the `Show search bar` option of the `Appearance` tab, select `yes` or `no` for visibility of the widget.

 - On the `Placeholder` option of the `Appearance` tab, input the placeholder to indicate what kind of input is expected as query

## Issues, suggestions and feature requests

Please report issues at [https://github.com/mendixlabs/offline-search/issues](https://github.com/mendixlabs/offline-search/issues).

## Development

Prerequisite: Install git, node package manager, webpack CLI, grunt CLI, Karma CLI

To contribute, fork and clone.

    git clone https://github.com/mendixlabs/offline-search.git

The code is in typescript. Use a typescript IDE of your choice, like Visual Studio Code or WebStorm.

To set up the development environment, run:

    npm install

Create a folder named dist in the project root.

Create a Mendix test project in the dist folder and rename its root folder to MxTestProject. Changes to the widget code shall be automatically pushed to this test project. Or get the test project from [https://github.com/mendixlabs/offline-search/releases/latest](https://github.com/mendixlabs/offline-search/latest)

    dist/MxTestProject

To automatically compile, bundle and push code changes to the running test project, run:

    grunt

To run the project unit tests with code coverage, results can be found at dist/testresults/coverage/index.html, run:

    npm test

or run the test continuously during development:

    karma start