@usereactify/search 2.1.0-beta.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.
- package/README.md +41 -0
- package/package.json +62 -0
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Reactify Search UI
|
|
2
|
+
|
|
3
|
+
This library provides React components and hooks for building UI's for the [Reactify Search](https://bitbucket.org/usereactify/reactify-search) app.
|
|
4
|
+
|
|
5
|
+
The aim of this library is not to build a search and filter interface from the ground up. The aim of this library is to abstract the complexities of Reactify Search, whilst providing the developer a wide range of approaches and escape hatches to build in the way they want to. To do this, we wrap a mature Elasticsearch UI library called [Reactivesearch](https://github.com/appbaseio/reactivesearch) (similar name, but completely unaffiliated with Reactify Search).
|
|
6
|
+
|
|
7
|
+
## Getting started
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install @reactify-apps/search
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
You should always begin with the `Provider` component, which you need to pass the Reactify Search config and index name, using whichever mechanism is most appropriate for your project. Within the provider, you can then begin to render components from the `@reactify-apps/search` package or ordinary [Reactivesearch](https://github.com/appbaseio/reactivesearch) components.
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
import { Provider } from "@reactify-apps/search";
|
|
17
|
+
|
|
18
|
+
export const YourComponent: React.FC = () => {
|
|
19
|
+
return (
|
|
20
|
+
<Provider index="my-cool-shop" config={config}>
|
|
21
|
+
<YourComponents />
|
|
22
|
+
</Provider>
|
|
23
|
+
);
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Contributing
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
# install dependencies
|
|
31
|
+
npm install
|
|
32
|
+
|
|
33
|
+
# watch and build the package
|
|
34
|
+
npm run watch
|
|
35
|
+
|
|
36
|
+
# serve storybook to interact with components
|
|
37
|
+
npm run storybook
|
|
38
|
+
|
|
39
|
+
# release a version
|
|
40
|
+
npm run release
|
|
41
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@usereactify/search",
|
|
3
|
+
"description": "React UI library for Reactify Search",
|
|
4
|
+
"version": "2.1.0-beta.0",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"dist",
|
|
10
|
+
"README.md"
|
|
11
|
+
],
|
|
12
|
+
"scripts": {
|
|
13
|
+
"watch": "tsc --watch",
|
|
14
|
+
"release": "standard-version",
|
|
15
|
+
"build": "rimraf dist && tsc",
|
|
16
|
+
"prettier": "prettier --write .",
|
|
17
|
+
"storybook": "start-storybook -p 6006",
|
|
18
|
+
"build-storybook": "build-storybook"
|
|
19
|
+
},
|
|
20
|
+
"husky": {
|
|
21
|
+
"hooks": {
|
|
22
|
+
"pre-commit": "pretty-quick --staged",
|
|
23
|
+
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
"commitlint": {
|
|
27
|
+
"extends": [
|
|
28
|
+
"@commitlint/config-conventional"
|
|
29
|
+
]
|
|
30
|
+
},
|
|
31
|
+
"dependencies": {
|
|
32
|
+
"ahooks": "2.10.11",
|
|
33
|
+
"axios": "0.25.0",
|
|
34
|
+
"currency.js": "2.0.4",
|
|
35
|
+
"debug": "4.3.2"
|
|
36
|
+
},
|
|
37
|
+
"peerDependencies": {
|
|
38
|
+
"@appbaseio/reactivesearch": "^3.16.1",
|
|
39
|
+
"react": "^17.0.0"
|
|
40
|
+
},
|
|
41
|
+
"devDependencies": {
|
|
42
|
+
"@appbaseio/reactivesearch": "3.24.3",
|
|
43
|
+
"@commitlint/cli": "13.2.0",
|
|
44
|
+
"@commitlint/config-conventional": "13.2.0",
|
|
45
|
+
"@storybook/addon-actions": "6.3.10",
|
|
46
|
+
"@storybook/addon-essentials": "6.3.10",
|
|
47
|
+
"@storybook/addon-links": "6.3.10",
|
|
48
|
+
"@storybook/react": "6.3.10",
|
|
49
|
+
"@types/axios": "0.14.0",
|
|
50
|
+
"@types/debug": "4.1.7",
|
|
51
|
+
"@types/react": "17.0.27",
|
|
52
|
+
"babel-loader": "8.2.2",
|
|
53
|
+
"husky": "4.3.8",
|
|
54
|
+
"prettier": "2.4.1",
|
|
55
|
+
"pretty-quick": "3.1.1",
|
|
56
|
+
"react": "17.0.2",
|
|
57
|
+
"react-dom": "17.0.2",
|
|
58
|
+
"rimraf": "3.0.2",
|
|
59
|
+
"standard-version": "9.3.1",
|
|
60
|
+
"typescript": "4.4.3"
|
|
61
|
+
}
|
|
62
|
+
}
|