KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

react-sidebar-ui

★ 62 Open GitHub ↗

⚛️ The Sidebar Component for React.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# react-sidebar-ui

> ⚛️ Sidebar component for React projects with customizable design

[![NPM](https://img.shields.io/npm/v/react-sidebar-ui.svg)](https://www.npmjs.com/package/react-sidebar-ui)
[![NPM Downloads](https://img.shields.io/npm/dt/react-sidebar-ui.svg)](https://www.npmjs.com/package/react-sidebar-ui)
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/svetloslav)
<br/>
![React Sidebar UI Black](https://i.imgur.com/4dXhYpU.gif)
![React Sidebar UI Light](https://i.imgur.com/ZzmB4pY.gif)
![React Sidebar UI Light](https://imgur.com/hDpzihz.gif)
## Install
```bash
npm install react-sidebar-ui
or
yarn add react-sidebar-ui
```
## Usage
1. Import `https://unpkg.com/react-sidebar-ui@1.2.0/dist/index.css` into your index.html file
2. In order to use icons, you should import Font-Awesome
3. Start using the component

```jsx
import React from 'react'
import {Sidebar, InputItem, DropdownItem, Icon, Item, Logo, LogoText} from 'react-sidebar-ui'

const App = () => {
  return (
    <div>
      <Sidebar bgColor='black' isCollapsed={false}>
        <Logo
          image='https://media2.giphy.com/media/eNAsjO55tPbgaor7ma/source.gif'
          imageName='react logo'/>
        <LogoText>React Sidebar UI</LogoText>
        <DropdownItem
          values={['First', 'Second', 'Third']}
          bgColor={'black'}>
          Menu
        </DropdownItem>

<Item bgColor='black'>
          <Icon><i className="fas fa-home"/></Icon>
          Home
        </Item>
        <Item bgColor='black'>
          <Icon><i className="fas fa-info"/></Icon>
          About
        </Item>
        <Item bgColor='black'>
          <Icon><i className="fas fa-sitemap"/></Icon>
          My Website
        </Item>
        <Item bgColor='black'>
          <Icon><i className="far fa-address-book"/></Icon>
          Contacts
        </Item>
        <Item bgColor='black'>
          <Icon><i className="fas fa-rss-square"/></Icon>
          Blog
        </Item>
        <InputItem type='text' placeholder={'Search...'}/>
      </Sidebar>
    </div>
  )
};
```
## Props

Common props you may want to specify include:
### Sidebar
- `bgColor` - change the color of the sidebar, it can be `black`, `light`, `blue`, `purple`, `aqua`, `peach`
- `isCollapsed` - add start position of the sidebar if it will be collapsed or not
- `classes` - add your custom classes if you want to add custom style to the component
- `position` - add where the sidebar will be positioned on the screen, it can be `left` and `right`. If you don't specify it will be `left`.
### DropdownItem
- `bgColor` - change the color of the sidebar it can be `black`, `light`, `blue`, `purple`, `aqua`, `peach`
- `values` - items that will be displayed
- `classes` - add your custom classes if you want to add custom style to the component
### Item
- `bgColor` - change the color of the sidebar it can be `black`, `light`, `blue`, `purple`, `aqua`, `peach`
- `classes` - add your custom classes if you want to add custom style to the component
### Logo
- `image` - url to the image
- `imageText` - alt tag of the image
- `classes` - add your custom classes if you want to add custom style to the component
### InputItem
- `type` - type of the input field
- `placeholder` - placeholder of the input field
- `classes` - add your custom classes if you want to add custom style to the component
### Icon
- `classes` - you should add font-awesome class here add your custom classes if you want to add custom style to the component

## Customization
If you want to change the style of a component, you can do it by adding your own classes to the component.
## Contribute 
Contributions are always welcome!
Please read the [contribution guidelines](contributing.md) first.

### ⭐ If you liked the component, please consider giving me a star. Thank you!
## License

react-sidebar-ui

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README