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

@s-ui/react-form-autocompleted

v1.22.0

Published

sui-form-autocompleted

Downloads

28

Readme

Form Autocompleted

React component that shows a form which contains:

  • an input
  • a list of suggestions
  • an optional button

Component Properties

The component exposes the following props:

  • placeholder (String): Optional Default text value for the input file when no key is pressed (placeholder value).

  • suggests (Array): Required Array of SuggestionObjects. Te array contains the suggestions to show. If you don't want to show anything you have to send an empty array.

  • handleChange (Function): Required This function is called everytime user change the input field value.

    	const handleChange = function( inputFileValue ){ ... }
  • handleSelect (Function): Required This function is called when one suggestion is selected (via click or enter pressed).

    	const handleSelect = function( suggestionValue ){ ... }
  • handleSubmit (Function): Optional This function is called everytime user click the submit button.

  • handleBlur (Function): This function is called everytime user exits the input.

  • handleFocus (Function): This function is called everytime user focus on the input.

  • selectFirstByDefault (Boolean): Optional It sets first position for the autocomplete default active option. Defaults to true.

  • closeOnOutsideClick (Boolean): Optional Enables close suggestions on click outside. Elements in the array excludeFromOutsideClick (input, submit, suggestList) will not close the suggest list.

  • focus (Boolean): Optional It trigger focus in the input. Defaults to false.

  • submit (object): Optional contains an optional icon and an optional text for the submit button

An example of the sui-form-autocompleted component implementation is:

// JSX file.

const EMPTY_SUGGESTS = []


const fakedSuggests = [
  {
    'login': 'A',
    'id': 1410106
  },
  {
    'login': 'aarizaq',
    'id': 45491
  }
]

class MyFormAutocompleted extends React.Component {
  constructor () {
    super()
    this.state = {suggests: EMPTY_SUGGESTS}
  }

  _handleChange (string) {
    // actions to do on input change
  }

  _handleSelect (suggest) {
    // actions to do on select item
  }

  _handleSubmit (content) {
    // actions to do on submit button
  }

  render () {
    return (
      <FormAutocompleted
        placeholder='Form autocompleted'
        handleChange={this._handleChange}
        handleSelect={this._handleSelect}
        handleSubmit={this._handleSubmit}
        suggests={this.state.suggests}
        submit={{ text: 'Submit' }}
        collapsed
				closeOnOutsideClick
        />
    )
  }
}

return (<MyFormAutocompleted />)

SuggestObject

An SuggestObject is a plain JS Object with these specials keys:

{
    'id': [Unique id for the suggestion],
    'value': [value to be passed to the handleSelect callback function]
    'content': [React Component] or [Text to be show in the UI]
    'literal': [String] This key is REQUIRED only if you are using a ReactJS Component like a content. It is used to decide which text has to be put in the input text when this suggestion is selected, in other case content will be used,
}

Theme

There are several classes in order to apply a theme to the component:

  • sui-formAutocompleted
  • sui-formAutocompleted-input
  • sui-formAutocompleted-clear
  • sui-formAutocompleted-suggests
  • sui-formAutocompleted-suggestsItem ...

The component exports a basic CSS that you can include from the package in the node_modules.

Bundle

In order to generate the bundle including all React dependencies and the component logic we need to bundle a single JS file running the following command:

$ npm run build