@ecodev/natural-editor 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. package/README.md +42 -0
  2. package/bundles/ecodev-natural-editor.umd.js +858 -0
  3. package/bundles/ecodev-natural-editor.umd.js.map +1 -0
  4. package/ecodev-natural-editor.d.ts +5 -0
  5. package/esm2015/ecodev-natural-editor.js +5 -0
  6. package/esm2015/lib/editor.component.js +161 -0
  7. package/esm2015/lib/editor.module.js +72 -0
  8. package/esm2015/lib/link-dialog/link-dialog.component.js +43 -0
  9. package/esm2015/lib/menu.js +220 -0
  10. package/esm2015/lib/schema.js +21 -0
  11. package/esm2015/public-api.js +8 -0
  12. package/fesm2015/ecodev-natural-editor.js +508 -0
  13. package/fesm2015/ecodev-natural-editor.js.map +1 -0
  14. package/lib/editor.component.d.ts +47 -0
  15. package/lib/editor.module.d.ts +19 -0
  16. package/lib/link-dialog/link-dialog.component.d.ts +18 -0
  17. package/lib/menu.d.ts +39 -0
  18. package/lib/schema.d.ts +2 -0
  19. package/package.json +37 -0
  20. package/public-api.d.ts +3 -0
package/README.md ADDED
@@ -0,0 +1,42 @@
1
+ # Natural
2
+
3
+ [![Build Status](https://github.com/Ecodev/natural/workflows/main/badge.svg)](https://github.com/Ecodev/natural/actions)
4
+ [![Total Downloads](https://img.shields.io/npm/dt/@ecodev/natural.svg)](https://www.npmjs.com/package/@ecodev/natural)
5
+ [![Latest Stable Version](https://img.shields.io/npm/v/@ecodev/natural.svg)](https://www.npmjs.com/package/@ecodev/natural)
6
+ [![License](https://img.shields.io/npm/l/@ecodev/natural.svg)](https://www.npmjs.com/package/@ecodev/natural)
7
+ [![Join the chat at https://gitter.im/Ecodev/natural](https://badges.gitter.im/Ecodev/natural.svg)](https://gitter.im/Ecodev/natural)
8
+
9
+ This project is a collection of Angular Material components and various utilities classes for Angular projects.
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ yarn add @ecodev/natural
15
+ ```
16
+
17
+ ## Development
18
+
19
+ The most useful commands for development are:
20
+
21
+ - `yarn dev` to start a development server
22
+ - `yarn build-demo` to build the docs locally (it will be published automatically by GitHub Actions)
23
+ - `git tag -am 1.2.3 1.2.3 && git push` to publish the lib to npm (via GitHub Actions `release` job)
24
+
25
+ ### i18n
26
+
27
+ This library is ready to be translated, but it does not ship translations. It is up to the consuming
28
+ application to extract and translate strings.
29
+
30
+ ## Components
31
+
32
+ ### Natural Search
33
+
34
+ This is an Angular component to search for things via configurable facets. Facets may be
35
+ configured to use one of the built-in component, or a custom component to input values.
36
+
37
+ See the component in action on [the demo page](https://ecodev.github.io/natural).
38
+
39
+ #### Prior work
40
+
41
+ While the implementation is entirely different, [VisualSearch.js
42
+ ](https://github.com/documentcloud/visualsearch/) was an important inspiration.