react-query-builder icon indicating copy to clipboard operation
react-query-builder copied to clipboard

Documentation

Open pscanf opened this issue 10 years ago • 5 comments

Hey oh there. Awesome work!

I was just about to implement something very similar myself for a project I'm working on, but having found this I'll be using it. I've tried the examples and they work great.

Are you working on a README? I'm reading through the code to figure out how the component works, so I guess I could write some of it. If you already have something, I can maybe help to expand it.

Let me know! pscanf

pscanf avatar Mar 30 '15 14:03 pscanf

Hey there. I need this project for a work-related client project that I am working on but I am currently focusing on other aspects of the App so didn't have time to put further work into this. The version you see here is a very early prototype and not yet ready or close to ready even. I will keep working on it and be warned that there will be major overhauls and API breaks moving forward.

Regarding your question: Yes, definitely. We will have a full Readme and a proper docs section. The examples pages hosted on gh-pages will definitely include further explanation and documentation of the API and usage of the components.

Moving forward, many things will be implemented in the upcoming weeks:

  • There will be Drag&Drop for groups/rules using React-DND.
  • I am probably going to reconsider whether using context actually makes sense for some of the things i am using it here now.
  • I will add an actual query preview that itself is rendered through a react component hierarchy (currently it's only a string).
  • I will add related repositories for supporting different backend specs: Apache Solr, Elastic Search, MongoDB, MySql.
  • I will add support for revisions / history. E.g. reverting and un-reverting changes on the query (forward / backward arrow)
  • etc. etc.

Sorry for the flood of information. I just thought you should know before starting to use this. Btw. if you are interested in helping, feel free to send me PRs :)

fubhy avatar Mar 30 '15 14:03 fubhy

I'm basically doing the same thing! :smile:

I'll try to lend a hand, feel free to ping me if you need help on something specific.

pscanf avatar Mar 30 '15 15:03 pscanf

Hey guys - any progress on this? I need a similar component so was wondering if this is already usable or if I would have to write my own after all...

shaimo avatar Jan 06 '16 16:01 shaimo

How is it going now?

sunui avatar Oct 16 '17 11:10 sunui

Hi, Thanks for such a good package.

Please update the readme doc, I tried running this application, couple of packages were missing I installed them but now stuck with below error. Module build failed: ReferenceError: [BABEL] ..../react-query-builder-master/packages/react-query-builder-demo/src/index.js: Unknown option: ..../react-query-builder-master/node_modules/react/react.js.Children. Check out http://babeljs.io/docs/usage/options/ for more information about options.

Please help me.

ganeshgummani avatar Jun 12 '19 10:06 ganeshgummani