Skip to content

Commit

Permalink
update screen shot & add new scss variables
Browse files Browse the repository at this point in the history
  • Loading branch information
azouaoui-med committed Jun 5, 2020
1 parent 912d534 commit d3650d4
Showing 1 changed file with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Customizable and responsive react sidebar library with dropdown menus and unlimi

## Screenshot

![react-pro-sidebar](https://user-images.githubusercontent.com/25878302/81577624-8f373880-93a1-11ea-9156-81ff986237cf.gif)
![react-pro-sidebar](https://user-images.githubusercontent.com/25878302/83899865-0c5f8e80-a751-11ea-9689-a7fad94843a1.gif)

## Installation

Expand Down Expand Up @@ -100,18 +100,30 @@ Your `custom.scss` file should look something like this
```scss
// Your variable overrides
$sidebar-bg-color: #1d1d1d;
$sidebar-color: #adadad;
$sidebar-width: 270px;
$sidebar-collapsed-width: 80px;
$highlight-color: #d8d8d8;
$submenu-bg-color: #2b2b2b;
$submenu-bg-color-collapsed: #2b2b2b;
$icon-bg-color: #2b2b2b;
$icon-size: 35px;

@import '../node_modules/react-pro-sidebar/dist/scss/styles.scss';
```

Available scss variables

```scss
$sidebar-bg-color: #1d1d1d !default;
$sidebar-color: #adadad !default;
$sidebar-width: 270px !default;
$sidebar-collapsed-width: 80px !default;
$highlight-color: #d8d8d8 !default;
$submenu-bg-color: #2b2b2b !default;
$submenu-bg-color-collapsed: #2b2b2b !default;
$icon-bg-color: #2b2b2b !default;
$icon-size: 35px !default;
$breakpoint-xs: 480px !default;
$breakpoint-sm: 576px !default;
$breakpoint-md: 768px !default;
$breakpoint-lg: 992px !default;
$breakpoint-xl: 1200px !default;
```


## Using nested sub-menus

You can have as many nested menu-items and sub-menus as you like, and the syntax is very simple
Expand Down Expand Up @@ -169,7 +181,7 @@ import { Link } from 'react-router-dom';
<tr>
<td>toggled</td>
<td>string</td>
<td>Toggle status of the sidebar when break point is activated</td>
<td>Toggle status of the sidebar when break point is enabled</td>
<td><code>false</code></td>
</tr>
<tr>
Expand Down

0 comments on commit d3650d4

Please sign in to comment.