GithubHelp home page GithubHelp logo

react-async-select's Introduction

React-Async-Select

The Async Select NPM package for React

Features

  • Search input
  • Render search list
  • display selected list item
  • customize style
  • arrow key select

Installation and Usage

// npm install react-async-select or yarn add react-async-select

import AsyncSelect from 'react-async-select'

const style = {
  containerStyle: (props: StyleObject): StyleObject => ({
    ...props,
    width: "20rem",
    height: "2.5rem",
  }),
  inputStyle: (props: StyleObject): StyleObject => ({
    ...props,
    color: "red",
  }),
  listContainerStyle: (props: StyleObject): StyleObject => ({
    ...props,
    top: "2.7rem",
    "border-radius": "5px",
  }),
  listItemStyle: (props: StyleObject): StyleObject => ({
    ...props,
  }),
  listItemSelectStyle: (props: StyleObject): StyleObject => ({
    ...props,
    "background-color": "green",
  }),
};

<Async
  inputValue={inputValue}
  displayedValue={selectedItem}
  handleChangeInput={handleChangeInput}
  handleSelectItem={handleSelectItem}
  debouncedList={debouncedList}
  message="Empty"
  style={style}
/>

Props

  • inputValue - displayed input value;
  • displayedValue - displayed select value
  • handleChangeInput - input change function : (value: string) => void
  • handleSelectItem - list item select function : (data: ListItem) => void
  • debouncedList - list item array
    • name - displayed value
    • value - custom value to select
  • message - list item message before response optional
  • style - custom style optional
    • containerStyle - selectbox style (props: StyleObject) => StyleObject optional
    • inputStyle - input style (props: StyleObject) => StyleObject; optional
    • listContainerStyle - list box style (props: StyleObject) => StyleObject; optional
    • listItemStyle - list item style (props: StyleObject) => StyleObject; optional
    • listItemSelectColor - keyboard select & hover item style (props: StyleObject) => StyleObject; optional

Project

git clone https://github.com/raccoon91/react-async-select.git

Add your code in src/components/AsyncSelect


yarn start

Runs the example in the development mode.
Open http://localhost:3000 to view it in the browser.

yarn build

Builds the AsyncSelect component to the build folder.
It bundles React NPM package using rollup.config.js.

react-async-select's People

Contributors

raccoon91 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.