Code Monkey home page Code Monkey logo

suggestkit-react's Introduction

suggestkit-react

An implementation of SuggestKit in React.

How to use

To use this, you will firstly want to import the library from suggestkit-react:

import SuggestKit from "suggestkit-react";

From here, we can structure our components for usage in SuggestKit. To do this, we will map each item in our array so that key is the key which we want to trigger suggestions and info is the component we want to render. In our example, we do it like this:

const suggestionsFormatted = suggestions.map(x => {
    return {
        key: x.key,
        info: <Suggestion title={x.title} description={x.description} />,
    };
});

We may also want to call a function when the text updates. In the case of functional components, we will use React's useState function to get the state, and then pass through setText to onChange in this component since it returns a string:

let [text, setText] = useState(0);

From here, we can very easily create the component:

<SuggestKit suggestions={suggestionsFormatted} placeholder="Type here to get suggestions!" onUpdate={setText} />

Demo

There is a demo included (see demo.js) which contains a simple typearea and the keys hello and sammy. To use the demo, sinply run npm i and then npm run demo.

suggestkit-react's People

Contributors

dependabot[bot] avatar iamjsd avatar mattipv4 avatar

Stargazers

 avatar  avatar  avatar

Watchers

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