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

@wedgekit/checkbox-list

v4.1.4

Published

## Purpose

Downloads

18

Readme

CheckboxList

Purpose

The CheckboxList is a reuseable, aria-compliant list of checkboxes. Wedgekit uses CheckboxList in the SwitchGroup from '@wedgekit/switch-group' and the Multiselect from '@wedgekit/select'.

Basic Implementation

import CheckboxList, { Option } from '@wedgekit/checkbox-list';

const Example = () => {
  const [value, setValue] = React.useState([]);

  return (
    <CheckboxList
      label="My CheckboxList"
      options={[
        { label: 'Option 1', id: 'Option1' },
        { label: 'Option 2', id: 'Option2' },
        { label: 'Option 3', id: 'Option3' },
      ]}
      value={value}
      onChange={setValue}
    />
  );
};

render(<Example />);

Props

allowMultiple

Type: boolean

Required: ❌

Allows more than one option to be selected, defaults to true

className

Type: string

Required: ❌

This is exposed but is only here so that styled-components will be able to style components correctly. Please do not use this unless you really know what you are doing.

options

Type:

{
  id: string | number,;
  label: string;
  disabled?: boolean;
}[]

Required: ✅

disabled

Type: boolean

Required: ❌

filter

Type: string

Required: ❌

CheckboxList can be provided a filter to control which options are shown to the user. Options will be filtered based on their label prop. Filtered options are not visible, but will remain selected as part of CheckboxList's value if it was selected before being filtered.

ref

Type: React.Ref

Required: ❌

The forwarded ref giving a user access to the underlying HTML input.

label

Type: string

Required: ✅

Aria compliant text for all child components to be 'labeled-by', required on all wedgekit components.

tabIndex

Type: number

Required: ❌

Sets the tabIndex for the listbox element. Default: tabIndex={0}

value

Type: (string | number)[]

Required: ✅

An array of Option ids used signify which Options should display as 'checked'.

onBlur

Type: (event:React.FocusEvent) => void

Required: ❌

onChange

Type: (value:(string | number)[], event: React.ChangeEvent<HTMLInputElement) => void

Required: ✅

Function that will fire when a checkbox value is changed.

onKeyDown

Type: (event: SyntheticEvent<*>) => void

Required: ❌

An optional callback when a key is pressed