{"id":13453566,"url":"https://github.com/TeamWertarbyte/material-ui-search-bar","last_synced_at":"2025-03-24T01:31:38.187Z","repository":{"id":21337810,"uuid":"92407580","full_name":"TeamWertarbyte/material-ui-search-bar","owner":"TeamWertarbyte","description":"Material design search bar","archived":false,"fork":false,"pushed_at":"2023-10-24T11:51:43.000Z","size":2995,"stargazers_count":261,"open_issues_count":40,"forks_count":82,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-25T06:34:03.185Z","etag":null,"topics":["material-ui","react","search","ui-component"],"latest_commit_sha":null,"homepage":"https://mui.wertarbyte.com/#material-ui-search-bar","language":"JavaScript","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/TeamWertarbyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["leMaik","saschb2b"]}},"created_at":"2017-05-25T13:46:04.000Z","updated_at":"2024-10-11T17:07:11.000Z","dependencies_parsed_at":"2023-01-13T21:25:00.930Z","dependency_job_id":"4ee50114-cb67-4a15-bacf-42921adcb542","html_url":"https://github.com/TeamWertarbyte/material-ui-search-bar","commit_stats":{"total_commits":101,"total_committers":19,"mean_commits":5.315789473684211,"dds":0.5643564356435644,"last_synced_commit":"1696e21e1fa403168a65f436c4af518f0e17f394"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-ui-search-bar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-ui-search-bar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-ui-search-bar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeamWertarbyte%2Fmaterial-ui-search-bar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeamWertarbyte","download_url":"https://codeload.github.com/TeamWertarbyte/material-ui-search-bar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244345081,"owners_count":20438241,"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":["material-ui","react","search","ui-component"],"created_at":"2024-07-31T08:00:43.359Z","updated_at":"2025-03-24T01:31:37.305Z","avatar_url":"https://github.com/TeamWertarbyte.png","language":"JavaScript","funding_links":["https://github.com/sponsors/leMaik","https://github.com/sponsors/saschb2b"],"categories":["JavaScript"],"sub_categories":[],"readme":"# Material Search Bar\n\n![Example](demo.gif)\n\nSee this component in [action](https://teamwertarbyte.github.io/material-ui-search-bar/)\n\n## Installation\n\n```shell\nnpm i --save material-ui-search-bar\n```\n\nNote: If you're still using Material-UI v3, please install v0.x of the search bar using `npm i --save material-ui-search-bar@beta`\n\n## Usage\n\nThe `SearchBar` is a _controlled input_, meaning that _you_ need to keep the input state. This allows for much flexibility, e.g. you can change and clear the search input just by changing its props.\n\n```js\nimport SearchBar from \"material-ui-search-bar\";\n// *snip*\n\nreturn (\n  \u003cSearchBar\n    value={this.state.value}\n    onChange={(newValue) =\u003e this.setState({ value: newValue })}\n    onRequestSearch={() =\u003e doSomethingWith(this.state.value)}\n  /\u003e\n);\n```\n\n### SearchBar Properties\n\n| Name            | Type     | Default                                       | Description                                             |\n| --------------- | -------- | --------------------------------------------- | ------------------------------------------------------- |\n| cancelOnEscape  | `bool`   |                                               | Whether to clear search on escape                       |\n| classes\\*       | `object` |                                               | Override or extend the styles applied to the component. |\n| className       | `string` | `''`                                          | Custom top-level class                                  |\n| closeIcon       | `node`   | `\u003cClearIcon style={{ color: grey[500] }} /\u003e`  | Override the close icon.                                |\n| disabled        | `bool`   | `false`                                       | Disables text field.                                    |\n| onCancelSearch  | `func`   |                                               | Fired when the search is cancelled.                     |\n| onChange        | `func`   |                                               | Fired when the text value changes.                      |\n| onRequestSearch | `func`   |                                               | Fired when the search icon is clicked.                  |\n| placeholder     | `string` | `'Search'`                                    | Sets placeholder text for the embedded text field.      |\n| searchIcon      | `node`   | `\u003cSearchIcon style={{ color: grey[500] }} /\u003e` | Override the search icon.                               |\n| style           | `object` | `null`                                        | Override the inline-styles of the root element.         |\n| value           | `string` | `''`                                          | The value of the text field.                            |\n\n\\* required property\n\nAny other properties supplied will be spread to the underlying [`Input`](https://material-ui.com/api/input/#input) component.\n\n## License\n\nThe files included in this repository are licensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeamWertarbyte%2Fmaterial-ui-search-bar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTeamWertarbyte%2Fmaterial-ui-search-bar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeamWertarbyte%2Fmaterial-ui-search-bar/lists"}