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

@rmwc/list

v14.3.5

Published

RMWC List component

Downloads

27,323

Readme

Lists

Lists are continuous, vertical indexes of text or images.

  • Module @rmwc/list
  • Import styles:
    • Using CSS Loader
      • import '@rmwc/list/styles';
    • Or include stylesheets
      • '@material/list/dist/mdc.list.css'
      • '@material/ripple/dist/mdc.ripple.css'
      • '@rmwc/icon/icon.css'
  • MDC Docs: https://material.io/develop/web/components/lists/

Basic Usage

<List>
  <ListItem>Cookies</ListItem>
  <ListItem>Pizza</ListItem>
  <ListItem>Icecream</ListItem>
</List>
<List twoLine>
  <ListItem>
    <ListItemGraphic icon="star_border" />
    <ListItemText>
      <ListItemPrimaryText>Cookies</ListItemPrimaryText>
      <ListItemSecondaryText>$4.99 a dozen</ListItemSecondaryText>
    </ListItemText>
    <ListItemMeta icon="info" />
  </ListItem>
  <ListItem>
    <ListItemGraphic icon="local_pizza" />
    <ListItemText>
      <ListItemPrimaryText>Pizza</ListItemPrimaryText>
      <ListItemSecondaryText>$1.99 a slice</ListItemSecondaryText>
    </ListItemText>
    <ListItemMeta icon="info" />
  </ListItem>
  <ListItem activated>
    <ListItemGraphic icon="mood" />
    <ListItemText>
      <ListItemPrimaryText>Icecream</ListItemPrimaryText>
      <ListItemSecondaryText>$0.99 a scoop</ListItemSecondaryText>
    </ListItemText>
    <ListItemMeta>Winner!</ListItemMeta>
  </ListItem>
</List>

Simplified Usage

While there are siutations where you would need / want to compose the entire list yourself, it can be quite verbose. SimpleListItem provides a compact syntax that allows you to pass all options as props. The following example is roughly equivalent to the one above.

<List twoLine>
  <SimpleListItem
    graphic="star_border"
    text="Cookies"
    secondaryText="Chocolate chip"
    metaIcon="info"
  />
  <SimpleListItem
    graphic="local_pizza"
    text="Pizza"
    secondaryText="Pepperoni"
    metaIcon="info"
  />
  <SimpleListItem
    activated
    graphic="mood"
    text="Icecream"
    secondaryText="Chocolate cookie dough"
    meta="Winner!"
  />
</List>

List

A List Component

Props

| Name | Type | Description | |------|------|-------------| | apiRef | (api: null \| ListApi) => void | An internal api used for cross component communication | | avatarList | boolean | Makes the list start detail circular for avatars. | | children | ReactNode | Children to render | | dense | boolean | Reduces the padding on List items. | | foundationRef | Ref<null \| MDCListFoundation<>> | Advanced: A reference to the MDCFoundation. | | nonInteractive | boolean | Makes the list non interactive. In addition, you'll have to set ripple={false} on the individual ListItems. | | onAction | (evt: ListOnActionEventT) => void | A callback for when a list item is interacted with. evt.detail = number | | selectedIndex | number \| number[] | Sets the selectedIndex for singleSelection, radiogroup, or checkboxlist variants. Only supply number[] to checkboxlists | | twoLine | boolean | Gives more space for dual lined list items. | | vertical | boolean | Sets the lists vertical orientation. Defaults to true | | wrapFocus | boolean | Sets the list to allow the up arrow on the first element to focus the last element of the list and vice versa. Defaults to true |

ListItem

A ListItem component.

Props

| Name | Type | Description | |------|------|-------------| | activated | boolean | A modifier for an active state. | | disabled | boolean | A modifier for a disabled state. | | ripple | RipplePropT | Adds a ripple effect to the component | | selected | boolean | A modifier for a selected state. |

ListItemPrimaryText

Primary Text for the ListItem

ListItemSecondaryText

Secondary text for the ListItem

ListItemGraphic

A graphic / icon for the ListItem

Props

| Name | Type | Description | |------|------|-------------| | icon | IconPropT | The icon to use. This can be a string for a font icon, a url, or whatever the selected strategy needs. |

ListItemMeta

Meta content for the ListItem. This can either by an icon by setting the icon prop, or any other kind of content.

Props

| Name | Type | Description | |------|------|-------------| | icon | IconPropT | The icon to use. This can be a string for a font icon, a url, or whatever the selected strategy needs. |

ListDivider

A divider for the List

ListGroup

A container to group ListItems

ListGroupSubheader

A subheader for the ListGroup

SimpleListItem

A simple list item template.

Props

| Name | Type | Description | |------|------|-------------| | activated | boolean | A modifier for an active state. | | children | ReactNode | Children to render | | disabled | boolean | A modifier for a disabled state. | | graphic | IconPropT | A graphic icon for the ListItem. | | meta | ReactNode | Meta content for the ListItem instead of an icon. | | metaIcon | IconPropT | A meta icon for the ListItem | | ripple | RipplePropT | Adds a ripple effect to the component | | secondaryText | ReactNode | Secondary Text for the ListItem. | | selected | boolean | A modifier for a selected state. | | text | ReactNode | Text for the ListItem. |