Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove contexture-react #262

Merged
merged 3 commits into from
Nov 23, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"settings": {
"import/resolver": {
"typescript": {
"extensions": [".ts", ".tsx", ".js", ".jsx"]
"extensions": [".ts", ".js"]
}
}
}
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,6 @@ To keep track of all this, contexture's client manages the UI state and optimize
- Nodes track statuses like loading, last update times, and validation out of the box.
- The client can debounce changes to the entire tree and drop intermediate results.

### React

Contexture has a react component library that interacts with the client. There are generic components ranging from nested query builders to entire search layouts. Every included node type also has a component (like checkbox lists). You can drop in a single component for a complete UI with dynamic filters - or build it up component by component. There's even a robust theming API to customize every part of the UI.

### How does all this work?

The client's functions ("actions") dispatch events to nodes (much like redux). An action might mutate node properties, pause or resume a node, or add, remove, or move a node to a group. Node-specific event reactor functions then determine which nodes to update. After an optional debounce, requests go to the server when there are nodes to update. The server walks the tree and runs queries for each node based on its type and the relevant provider. For more detailed information, each package has its own readme.
Expand All @@ -47,9 +43,10 @@ The client's functions ("actions") dispatch events to nodes (much like redux). A
| [provider-elasticsearch](./packages/provider-elasticsearch) | [contexture-elasticsearch](https://www.npmjs.com/package/contexture-elasticsearch) | Elasticsearch provider for contexture |
| [provider-mongo](./packages/provider-mongo) | [contexture-mongo](https://www.npmjs.com/package/contexture-mongo) | MongoDB provider for contexture |
| [client](./packages/client) | [contexture-client](https://www.npmjs.com/package/contexture-client) | The client library that manages the DSL, allowing for hyper efficient updates running only what is exactly needed |
| [react](./packages/react) | [contexture-react](https://www.npmjs.com/package/contexture-react) | React components for building contexture interfaces |
| [export](./packages/export) | [contexture-export](https://www.npmjs.com/package/contexture-export) | Export searches into files or any other target |

We used to offer a React library with pre-built components for getting up and running quickly with contexture but it was removed in [this PR](https://github.com/smartprocure/contexture/pull/262)

#### Ecosystem And Resources

- [Elasticon 2018 Talk About Contexture](http://github.com/smartprocure/contexture-ec18-talk)
21 changes: 0 additions & 21 deletions packages/react/.eslintrc.json

This file was deleted.

1 change: 0 additions & 1 deletion packages/react/.prettierignore

This file was deleted.

57 changes: 0 additions & 57 deletions packages/react/.storybook/main.js

This file was deleted.

27 changes: 0 additions & 27 deletions packages/react/.storybook/preview.jsx

This file was deleted.

Loading
Loading