{"id":16853765,"url":"https://github.com/faisalman/sticklr-js","last_synced_at":"2025-10-14T18:39:19.315Z","repository":{"id":66020665,"uuid":"94562672","full_name":"faisalman/sticklr-js","owner":"faisalman","description":"Sticklr.js - Sticky side panel jQuery plugin","archived":false,"fork":false,"pushed_at":"2017-06-16T18:12:46.000Z","size":281,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T23:04:01.072Z","etag":null,"topics":["jquery-plugin","navigation-menus","sticky-elements"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/faisalman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-16T16:35:43.000Z","updated_at":"2022-12-06T12:59:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"61ba12ba-0194-456b-bbed-73d70917471c","html_url":"https://github.com/faisalman/sticklr-js","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/faisalman%2Fsticklr-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faisalman%2Fsticklr-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faisalman%2Fsticklr-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/faisalman%2Fsticklr-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/faisalman","download_url":"https://codeload.github.com/faisalman/sticklr-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248312141,"owners_count":21082638,"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":["jquery-plugin","navigation-menus","sticky-elements"],"created_at":"2024-10-13T13:53:08.243Z","updated_at":"2025-10-14T18:39:14.295Z","avatar_url":"https://github.com/faisalman.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sticklr.js\n\nSticky side panel jQuery plugin\n\n## Usage\n\n```html\n\u003c!-- include the required CSS --\u003e\n\u003clink rel=\"stylesheet\" type=\"text/css\" href=\"jquery-sticklr-1.4-light-color.css\" /\u003e\n                \n\u003c!-- include any version of jQuery before including plugin --\u003e\n\u003cscript type=\"text/javascript\" src=\"jquery-1.7.1.min.js\"\u003e\u003c/script\u003e\n\n\u003c!-- include the plugin --\u003e\n\u003cscript type=\"text/javascript\" src=\"jquery-sticklr-1.4.min.js\"\u003e\u003c/script\u003e\n\n\u003cscript type=\"text/javascript\"\u003e\n    $(document).ready(function(){\n        $('#example').sticklr();\n    });\n\u003c/script\u003e\n\n\u003cul id=\"example\" class=\"sticklr\"\u003e\n    \u003cli\u003e\n        \u003ca href=\"#\" class=\"icon-something\" title=\"This is a floated icon\"\u003e\u003c/a\u003e\n        \u003cul\u003e\n            \u003cli class=\"sticklr-title\"\u003e\n                \u003ca href=\"#\"\u003eThis is a title\u003c/a\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n                \u003ca href=\"http://www.google.com\" class=\"icon-google\"\u003eThis is a link\u003c/a\u003e\n            \u003c/li\u003e\n            \u003cli\u003e\n                \u003ca href=\"http://www.facebook.com\" class=\"icon-facebook\"\u003eAnother link\u003c/a\u003e\n            \u003c/li\u003e\n        \u003c/ul\u003e\n    \u003c/li\u003e\n\u003c/ul\u003e\n```\n\n* General pattern: `ul \u003e li \u003e a[+ul \u003e li a/form/table]`\n* To ensure CSS3 fallback, the topmost `\u003cul\u003e` element must have `\"sticklr\"` class name\n* Create multiple column menu by adding another `\u003cul\u003e` element in second level\n* Add class `\"sticklr-title\"` in `\u003cli\u003e` to create menu title\n\nTo hide all shown menu when an event occured you can use:\n\n```js\n$().sticklr('hide');\n```\n\n## Options\n\n| option | type | default | description |\n| --- | --- | --- | --- |\n| `animate` | `Boolean` | `false` | Define whether the sticky panel has to be animated when scrolling/resizing browser |\n| `menuHeight` | `Number` | `20` | Define the height size of a column in pixel |\n| `menuWidth` | `Number` | `180` | Define the width size of a column in pixel |\n| `relativeTo` | `String` | `\"center\"` | Define vertical positioning relative to the browser viewport (`top`/`middle`/`ground`) |\n| `relativeGap` | `Number` | `15` | Define the relative gap size in pixel if `relativeTo` was set to top or bottom |\n| `showOn` | `String` | `\"click\"` | Define event when menu must be shown. Some possible mouse events: `hover`, `click`, `dblclick` |\n| `stickTo` | `String` | `\"left\"` | Define placement position whether to `left` or `right` side |\n| `tabHeight` | `Number` | `16` | Define the height size of the tab |\n| `tabWidth` | `Number` | `16` | Define the width size of the tab |\n\nTo override the default value, you can pass custom values you want to change when initialize:\n\n```js\n$('#example').sticklr({\n    animate     : true,\n    menuHeight  : 20,\n    menuWidth   : 200,\n    relativeTo  : 'top',\n    relativeGap : 10,\n    showOn      : 'hover',\n    stickTo     : 'right',\n    tabHeight   : 64,\n    tabWidth    : 32\n});\n```\n\n## Credits\n\n* Some icons used here are from icondock and pc.de\n\n## License\n\nDual licensed under GPLv2 \u0026 MIT\n\nCopyright © 2011-2012 Faisal Salman \u003c\u003cf@faisalman.com\u003e\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of \nthis software and associated documentation files (the \"Software\"), to deal in \nthe Software without restriction, including without limitation the rights to use, \ncopy, modify, merge, publish, distribute, sublicense, and/or sell copies of the \nSoftware, and to permit persons to whom the Software is furnished to do so, \nsubject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all \ncopies or substantial portions of the Software.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaisalman%2Fsticklr-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffaisalman%2Fsticklr-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffaisalman%2Fsticklr-js/lists"}