https://github.com/ecodev/natural

Angular Material components and various utilities
https://github.com/ecodev/natural

angular hacktoberfest

Last synced: 17 days ago
JSON representation

Angular Material components and various utilities

• Host: GitHub
• URL: https://github.com/ecodev/natural
• Owner: Ecodev
• License: mit
• Created: 2019-04-19T18:06:48.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2025-09-18T10:54:41.000Z (5 months ago)
• Last Synced: 2025-09-18T12:35:32.547Z (5 months ago)
• Topics: angular, hacktoberfest
• Language: TypeScript
• Homepage: https://ecodev.github.io/natural
• Size: 7.31 MB
• Stars: 1
• Watchers: 6
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Natural

[![Build Status](https://github.com/Ecodev/natural/workflows/main/badge.svg)](https://github.com/Ecodev/natural/actions)

[![Total Downloads](https://img.shields.io/npm/dt/@ecodev/natural.svg)](https://www.npmjs.com/package/@ecodev/natural)

[![Latest Stable Version](https://img.shields.io/npm/v/@ecodev/natural.svg)](https://www.npmjs.com/package/@ecodev/natural)

[![License](https://img.shields.io/npm/l/@ecodev/natural.svg)](https://www.npmjs.com/package/@ecodev/natural)

This project is a collection of Angular Material components and various utilities classes for Angular projects.

## Install

```bash

yarn add @ecodev/natural

```

## Development

The most useful commands for development are:

- `yarn dev` to start a development server

- `yarn build-demo` to build the docs locally (it will be published automatically by GitHub Actions)

- `git tag -am 1.2.3 1.2.3 && git push` to publish the lib to npm (via GitHub Actions `release` job)

### i18n

This library is ready to be translated, but it does not ship translations. It is up to the consuming

application to extract and translate strings.

## Components

### Natural Search

This is an Angular component to search for things via configurable facets. Facets may be

configured to use one of the built-in component, or a custom component to input values.

See the component in action on [the demo page](https://ecodev.github.io/natural).

#### Prior work

While the implementation is entirely different, [VisualSearch.js

](https://github.com/documentcloud/visualsearch/) was an important inspiration.