npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mkyy/mui-search-bar

v0.5.2

Published

SearchBar component designed with Material-UI v5

Downloads

989

Readme

mui-search-bar

GitHub npm coffee

Installation

npm i --save @mkyy/mui-search-bar

or

yarn add @mkyy/mui-search-bar

Note: This component is intended to projects using Material-UI v5+, if you're still using an older version, I recommend material-ui-search-bar.

Usage

The 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.

import SearchBar from '@mkyy/mui-search-bar';

return (
  <SearchBar
    value={textFieldValue}
    onChange={newValue => setTextFieldValue(newValue)}
    onSearch={handleSearch}
  />
);

!Important: If you are using options to auto-complete suggests, you need to get the value of the clicked option inside your handleSearch function.

If you try using your controlled input state to manage this event, you'll get the old value, and not the labelOptionValue.

import SearchBar from '@mkyy/mui-search-bar';

const handleSearch = labelOptionValue => {
  //...
  console.log(labelOptionValue);
};

return (
  <SearchBar
    value={textFieldValue}
    onChange={newValue => setTextFieldValue(newValue)}
    onSearch={handleSearch}
  />
);

SearchBar Properties

| Name | Type | Default | Description | | ---------------- | ------------------ | ---------- | -------------------------------------------------- | | className | string | '' | Custom top-level class. | | width | string or number | '300px' | Sets the width of SearchBar. | | height | string or number | '40px' | Sets the height of SearchBar. | | disabled | bool | false | Disables text field. | | onCancelResearch | func | | Fired when the search is cancelled. | | onChange | func | | Fired when the text value changes. | | onSearch | func | | Fired when enter button is pressed. | | placeholder | string | 'Search' | Sets placeholder text for the embedded text field. | | style | object | null | Override the inline-styles of the root element. | | value | string | '' | The value of the text field. | | options | Array<string> | [] | Options of autocomplete suggests list. |

* required properties

License

The files included in this repository are licensed under the MIT license.

Contributions

Feel free to open an issue or add a pull request. Anytime. Really, I mean it.

Also, if you like my work, I'll let you know that I love coffee.