{"id":13565354,"url":"https://github.com/quoid/panels","last_synced_at":"2025-04-03T22:31:13.810Z","repository":{"id":111963312,"uuid":"43009920","full_name":"quoid/panels","owner":"quoid","description":"a jQuery library for off canvas elements.","archived":true,"fork":false,"pushed_at":"2015-11-23T22:22:07.000Z","size":91,"stargazers_count":11,"open_issues_count":4,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-01T17:04:43.207Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://quoid.github.io/panels/index.html","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quoid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-23T15:33:12.000Z","updated_at":"2024-07-21T00:23:09.000Z","dependencies_parsed_at":"2023-03-13T13:30:43.367Z","dependency_job_id":null,"html_url":"https://github.com/quoid/panels","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quoid%2Fpanels","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quoid%2Fpanels/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quoid%2Fpanels/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quoid%2Fpanels/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quoid","download_url":"https://codeload.github.com/quoid/panels/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247090103,"owners_count":20881919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:01:45.281Z","updated_at":"2025-04-03T22:31:10.636Z","avatar_url":"https://github.com/quoid.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Panels\nEasy off canvas elements\n\n[http://quoid.github.io/panels/index.html](http://quoid.github.io/panels/index.html)\n\n## Dependencies\n* [**jQuery**](https://github.com/jquery/jquery)\n\n## Notes\nPanels is made for modern browsers; support for older browsers will vary. Panels makes use of:\n* [CSS3 Transforms](http://caniuse.com/#feat=transforms3d)\n* [CSS Transitions](http://caniuse.com/#feat=css-transitions)\n* [Viewport Units](http://caniuse.com/#feat=viewport-units)\n\n## Usage\n\n**Include necessary files**\n```html\n\u003c!-- include jquery --\u003e\n\u003cscript src=\"/path/to/jquery.js\"\u003e\u003c/script\u003e\n\u003c!-- include panels --\u003e\n\u003cscript src=\"/panels.min.js\"\u003e\u003c/script\u003e\n```\nBoth the expanded src `scss` and minified compiled `css` files are included; link to one of them in your projects.\n```html\n\u003clink rel=\"stylesheet\" href=\"/path/to/panels.min.css\"\u003e\n```\n\n**Markup**\n\nBelow is a typical structure for using panels. \n```html\n\u003cbody\u003e\n\t\u003cdiv class=\"panel panel-left\"\u003e\n\t\t\u003cbutton class=\"panel-trigger\"\u003e\u003c/button\u003e\n\t\t\u003c!-- panel content goes here --\u003e\n\t\u003c/div\u003e\n\t\u003cdiv class=\"panel-wrapper\"\u003e\n\t\t\u003c!-- site content goes here --\u003e\n\t\t\u003cbutton class=\"panel-trigger\"\u003e\u003c/button\u003e\n\t\u003c/div\u003e\n\u003c/body\u003e\n```\nBoth the `.panel` element and the `.panel-wrapper` element should come directly after your `\u003cbody\u003e` opening tag. You must include an element with the `.panel` class and a **single** `.panel-\u003cdirection\u003e` class (`.panel-top` `.panel-right` `panel-bottom` `.panel-left`) element. The `.panel-wrapper` element will be what you wrap your site content around; it is mandatory for panels to function.\n\n**Methods**\n\nThere are two methods, and a few options.\n\n```js\n$.panels.show({\n\tposition: 'left', //accepted arguments are 'top', 'right', 'bottom', 'left'\n\ttimeOut: 1000 //integer, sets the timeout between showing/hiding panel; in ms\n\tforceClose: true, //boolean, exclusive to the `show` method; if true clicking on body element will not close panel - default: false\n});\n```\n\n```js\n$.panels.hide({\n\tposition: 'left', //accepted arguments are 'top', 'right', 'bottom', 'left'\n\ttimeOut: 1000 //integer, sets the timeout between showing/hiding panel; in ms - default: 350\n});\n```\n\n## Contributing\n\nFeel free to fork, share and use this project.\n\n### Bugs\n\nIf you happen to come across a bug, please [create an issue](https://github.com/quoid/panels/issues) and **include a publicly accessible reproduction of the bug**. Under most circumstances this is necessary.\n\n### Improvements\n\nI ***very*** much welcome improvements to the project. Feel free to fork and create a pull request with valuable improvements. If worthwhile, it will be merged.\n\n## License\n[GPL v2](http://choosealicense.com/licenses/gpl-2.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquoid%2Fpanels","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquoid%2Fpanels","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquoid%2Fpanels/lists"}