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

mui-checkboxlist

v1.2.0

Published

A Material UI based react component for checkbox list.

Downloads

31

Readme

mui-checkboxlist

This package is a checkbox list component based on Material-UI. This is designed for use with react and react-final-form.

  • It accepts an array of items to be listed for selection
  • Produces an array of selected items
  • Customizable in terms of style and function

Check out this Live Demo.

Usage

Your application must have the following packages installed, these are declared as peer dependencies and won't we installed automatically by installing this component:

  • @material-ui/core
  • @material-ui/icons
  • lodash

Install the actual package:

$ npm install mui-checkboxlist

Then you just need to import it into your React application:

import { CheckboxLabelValueSelect, CheckboxValueSelect } from "mui-checkboxlist";

//Use **CheckboxLabelValueSelect** when passing items with the following structure:
const listItems_labelValue = [{
    label: "White"
    value: "#FFFFFF"
}];

//Use **CheckboxValueSelect** when passing plain strings:
const listItems_valueOnly = [ "white", ... ];

Props & Features

| Props | Mandatory | Default | Description | | ------ | ------ | ------ | ------ | | checkedIcon | no | | Icon to show when the checkbox controls are checked. | | disabled | no | false | If set to true, checkboxes and textfields are disabled. | | label | no | | Displays a label to describe the whole list. | limit | no | | If present, it should container a number called 'max' which limits the selected items to the specified number and 'deleteLast' which when set to true, will uncheck the last checked item instead of the first. | | icon | no | | Icon to show when the checkbox controls are not checked. | | listItems | yes | | Contains all the items available for selection. | | onChange | yes | | This function will provide the updated selected values. Basic structure is (selectedItems) => {}, where selectedItems is an array. | | searchBarLabel | no | | If provided, search bar will be displayed and its value will be the placeholder. | | selectAllLabel | no | | If provided, a select/deselect-all checkbox labeled with the provided value will be displayed. Event if present but field 'limit' is also present, the selectAll checkbox will not display. | | selectedItems | no | [] | Contains the initially selected items. | | selectedItemsFirst | no | false | If set to true, selected items will be displayed on top of the list. Perfect for long lists. | | statusBar | no | false | If provided, a status bar with the number of selected items will be displayed. |

Styling

If you want to override the styles, you can use withStyles:

import CheckboxValueSelect from './CheckboxValueSelect';
import {withStyles} from '@material-ui/styles';

const styles = {
  root: {
    textAlign: 'center'
  }
}

const StyledCheckboxValueSelect = withStyles(styles)(CheckboxValueSelect);

License

MIT