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

material-expansion-panel

v1.0.0

Published

A customizable Expansion Panel component for React, which follows Material Design specifications

Downloads

899

Readme

Expansion Panel

This is a standalone React component implementing the Expansion Panels, following Google Material Design guidelines. This component is highly customizable and uses material icons and buttons provided by MDL.

Demo & Examples

Live demo: rijulaggarwal16.github.io/material-expansion-panel

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use material-expansion-panel is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/material-expansion-panel.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install material-expansion-panel --save

You will also need the css included in the package.

<link rel="stylesheet" type="text/css" href="node_modules/material-expansion-panel/dist/material-expansion-panel.min.css">

Apart from these standard functional files, you will also need MDL library in your project. This library is very light weight and has some amazing material design components pre-built (about 27kb gzipped). All you need is a JS file, a stylesheet and its icons. You can choose any color palett you want. https://getmdl.io/started/index.html

<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.indigo-pink.min.css">
<script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>

Usage

var ExpansionPanel = require('material-expansion-panel');

var aIcons = [{
			icon: "delete",
			callback: null,
			additionalParams: null
		}];
var aButtons = [{
	buttonText: "Save",
	callback: null,
	additionalParams: null
},
{
	buttonText: "Cancel",
	callback: null,
	additionalParams: null,
	toggleExpand: true
}];

<ExpansionPanel title="Title" expandedTitle="Expanded Title" titleIcon="done_all" actionButtons={aButtons} actionIcons={aIcons} ><div>Example Content</div></ExpansionPanel>

Properties

|Property Name|Required?|Use| |---|:---:|---| |title|Optional|The title shown when the panel is collapsed | |expandedTitle|Optional|The title shown when the panel is expanded| |titleIcon|Optional|The material icon shown next to the title/expanded title| |actionIcons|Optional|Array of objects defining the use of action icons| |actionButtons|Optional|Array of objects defining the use of action buttons at the bottom of the expanded panel|

actionIcons object definition:

|Property Name|Required?|Use| |---|:---:|---| |icon|Required|Material icon for the action button| |callback|Optional|The callback when the action icon is clicked| |additionalParams|Optional|Anything (object,array etc.) passed back into the callback|

actionButtons object definition:

|Property Name|Required?|Use| |---|:---:|---| |buttonText|Required|Text inside the action button| |callback|Optional|The callback when the action icon is clicked| |additionalParams|Optional|Anything (object,array etc.) passed back into the callback| |toggleExpand|Optional|true/false defining whether panel should collapse onClick (default false)|

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

MIT License

Copyright (c) 2017 Rijul Aggarwal.