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

@arcia125/custom-dropdown

v0.5.2

Published

Custom dropdown Web Component

Downloads

741

Readme

Built With Stencil NPM Version

@arcia125/custom-dropdown

Custom Dropdown Example

Single-Select Dropdown Component with Keyboard Navigation

Live Demo

This project is a Stencil.js implementation of a single-select dropdown component with keyboard navigation and optional filtering.

Features:

  • Custom Dropdown Component: Renders custom-option elements passed via a default slot.
  • Keyboard Navigation: Navigate using the "Arrow Up" and "Arrow Down" keys, select with "Enter". Navigation wraps at the start and end of the list.
  • Single Selection: Allows one option to be selected and highlighted.
  • Optional Filtering: Includes a debounced input for filtering options.
  • CSS Customization: Component appearance can be customized using CSS variables.
  • Accessibility: Includes the proper ARIA roles and properties for accessibility.

Installation

npm i @arcia125/custom-dropdown

Usage

The component can be with frameworks or in vanilla HTML.

React

import '@arcia/custom-dropdown';

function App() {
  return (
    <div>
      <custom-dropdown
        label="Color Options"
        onChangeDropdown={(event) => console.log(event.detail)}
      >
        <custom-option value="white">White</custom-option>
        <custom-option value="white-titanium">White Titanium</custom-option>
        <custom-option value="black">Black</custom-option>
        <custom-option value="black-titanium">Black Titanium</custom-option>
        <custom-option value="teal">Teal</custom-option>
        <custom-option value="pink">Pink</custom-option>
      </custom-dropdown>
    </div>
  );
}

export default App;

HTML

<html>
  <head>
    <script src="https://cdn.jsdelivr.net/npm/@arcia125/[email protected]/dist/index.js"></script>
  </head>
  <custom-dropdown label="Color Options">
    <custom-option value="white">White</custom-option>
    <custom-option value="white-titanium">White Titanium</custom-option>
    <custom-option value="black">Black</custom-option>
    <custom-option value="black-titanium">Black Titanium</custom-option>
    <custom-option value="teal">Teal</custom-option>
    <custom-option value="pink">Pink</custom-option>
  </custom-dropdown>
  <script>
    const customDropdown = document.querySelector('custom-dropdown');
    customDropdown.addEventListener('changeDropdown', console.log);
  </script>
</html>

Known Issues

Flash of Unstyled Content (FOUC): Can be fixed by adding a style block in the HTML file to ensure styles load correctly before content is displayed.

<style>
  :not(:defined) {
    visibility: hidden;
  }

</style>

Customization and enabling Dark/Light mode

Add these styles to your application to enable Dark mode.

<style>
  @media (prefers-color-scheme: dark) {
    :root {
      --custom-dropdown-background-color: #2C2C2E;
      --custom-option-background-color-hover: #3A3A3C;
      --custom-option-background-color-focus: #48484A;
      --custom-dropdown-font-color: #F5F5F7;
    }
    body {
      background-color: #1C1C1E;
    }
  }
</style>

Local Development

running the demo:

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm run test

To deploy the demo to github pages run the build and commit, then run:

npm run deploy-demo

To deploy to npm run the build and commit, then run:

npm publish