{"id":16198843,"url":"https://github.com/anshumanv/react-expression-builder","last_synced_at":"2025-03-16T10:32:49.063Z","repository":{"id":40765625,"uuid":"234886367","full_name":"anshumanv/react-expression-builder","owner":"anshumanv","description":"A React component for building function expressions with typeahead support","archived":false,"fork":false,"pushed_at":"2023-01-07T18:52:59.000Z","size":1839,"stargazers_count":29,"open_issues_count":21,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-26T18:51:24.822Z","etag":null,"topics":["component","expression","function","javascript","module","package","react"],"latest_commit_sha":null,"homepage":"https://react-expression-builder.netlify.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anshumanv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-19T11:09:18.000Z","updated_at":"2025-01-24T13:08:09.000Z","dependencies_parsed_at":"2023-02-07T21:31:24.873Z","dependency_job_id":null,"html_url":"https://github.com/anshumanv/react-expression-builder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anshumanv%2Freact-expression-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anshumanv%2Freact-expression-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anshumanv%2Freact-expression-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anshumanv%2Freact-expression-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anshumanv","download_url":"https://codeload.github.com/anshumanv/react-expression-builder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814907,"owners_count":20352037,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component","expression","function","javascript","module","package","react"],"created_at":"2024-10-10T09:15:02.788Z","updated_at":"2025-03-16T10:32:48.613Z","avatar_url":"https://github.com/anshumanv.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003e react-expression-builder \u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://www.npmjs.com/package/react-expression-builder\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/react-expression-builder.svg?style=for-the-badge\" align=\"center\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://www.npmjs.com/package/react-expression-builder\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/dt/react-expression-builder.svg?style=for-the-badge\" align=\"center\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://github.com/anshumanv/react-expression-builder\"\u003e\n  \u003cimg src=\"https://img.shields.io/github/workflow/status/anshumanv/react-expression-builder/test?style=for-the-badge\" align=\"center\"\u003e\n\u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003chr\u003e\n\n\u003cp align=\"center\"\u003eA bare-bones react component to build function expressions with your data.\u003c/p\u003e\n\n### Features\n\n- Typeahead support\n- Full keyboard navigation and deletion\n- Easy custom styling as per input\n- Input validation at granular level\n- Customizable options\n- Single Dependency, no bloat\n\n### Installation\n\nInstall the package -\n\n```sh\nnpm i react-expression-builder\n\nOR\n\nyarn add react-expression-builder\n```\n\n### Usage\n\n```js\nimport ExpressionBuilder from 'react-expression-builder'\n\n//1. accumulate your options\n// fn must have an additional property 'params' -  eg `params: ['dim', 'delimiter', 'occurrence_number']`\nconst options = [{..., key: '...', type: '...', label: '...',...}, {...}]\n\n// regex to match entires within \"\"\nconst stringRegex = /\"([^\\\\\"]|\\\\\")*\"/\n\n// Optional - Function called on every state change, store your changes on the server\nconst onChangeFn = editorState =\u003e console.log(editorState, editorState.buildExpression())\n\n// Optional - class for the expression element, use for optional styling\nconst expressionRootClass = 'root-class'\n\n// Optional - class for the input container\nconst expressionInputClass = 'input-class'\n\n// Optional - Function which validates all the input values and returns a bool.\nconst validationFn = val =\u003e {\n\treturn !isNaN(val) || stringRegex.test(val)\n}\n\n\u003cExpressionBuilder\n  onChangeFn={onChangeFn}\n  options={options}\n  expressionRootClass={expressionRootClass} // Optional\n  expressionInputClass={expressionInputClass} // Optional\n  placeholder=\"Enter your expression\" // Optional\n  initialFocus={true} // if you want your input to be focussed on mount by default\n  validationFn={validationFn} // Optional\n/\u003e\n\n```\n\n### Data Structure\n\nUses an N-Ary tree to store/manipulate the expression data, simple recursive function gives you the complete string. You can check [DataStructure.ts](https://github.com/anshumanv/react-expression-builder/blob/master/src/utils/DataStructure.ts) for the simple implementation, if curious.\n\nNote - This only gives the skeleton and functionality, styling is upto the user, you can either make use of respective classes or wrap this component in a CSS-in-JS solution. For example, a nicely styled solution would look somewhat like [this](https://knitui.design/?path=/story/extractor--basic). This is not complete yet, need more work. Meanwhile, suggestions are appreciated.\n\n## Author\n\n[Anshuman Verma](https://github.com/anshumanv)\n\n[\u003cimg src=\"https://image.flaticon.com/icons/svg/185/185961.svg\" width=\"35\" padding=\"10\"\u003e](https://twitter.com/Anshumaniac12)\n[\u003cimg src=\"https://image.flaticon.com/icons/svg/185/185964.svg\" width=\"35\" padding=\"10\"\u003e](https://linkedin.com/in/anshumanv12)\n[\u003cimg src=\"https://image.flaticon.com/icons/svg/185/185981.svg\" width=\"35\" padding=\"10\"\u003e](https://www.facebook.com/anshumanv12)\n[\u003cimg src=\"https://image.flaticon.com/icons/svg/985/985680.svg\" width=\"35\" padding=\"10\"\u003e](https://www.paypal.me/AnshumanVerma)\n\n## Contribute\n\nFound a bug, please [create an issue](https://github.com/anshumanv/react-expression-builder/issues/new)\n\n## License\n\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/anshumanv/react-expression-builder/blob/master/LICENSE)\n\n\u003e © Anshuman Verma\n","funding_links":["https://www.paypal.me/AnshumanVerma"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanshumanv%2Freact-expression-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanshumanv%2Freact-expression-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanshumanv%2Freact-expression-builder/lists"}