diff --git a/.gitignore b/.gitignore index 45b829f..7084d00 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ node_modules/ -dist/*.map \ No newline at end of file +mix-manifest.json +package-lock.json \ No newline at end of file diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..9cf9495 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false \ No newline at end of file diff --git a/README.md b/README.md index a95697a..a282632 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A style guide (CSS and Sass) providing a convenient base for styling common sidebar/drawer elements like menus, brand, etc. -This package complements the [drawer](https://github.com/themekit/material-design-kit/tree/master/src/drawer) component from [material-design-kit](https://github.com/themekit/material-design-kit). +This package complements the [drawer](https://github.com/FrontendMatter/material-design-kit/tree/master/src/drawer) component from [material-design-kit](https://github.com/FrontendMatter/material-design-kit). ## Installation @@ -47,7 +47,7 @@ There are two base skin variants that you get out of the box for making a sideba -Note that none of the skin classes include a background color, so the following example assumes you are adding the background with the additional `.bg-primary` and `.bg-white` custom classes. +Note that none of the skin classes include a background color, so the following example assumes you are adding the background with additional custom classes (i.e `.bg-primary` and `.bg-white` from Bootstrap). ```html @@ -155,13 +155,18 @@ You can customize sidebar menus with the following Sass variables. $sm-spacing-x Defines the horizontal spacing for sidebar menus - $sidebar-spacing-x + 0 $sm-spacing-y Defines the vertical spacing for sidebar menus $sidebar-spacing-y + + $sm-inner-spacing-x + Defines the horizontal spacing between button elements such as icons and badges + 5px + @@ -191,6 +196,11 @@ You can customize sidebar menus with the following Sass variables. Defines the height in px for .sidebar-menu-button 42px + + $sm-button-spacing-x + Defines the horizontal spacing for sidebar menu buttons + $sidebar-spacing-x + $sm-active-button-font-weight Defines the font weight for .sidebar-menu-button when using li.sidebar-menu-item.active @@ -215,6 +225,10 @@ Add icons to sidebar menus. .sidebar-menu-icon The sidebar menu icon + + .sidebar-menu-icon--left or .sidebar-menu-icon--right + Add spacing between the menu icon and text + .material-icons Required on .sidebar-menu-icon elements when using Material icons @@ -240,7 +254,7 @@ To add an icon to the sidebar menu button, add an element using the `.sidebar-me