Skip to main content
Module

x/react_querybuilder/examples/README.md

The Query Builder component for React
Go to Latest
File

Examples

Cloning locally

To clone a copy of an example without cloning this entire repo:

npx degit github:react-querybuilder/react-querybuilder/examples/example-name my-rqb-example

Replace example-name with the example’s folder name. For example, to clone the basic-ts example:

npx degit github:react-querybuilder/react-querybuilder/examples/basic-ts my-rqb-example

CodeSandbox

To set up CodeSandbox using one of the examples as a template:

  1. Navigate to the example folder (e.g. basic-ts) on GitHub.
  2. In the browser address bar, change the domain of the URL from github.com to githubbox.com (add “box” between “github” and “.com”) and press Enter/Return.

You will be forwarded to codesandbox.io with the example project preloaded.

StackBlitz

To set up StackBlitz using one of the examples as a template:

  1. Navigate to the example folder (e.g. basic-ts) on GitHub.
  2. In the browser address bar, change https://github.com/ to https://stackblitz.com/github/ and press Enter/Return.

stackblitz.com will load with the example project preloaded.

Development

To update the examples, modify the _template example and/or exampleConfigs.ts and then run bun generate-examples from the repo root directory (requires Bun). The examples configured in exampleConfigs.ts will be deleted and regenerated.