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

@squiz/xaccel-assisted-input

v1.15.1

Published

## Description

Downloads

736

Readme

Assisted Input

Description

The AssistedInput component enhances user input by providing suggestions or results based on what the user types. It's meant to be flexible and integrate with various types of content that might need autocomplete functionality, such as search bars or data entry fields.

The component consists of a few subcomponents, including a results container and a label, which allows for complex interaction and presentation of data.

Components properties

| Property Name | Property Description | Property Type | IsRequired | | --------------------------- | ------------------------------------------------------------------ | ----------------- | ---------- | | name | Unique identifier for the input, used in form submissions. | string | [x] | | showClear | Determines if a clear button should be displayed. | bool | | | clearIcon | Custom icon to be used for the clear button. | node | | | preloadValueFromNameParam | Preloads the input with a value from URL parameters, if available. | bool | | | className | Overwrite ClassName | classNameOverride | | | autofocus | Automatically focus the input upon component mount. | bool | | | onChangeValue | Callback function called with the current input value. | func | |

For more information about className please visit packages/utility/functions/src/generateClasses.js

Subcomponents and Context

  1. AssistedInputContainer - wraps the AssistedInput and other related components, managing their shared state and interactions. It provides a context for communication between the input field and the results list, handling focus, input changes, and keyboard navigation.

  2. AssistedInputContext - enables the sharing of state and interactions among AssistedInput and its subcomponents. It contains: input value, active descendant, and fetching state.

  3. AssistedInputLabel - optional label component for the AssistedInput, indicating the purpose of the input field.

  4. AssistedInputResultsContainer - a container for the results or suggestions displayed as the user types. It listens to the context for changes in the input field.

Conditional component presentation

The appearance and behavior of the AssistedInput component can be customized through props - for example, setting showClear to true adds a clear button, allowing users to clear their input.

The preloadValueFromNameParam can automatically fill the input based on URL parameters, preloading expected values.

Props Example:

<AssistedInput
  name="search"
  showClear={true}
  clearIcon={<ClearIcon />}
  preloadValueFromNameParam={true}
  className="customClass"
  autofocus={true}
  onChangeValue={(value) => console.log(value)}
/>

Usage

Install the package by running: npm i @squiz/xaccel-assisted-input

import { AssistedInputContainer, AssistedInput, AssistedInputResultsContainer, AssistedInputLabel } from '@squiz/xaccel-assisted-input';

function SomeReactComponent({ id }) {
    return (
        <form>
            <AssistedInputContainer id={id} onSubmit={() => console.log('Submit')}>
                <AssistedInputLabel>Search</AssistedInputLabel>
                <AssistedInput showClear />
                <AssistedInputResultsContainer>
                    Enter something to see results
                </AssistedInputResultsContainer>
            </AssistedInputContainer>
        </form>
    );
}

export default SomeReactComponent;