Code Monkey home page Code Monkey logo

semantic-autocomplete's Introduction

semantic-autocomplete

semantic-autocomplete is a React component that extends v5 MUI's autocomplete and performs semantic similarity search using a small, quantized machine learning (ML) model which runs on client side. The model is downloaded once and then taken from browser's cache. The full functionality is provided within this React component!

Demo

Sort paragraphs of a webpage by meaning:

https://mihaiii.github.io/semantic-autocomplete/

How to install

Install:

npm install --save semantic-autocomplete

Then import:

import SemanticAutocomplete from "semantic-autocomplete";

Usage

Since semantic-autocomplete extends MUI's autocomplete, the entire v5 MUI's autocomplete API will also work on semantic-autocomplete. The only exception is the filterOptions property.

If you're already using autocomplete in your project, just replace the tag name and you're done. ๐Ÿ™Œ

You can see the component being used in code here and here.

See this page for how you can use MUI's autocomplete and therefore semantic-autocomplete too.

Besides the MUI's autocomplete API, the following props are provided:

Thanks / credit

semantic-autocomplete's People

Contributors

mihaiii avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

semantic-autocomplete's Issues

Typescript support

The component does not support ts. Are there plans to provide a declaration file or switch to tsx?

Use custom renderInput

The component does not use the provided renderInput component and overwrites it with its own renderLoadingInput function. This causes layout shifts, if the mui Autocomplete size is set to small but the CircularProgress uses its default size.

renderInput={(params) => (
    <TextField
        {...params}
        InputProps={{
            ...params.InputProps,
            endAdornment: (
                <Fragment>
                    {loading ? <CircularProgress color="inherit" size={20} /> : null}
                    {params.InputProps.endAdornment}
                </Fragment>
            ),
        }}
    />
)}
size='small'

Is the built in renderLoadingInput function even necessary?

Define properties to search through

Currently, i use a custom filterOptions function for my Autocomplete component, in which i provide the names of the keys to define the properties to search. Some properties are necessary for the onChange event and renderOption function but should not be used for search.
Is a similar behaviour achievable?

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.