Skip to content

Updated README to include theming with Sass #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated README to include theming with Sass #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ slicknav.css can be modified to fit website design
'removeIds': false // Remove IDs from all menu elements. Defaults to true if duplicate is true.
'removeClasses': false // Remove classes from all menu elements.
'brand': '' // Add branding to menu bar.

### Callbacks
'init': function(){}, // Called after SlickNav creation
'beforeOpen': function(trigger){}, // Called before menu or sub-menu opened.
'beforeOpen': function(trigger){}, // Called before menu or sub-menu opened.
'beforeClose': function(trigger){} // Called before menu or sub-menu closed.
'afterOpen': function(trigger){} // Called after menu or sub-menu opened.
'afterClose': function(trigger){} // Called after menu or sub-menu closed.
Expand All @@ -65,26 +65,47 @@ slicknav.css can be modified to fit website design
$('.menu').slicknav('toggle'); // Method to toggle the menu
$('.menu').slicknav('open'); // Method to open the menu
$('.menu').slicknav('close'); // Method to close the menu

Without any additional configuration, both the original and mobile menus will be displayed. It is recommended to use media queries to hide the original menu and display the mobile menu when appropriate. Modernizr or similar can be used for graceful degradation.

For example:

.slicknav_menu {
display:none;
}

@media screen and (max-width: 40em) {
/* #menu is the original menu */
.js #menu {
display:none;
}

.js .slicknav_menu {
display:block;
}
}

###Modifying the Theme With Sass
scss/theme.scss can also be modified to fit your website's design. Import the
scss directory into your project and simply use the command line to have Sass watch for the changes made.

sass --watch scss/slicknav.scss:<directory where you placed SlickNav>/slicknav.css

Now change the colors in theme.scss and the changes will be reflected in slicknav.css.

For example:

//colors
$color_0: rgba(255, 255, 255, 0.75);
$color_btn: deepskyblue;
$color_text: white;
$color_bg: dodgerblue;
$color_shadow: darken($color_bg, 10%);
$color_hover_bg: $color_btn;
$color_hover_text: white;



More examples at [SlickNav.com](http://slicknav.com)

### Browser Support
Expand Down