npmpackage.info

Gathering detailed insights and metrics for use-item-list

Other packages similar to use-item-list

@csstools/postcss-normalize-display-values

4.0.0

Use two values display syntax for inner and outer display types.

@yozora/tokenizer-list-item

2.0.0-alpha.0

react-native-item-list

1.0.8

The React Native ListItem package is a versatile, easy-to-use solution for creating interactive item lists in your React Native applications. Designed to simplify the process of creating and displaying item lists, this package offers maximum flexibility w

5app-use-item-list

0.1.1

Manage indexed collections in React using hooks.

Gathering detailed insights and metrics for use-item-list

use-item-list - 0.1.2 | npmpackage.info

use-item-list

A primitive React hook used to coordinate indexed collections effortlessly.

0.1.2

JavaScript

104.47 kB

1.3

Installations

npm install use-item-list

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Pull Requests

Open

17

Total

38

Closed

17

Merged

4

Issues

Open

3

Total

8

Closed

5

Releases

Unable to fetch releases

Languages

JavaScript

TypeScript

CSS

Shell

JavaScript (66.25%)

TypeScript (30.99%)

CSS (2.69%)

Shell (0.06%)

Developer

souporserious

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

74 Stars

21 Commits

5 Forks

4 Watchers

18 Branches

2 Contributors

Updated on Mar 07, 2024

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

0.1.2

Package Id

use-item-list@0.1.2

Unpacked Size

104.47 kB

Size

23.59 kB

File Count

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

🕹 useItemList

A primitive React hook used to coordinate indexed collections effortlessly.

Why?

The ergonmics of managing indexes in React is lacking. When building lower level components for accessibility purposes, managing indexes can become painful and expose internals of an API that consumers shouldn't necessarily need to know about.

This library aims to solve managing indexed collections of items as easily as possible while letting users still compose, optimize, and use React like they are used to.

API

1import React, { useRef } from 'react'
2import { useItemList } from 'use-item-list'
3
4function Item({ useItem, children }) {
5  const ref = useRef()
6  const { id, index, highlight, select, selected, useHighlighted } = useItem({
7    ref, // required ref used to scroll item into view when highlighted
8    value: children, // value passed back in useItemList onSelect
9    disabled: false, // prevents item from being highlighted/selected
10    text: null, // used for highlightItemByString function
11  })
12  return (
13    <li ref={ref} id={id}>
14      {children}
15    </li>
16  )
17}
18
19function List({ value, onChange }) {
20  const {
21    controllerId,
22    listId,
23    getHighlightedIndex,
24    getHighlightedItem,
25    setHighlightedItem,
26    moveHighlightedItem,
27    clearHighlightedItem,
28    selectHighlightedItem,
29    useHighlightedItemId,
30    highlightItemByString,
31    useItem,
32  } = useItemList({
33    selected: value, // the current selected value
34    onSelect: onChange, // callback when item has been selected
35  })
36  return (
37    <ul>
38      <Item useItem={useItem}>Item 1</Item>
39      <Item useItem={useItem}>Item 2</Item>
40      <Item useItem={useItem}>Item 3</Item>
41    </ul>
42  )
43}

Usage

In a somewhat trivial example, we can see how to build a custom select menu:

1import React, { createContext, useContext, useRef } from 'react'
2import { useItemList } from 'use-item-list'
3
4const SelectContext = createContext()
5
6export function Select({ children, value, onChange }) {
7  const itemList = useItemList({
8    selected: value,
9    onSelect: onChange,
10  })
11  const itemId = itemList.useHighlightedItemId()
12  return (
13    <SelectContext.Provider value={itemList}>
14      <ul
15        id={itemList.listId}
16        tabIndex={0}
17        role="listbox"
18        aria-activedescendant={itemId}
19        style={{ padding: 0 }}
20        onKeyDown={(event) => {
21          if (event.key === 'ArrowUp') {
22            event.preventDefault()
23            itemList.moveHighlightedItem(-1)
24          }
25          if (event.key === 'ArrowDown') {
26            event.preventDefault()
27            itemList.moveHighlightedItem(1)
28          }
29          if (event.key === ' ' || event.key === 'Enter') {
30            event.preventDefault()
31            itemList.selectHighlightedItem()
32          }
33          itemList.highlightItemByString(event)
34        }}
35      >
36        {children}
37      </ul>
38    </SelectContext.Provider>
39  )
40}
41
42export function Option({ children, text, value }) {
43  const { useItem, clearHighlightedItem } = useContext(SelectContext)
44  const ref = useRef()
45  const { id, highlight, select, selected, useHighlighted } = useItem({
46    ref,
47    text,
48    value,
49  })
50  const highlighted = useHighlighted()
51  return (
52    <li
53      ref={ref}
54      id={id}
55      role="option"
56      aria-selected={selected}
57      onMouseOver={highlight}
58      onMouseOut={clearHighlightedItem}
59      onMouseDown={select}
60    >
61      {children} {selected && '✅'}
62    </li>
63  )
64}

Now users of our component have an easy-to-use API that resembles the ergonomics of the web's select element:

1<Select>
2  <Option value="apple">Apple 🍎</Option>
3  <Option value="banana">Banana 🍌</Option>
4  <Option value="pear">Pear 🍐</Option>
5</Select>

Please note this is not a fully accessible example. See the examples directory for more full-fledged examples.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

102 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h
Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4
Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-25mp-g6fv-mqxx
Warn: Project is vulnerable to: GHSA-wr66-vrwm-5g5x
Warn: Project is vulnerable to: GHSA-fmvm-x8mv-47mj
Warn: Project is vulnerable to: GHSA-f82v-jwr5-mffw
Warn: Project is vulnerable to: GHSA-c59h-r6p8-q9wc
Warn: Project is vulnerable to: GHSA-g77x-44xx-532m
Warn: Project is vulnerable to: GHSA-7gfc-8cq8-jh5f
Warn: Project is vulnerable to: GHSA-qpjv-v59x-3qc4
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h

Score

1.3

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to use-item-list

Other packages similar to use-item-list

use-item-list

Installations

Developer Guide

No

CommonJS

Pull Requests

17

38

17

4

Issues

3

8

5

Releases

Unable to fetch releases

Languages

Developer

souporserious

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

🕹 useItemList

Why?

API

Usage

10

0

0

0

0

0

0

0

0

0

1.3

/10