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

reactrix-sidebar

v0.0.4

Published

Flexible React Sidebar Component

Downloads

15

Readme

React Sidebar

Flexible React Sidebar Component

NPM JavaScript Style Guide Travis

Install

npm install --save reactrix-sidebar
yarn add reactrix-sidebar

Usage

  • Import the module along with the base styles
  • Pass desired props to component using spread operator
import React, { Component } from 'react'
import ReactSidebar from 'reactrix-sidebar'
import 'reactrix-sidebar/index.css'

class ReactSidebar extends Component {
  render () {
    const options = {
      side: "left",
      effect: "slide-out",
      speed: 250,
      timing: 'ease-in-out'
    }
    return (
      <Sidebar {...options}>
        <div>Menu Goes Here</div>
        <div>Page Goes Here</div>
      </Sidebar>
    )
  }
}

Gotcha

⚠️ The component uses FontAwesome icons by default. If you're not passing in custom icons, make sure to include the link below in the head tag of your index.html file.

<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.12/css/all.css" integrity="sha384-G0fIWCsCzJIMAVNQPfjH08cyYaUtMwjJwqiRKxxE/rx96Uroj1BtIQ6MLJuheaO9" crossorigin="anonymous">

Features

  • Only two peer depencies (react/prop-types)
  • Large selection of smooth transitions
  • Easy to use BEM class hooks

Examples

  • Demo - https://alexcasche.github.io/reactrix-sidebar/
  • Sandbox - https://codesandbox.io/s/jlzno327x9

Props

| Prop | Type | Default | Description: Options | |-------------------|-------------|-------------|-------------| | side | string | left | Menu location: left right | | effect | string | slide | Transition effect: slide push fall reveal diverge uncover shrink grow press | | speed | number | 500 | Transition speed (milliseconds) | | timing | string | ease | Transition timing function: | | overlay | boolean | true | Display overlay: true false | | buttons | array | null | Custom icons: [ component, component ]|

Custom Icons

Set the icons prop equal to an array consisting of two components.

function openButton {
  return <i className="fas fa-times" />
}
function closeButton {
  return <i className="fas fa-bars" />
}
...
  const options = {
    icons: [ openButton, closeButton ]
  }
...
  <Sidebar {...options} />
...

Classes

| Class | Description | |------------------------|--------------------| | .sidebar | Outer component wrapper | | .sidebar--open | Outer component open | | .sidebar__cotainer | Inner component wrapper | | .sidebar__menu | Outer menu wrapper | | .sidebar__nav | Inner menu wrapper | | .sidebar__page | Page content wrapper | | .sidebar__overlay | Page overlay | | .sidebar__btn-open | Open menu button | | .sidebar__btn-close | Close menu button |

Development

Follow these steps to setup a local development environment. Use yarn or npm - not both.

  1. Clone the repo from Github
git clone https://github.com/alexcasche/react-sidebar
  1. Setup project & start rollup watch
npm install && npm start
yarn install && yarn add
  1. Setup react app & start dev server
cd example
npm install && npm start
yarn install && yarn start

Shoutout

Big thanks to Travis Fischer for the awesome create-react-library 🙌

License

MIT © alexcasche