Skip to content

Commit

Permalink
v0.4 - Merge pull request #25 from JoryHogeveen/dev
Browse files Browse the repository at this point in the history
0.4
  • Loading branch information
JoryHogeveen authored Sep 6, 2017
2 parents 537f9d5 + c46f8f9 commit 2c03f10
Show file tree
Hide file tree
Showing 38 changed files with 5,482 additions and 2,603 deletions.
46 changes: 46 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
33 changes: 33 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contribute to Off-Canvas Sidebars

Community made patches, localizations, bug reports, and contributions are always welcome and are crucial to ensure that this plugin remains alive and strong.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.

## Getting Started

* Submit a ticket for your issue, assuming one does not already exist.
* https://github.com/JoryHogeveen/off-canvas-sidebars/issues
* Clearly describe the issue including steps to reproduce the bug.
* Make sure you fill in the earliest version that you know has the issue as well as the version of WordPress you're using.

## Making Changes

* Fork the repository on GitHub
* Make the changes to your forked repository's code
* Ensure you stick to the [WordPress Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards)
* This repository contains all files needed to properly configure your IDE with the correct coding standards and code style configuration.
* [PHP MD](https://github.com/JoryHogeveen/off-canvas-sidebars/blob/master/tests/phpmd.xml)
* [PHP CS](https://github.com/JoryHogeveen/off-canvas-sidebars/blob/master/tests/phpcs.xml)
* [ESLint](https://github.com/JoryHogeveen/off-canvas-sidebars/blob/master/tests/.eslintrc)
* [CSSLint](https://github.com/JoryHogeveen/off-canvas-sidebars/blob/master/tests/.csslintrc)
* Create a new branch, named with a issue prefix (if present) and some keywords on what is changed.
* Example: `#123-what-is-changed`.
* When committing, reference your issue (if present) and include a note about the fix.
* Push the changes to the branch you created and submit a pull request for the `dev` branch.

At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.

# Additional Resources
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Expected Behavior


## Actual Behavior


## Steps to Reproduce the Problem

1.
1.
1.

## Specifications

- Plugin Version:
- WordPress Version:
- Other plugins installed:
- Theme:
- Browser:
7 changes: 7 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Fixes #

## Proposed Changes

-
-
-
23 changes: 17 additions & 6 deletions README.md → .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Add off-canvas sidebars using the Slidebars jQuery plugin.
[![WordPress Plugin downloads](https://img.shields.io/wordpress/plugin/dt/off-canvas-sidebars.svg?style=flat)](https://wordpress.org/plugins/off-canvas-sidebars/)
[![WordPress Plugin rating](https://img.shields.io/wordpress/plugin/r/off-canvas-sidebars.svg?style=flat)](https://wordpress.org/plugins/off-canvas-sidebars/)
[![Travis](https://secure.travis-ci.org/JoryHogeveen/off-canvas-sidebars.png?branch=master)](http://travis-ci.org/JoryHogeveen/off-canvas-sidebars)
[![Code Climate](https://codeclimate.com/github/JoryHogeveen/off-canvas-sidebars/badges/gpa.svg)](https://codeclimate.com/github/JoryHogeveen/off-canvas-sidebars)
[![License](https://img.shields.io/badge/license-GPL--2.0%2B-green.svg)](https://github.com/JoryHogeveen/off-canvas-sidebars/blob/master/license.txt)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=YGPLMLU7XQ9E8&lc=NL&item_name=Off%2dCanvas%20Sidebars&item_number=JWPP%2dOCS&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)

Expand All @@ -15,7 +16,7 @@ This plugin will add various options to implement off-canvas sidebars in your Wo
### Overview / Features
* Add off-canvas sidebars to the left, right, top and bottom of your website
* Use sidebar areas (widget-ready areas), menu locations or [custom hooks](https://github.com/JoryHogeveen/off-canvas-sidebars/wiki/Actions-&-Filters) to place content into the off-canvas sidebars
* You can add control buttons with a widget, a menu item or with [custom code](https://wordpress.org/plugins/off-canvas-sidebars/installation/)
* You can add control buttons with a widget, menu item, [shortcode](https://github.com/JoryHogeveen/off-canvas-sidebars/wiki/Shortcodes) or with [custom code](https://github.com/JoryHogeveen/off-canvas-sidebars/wiki/Theme-setup)
* Various customisation options and settings available in the Appearances menu

### Compatibility (IMPORTANT!)
Expand All @@ -24,10 +25,16 @@ The structure of your theme is of great importance for this plugin. Please read
This plugin should work with most themes and plugins although I can't be sure for all use-cases. At this point it's still a 0.x version...
If the plugin does not work for your theme, please let me know through the support and add a plugins and themes list and I will take a look!

#### Fixed elements (like sticky menu's)
There are known issues with fixed elements and Slidebars. [Click here for more information](https://www.adchsm.com/slidebars/help/advanced-usage/elements-with-fixed-positions/)
I've created two possible solutions for this:

1. Legacy CSS solution. Use basic CSS2 positioning instead of CSS3 transform with hardware acceleration.
2. JavaScript solution. It is slower but still allows the use of hardware acceleration.

### It's not working! / I found a bug!
Please let me know through the support and add a plugins and themes list! :)
https://wordpress.org/support/plugin/off-canvas-sidebars
Or submit an issue here on GitHub
Please let me know through [support](https://wordpress.org/support/plugin/off-canvas-sidebars) and add a plugins and themes list! :)
Or [submit an issue here on GitHub](https://github.com/JoryHogeveen/off-canvas-sidebars/issues)

### Credits
* Slidebars jQuery plugin by [Adam](https://www.adchsm.com/slidebars/ "Adam"), thank you for this great plugin!
Expand All @@ -45,8 +52,12 @@ Or search for "Off-Canvas Sidebars" via your plugins menu.

### Theme setup

Off-Canvas Sidebars won't work "out of the box" with most themes, please read the Wiki!
[Click here!](https://github.com/JoryHogeveen/off-canvas-sidebars/wiki/Theme-setup)
Off-Canvas Sidebars won't work "out of the box" with most themes, please read the documentation!
[Click here for theme setup documentation.](https://github.com/JoryHogeveen/off-canvas-sidebars/wiki/Theme-setup)

### Actions | Filters | API

* [See Wiki on GitHub](https://github.com/JoryHogeveen/off-canvas-sidebars/wiki)

### Other Notes
You can find me here:
Expand Down
25 changes: 23 additions & 2 deletions css/off-canvas-sidebars-admin.css
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
/**
/*!
* Off-Canvas Sidebars plugin
*
* @author Jory Hogeveen <[email protected]>
* @package off-canvas-sidebars
* @version 0.3
* @version 0.4
* @preserve
*/

.ocs-credits {
Expand All @@ -17,6 +18,8 @@
.ocs-credits .inner { padding-left: 10px; padding-right: 10px; }
.ocs-credits h3 { font-size: 14px; line-height: 1.4; margin: 0; padding: 8px 12px; border-bottom: 1px solid #eee; }

.off-canvas-sidebars-settings .postbox-container { float: none; }

.postbox.section-sidebar {
-webkit-transition: all .1s;
-moz-transition: all .1s;
Expand All @@ -25,6 +28,16 @@
}
.postbox.section-sidebar:hover { opacity: 1 !important; }

.off-canvas-sidebars-settings .form-table tbody > tr:not(:last-child) { border-bottom: 1px solid #eee; }
.off-canvas-sidebars-settings .form-table:not(:last-child) { margin-bottom: 1em; border-bottom: 1px solid #eee; }

.off-canvas-sidebars-settings fieldset.radio label,
.off-canvas-sidebars-settings fieldset.checkbox label { display: block }
.off-canvas-sidebars-settings fieldset.radio label + br { display: none; }
.off-canvas-sidebars-settings fieldset.radio label + .description { margin-bottom: .5em; display: inline-block; }

.off-canvas-sidebars-settings input + select { vertical-align: top; }

@media only screen and (min-width: 850px) {
.off-canvas-sidebars-settings {
margin-right: 300px;
Expand All @@ -41,6 +54,14 @@
margin: 10px -300px 10px 20px;
width: 280px;
}

.off-canvas-sidebars-settings .postbox-container .postbox-third {
float: left;
width: 33%;
margin-left: 0.5%;
box-sizing: border-box;
}
.off-canvas-sidebars-settings .postbox-container .postbox-third.first { margin-left: 0; }
}

@media only screen and (min-width: 959px) {
Expand Down
9 changes: 9 additions & 0 deletions css/off-canvas-sidebars-admin.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 51 additions & 2 deletions css/off-canvas-sidebars.css
Original file line number Diff line number Diff line change
@@ -1,11 +1,60 @@
/**
/*!
* Off-Canvas Sidebars plugin
*
* @author Jory Hogeveen <[email protected]>
* @package off-canvas-sidebars
* @version 0.3
* @version 0.4
* @preserve
*/

/**
* Slidebar CSS overwrites
*/

/* @fixme Fix overlay issues with shift and reveal on pages not that don't have full height, currently done in JS window resize. */
html,
html.ocs-initialized {
overflow-y: auto;
height: auto;
}
[canvas=container],
.ocs-initialized [canvas=container] {
overflow-y: hidden;
height: auto;
}


/*[canvas-fixed] {
-webkit-transform: translate( 0px, 0px );
-moz-transform: translate( 0px, 0px );
-ms-transform: translate( 0px, 0px );
-o-transform: translate( 0px, 0px );
transform: translate( 0px, 0px );
-webkit-backface-visibility: hidden;
}*/

.ocs-legacy [canvas] {top: 0; right: 0; bottom: 0; left: 0;}
.ocs-legacy [canvas],
.ocs-legacy [off-canvas] {
-webkit-transform: none;
-moz-transform: none;
-ms-transform: none;
-o-transform: none;
transform: none;
-webkit-transition: -webkit-transform 300ms, top 300ms, bottom 300ms, left 300ms, right 300ms;
-moz-transition: -moz-transform 300ms, top 300ms, bottom 300ms, left 300ms, right 300ms;
-o-transition: -o-transform 300ms, top 300ms, bottom 300ms, left 300ms, right 300ms;
transition: transform 300ms, top 300ms, bottom 300ms, left 300ms, right 300ms;
}

/* @todo fix support for top and bottom */
[off-canvas*=" top"][off-canvas*=" reveal"],
[off-canvas*=" top"][off-canvas*=" shift"],
[off-canvas*=" bottom"][off-canvas*=" reveal"],
[off-canvas*=" bottom"][off-canvas*=" shift"] {
z-index: 1;
}

/**
* Sidebar Widths (patched from older version of Slidebars)
*/
Expand Down
9 changes: 9 additions & 0 deletions css/off-canvas-sidebars.min.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2c03f10

Please sign in to comment.